Idempotenz

API-Schlüssel erhalten

Ein Netzwerkfehler kann Sie im Unklaren lassen, ob ein Beitrag erstellt wurde. Senden Sie einen Header Idempotency-Key mit POST /v1/posts und POST /v1/media und wiederholen Sie mit demselben Schlüssel: Sofia antwortet, was sie beim ersten Mal geantwortet hat, und legt nichts doppelt an.

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
  • Verwenden Sie für jeden neuen Beitrag einen neuen Zufallsschlüssel (eine UUID) und für jede Wiederholung dieses Beitrags denselben Schlüssel.
  • Derselbe Schlüssel mit einem anderen Body antwortet mit 422 idempotency_key_reused.
  • Solange die erste Anfrage noch läuft, antwortet derselbe Schlüssel mit 409 idempotency_in_progress: Versuchen Sie es einen Moment später erneut.