ConverterHQDevelopers
API v1

Environment dan versioning

Promosikan dengan aman dari sandbox ke produksi dan pahami kontrak kompatibilitas v1.

Test dan live terisolasi. Integrasikan di sandbox, uji failure path dan webhooks, lalu promosikan konfigurasi dan secret secara sengaja.

Sandbox dan produksi

Konfigurasikan base URL dan key secara eksplisit per environment. Credential test tidak boleh melihat resource live dan sebaliknya.

Kontrak API v1

OpenAPI publik dan schema terdokumentasi adalah kontrak. CI memblokir perubahan incompatible yang memerlukan deprecation atau major version baru.

Penambahan kompatibel

Field optional, endpoint, dan capability baru dapat muncul. Client harus mengabaikan field yang tidak dikenal dan menghindari exhaustive switch yang rapuh. Aturan yang sama berlaku untuk opsi konversi per pasangan: ConverterHQ dapat menambahkan opsi baru yang bersifat opsional, tetapi opsi v1 yang sudah ada tidak akan dihapus, dijadikan wajib, diubah tipe atau semantik default-nya, dikurangi nilai enum-nya, atau dipersempit rentang nilai yang diterima.

Deprecation

Deprecation diumumkan di changelog bersama alternatif dan jendela migrasi. Jangan bergantung pada behavior tak terdokumentasi atau endpoint internal.