冪等
冪等(Idempotency)の概要
Amazon Payは、POSTリクエストに冪等を適用するため、リクエストを安全に再試行できます。これは、APIリクエストが転送中に中断された場合に役立ちます。
Amazon Payは、冪等キー(IdempotencyKey)を使用して行われた最初のリクエストに対するレスポンスを保存します。同じキーを使用する後続のリクエストに対しては、保存された結果を返します。後続のリクエストで冪等キーを変更すると、保存された結果が返るのではなく、DuplicateIdempotencyKeyエラーがレスポンスで返ってきます。
Note: 冪等キーは各Amazon Pay事業者アカウントに固有のものであり、無期限に保存されます。これは、同じキーを異なる事業者アカウントに使用できることを意味します。
冪等ヘッダー(Idempotency header)
冪等リクエストを行うには、 x-amz-pay-idempotency-key をリクエストヘッダーに設定します。キーは、同じリクエストの後続の再試行を認識するために使用される一意の値です。衝突を避けるために、V4UUIDを使用することをお勧めします。
冪等キーは、次の文字オプションのみが利用可能で、最大32文字にすることができます。:
- Lower case letters: a-z
- Upper case letters: A-Z
- Number: 0-9
- Dash (-)
- Underscore (_)
例:
-H "x-amz-pay-idempotency-key: AVLo5tI10BHgEk2jEXAMPLEKEY"
Note: GET、PATCH、およびDELETEリクエストは定義上冪等であり、これらのリクエストには冪等キーの効果がないため、 x-amz-pay-idempotency-key ヘッダーを設定することはお勧めしません。