Lewati ke konten utama

Lifecycle, error, versioning, dan go-live

Public help bersifat current-state. Versioning dipakai hanya jika ada API versions yang benar-benar concurrently supported. Periksa changelog dan reference sebelum mengunci integrasi.

Tangani 4xx, 5xx, timeout, rate limit, auth failure, conflict, dan provider-unavailable sebagai state terpisah. Jangan retry mutation tanpa idempotency dan jangan menyimpulkan success dari HTTP request yang timeout.

Go-live checklist​

Contract parity, credential storage, signature verification, idempotency, timeout, observability, privacy redaction, support owner, canary scope, dan rollback harus siap sebelum traffic nyata.

Perhatian

Deprecation date, SLA, quota, dan compatibility window harus berasal dari owner contract; jangan mengarang nilai dari contoh.

Versioning dan deprecation​

Gunakan versi kontrak yang dinyatakan pada URL, header, atau dokumentasi. Perubahan kompatibel dapat menambah field; client harus mengabaikan field yang tidak dikenal. Perubahan breaking memerlukan jalur migrasi dan periode deprecation yang diumumkan.

Error handling​

Kelompokkan error validasi, autentikasi, authorization, not found, conflict, rate limit, dan server error. Tampilkan pesan aman kepada pengguna dan simpan request ID untuk dukungan. Jangan menampilkan response internal atau stack trace.

Go-live checklist​

  • Scope dan owner integrasi disetujui.
  • Credential production disimpan serta dapat dirotasi.
  • Monitoring error/latency aktif.
  • Retry dan idempotency diuji.
  • Webhook negative cases lulus.
  • Data retention dan redaction ditinjau.
  • Rollback versi tersedia.

Terakhir diverifikasi: 2026-07-24