冪等性

API キーを取得

ネットワークエラーが起きると、投稿が作成されたかどうか分からなくなることがあります。POST /v1/posts と POST /v1/media に Idempotency-Key ヘッダーを付けて送信し、同じキーで再試行してください。Sofia は初回と同じ応答を返し、重複して作成することはありません。

bash
curl -X POST https://api.sofia-post.com/api/v1/posts \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -d @post.json
  • 新しい投稿ごとに新しいランダムなキー(UUID)を使い、その投稿の再試行では同じキーを使ってください。
  • 同じキーで異なるボディを送ると、422 idempotency_key_reused で応答されます。
  • 最初のリクエストが実行中の間に同じキーを送ると、409 idempotency_in_progress で応答されます。少し待って再試行してください。