Перейти к основному содержанию
Сетевые сбои случаются. Если запрос завершился по тайм-ауту, вы не можете знать, создал ли PapelShip заказ. Заголовок Idempotency-Key позволяет безопасно повторить вызов Store API.

Как это работает

Добавьте заголовок Idempotency-Key (до 255 символов) к запросу на создание или действие. PapelShip хранит первый ответ 24 часа. Повторный запрос с тем же ключом и тем же телом получает сохраненный ответ, а не выполняется заново.

Эндпоинты, которые его принимают

Ключ работает на эндпоинтах Store API для создания и действий, в том числе:
  • POST /invoices (создать заказ)
  • POST /invoices/{invoiceId}/papelpay (начать оплату картой)
  • POST /invoices/{invoiceId}/complete и POST /invoices/{invoiceId}/refund
  • POST /orders/{invoiceId}/shipments
  • POST /products и POST /coupons

Рекомендации

  • Генерируйте один ключ на заказ, а не на запрос. Хорошо подходит ID вашего собственного заказа.
  • Храните ключ вместе с заказом, чтобы каждый повтор использовал его снова.
  • Никогда не используйте один ключ для другого заказа или другой суммы.