冪等性

取得 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:請稍後重試。