Pembuatan Versi

Versi Partner API ditentukan di URL. Versi saat ini adalah:

https://partner-api.performancehub.co/partner/v1/

Kebijakan perubahan

Performance Hub berupaya membuat perubahan yang bersifat tambahan dan kompatibel ke belakang bila memungkinkan.

Contoh perubahan yang kompatibel ke belakang:

• Menambahkan bidang opsional baru ke permintaan.
• Menambahkan bidang baru ke respons.
• Menambahkan endpoint baru.
• Menambahkan nilai enum baru jika klien diharapkan dapat menangani nilai yang tidak dikenal.
• Memperbaiki pesan validasi tanpa mengubah kontrak kode status.

access_time_windows dan access_time_windows_revision adalah bidang permintaan Member yang bersifat tambahan. Klien yang ada dan tidak menyertakannya akan mempertahankan snapshot Access Time Window yang tersimpan tanpa perubahan. Aturan penghilangan ini menjaga kompatibilitas upsert parsial; menghilangkan bidang tidak sama dengan mengirimkan array kosong.

Contoh perubahan yang merusak kompatibilitas:

• Menghapus atau mengganti nama bidang.
• Mengubah tipe bidang.
• Menjadikan bidang permintaan opsional sebagai wajib.
• Menghapus endpoint.
• Mengubah makna kode status yang ada atau reason khusus domain.

Penghentian

Jika perubahan yang merusak kompatibilitas diperlukan, Performance Hub sebisa mungkin akan menghindari mengubah versi yang ada secara langsung. Sebagai gantinya, kami akan memperkenalkan versi atau jalur migrasi baru dan mengomunikasikan perubahan tersebut kepada mitra yang terdampak.

Pemberitahuan penghentian dapat mencakup:

• Entri log perubahan.
• Komunikasi langsung dengan mitra.
• Catatan di Partner Console.
• Panduan migrasi di dokumentasi.

Rekomendasi untuk klien

Bangun klien yang toleran terhadap perubahan tambahan:

• Abaikan bidang respons yang tidak Anda gunakan.
• Perlakukan nilai enum yang tidak dikenal sebagai tidak didukung, alih-alih membuat aplikasi mogok.
• Hindari pemeriksaan kesamaan respons yang ketat.
• Catat nilai yang tidak dikenali agar Anda dapat memperbarui integrasi secara terencana.

Untuk partisi Member berrevisi seperti Access Time Windows, simpan revisi yang dikirimkan dan payload ternormalisasi hingga hasilnya diketahui. Menggunakan kembali revisi untuk konten yang berubah merupakan konflik, sedangkan memutar ulang konten yang sama bersifat idempoten. Lihat Access Time Windows.

Spesifikasi OpenAPI

Gunakan spesifikasi OpenAPI yang dipublikasikan untuk membuat klien, memvalidasi permintaan, dan melacak perubahan bentuk API dari waktu ke waktu.

Lihat Spesifikasi OpenAPI.