Pemversian

Partner API diversikan dalam URL. Versi semasa ialah:

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

Dasar perubahan

Performance Hub berusaha membuat perubahan tambahan yang serasi ke belakang di mana-mana yang boleh.

Contoh perubahan yang serasi ke belakang:

Menambah medan pilihan baharu pada permintaan.
Menambah medan baharu pada respons.
Menambah titik akhir baharu.
Menambah nilai enum baharu di mana klien dijangka mengendalikan nilai yang tidak diketahui.
Menambah baik mesej pengesahan tanpa mengubah kontrak kod status.

access_time_windows dan access_time_windows_revision ialah medan permintaan Ahli tambahan. Klien sedia ada yang meninggalkannya mengekalkan petikan Access Time Window yang disimpan tanpa perubahan. Peraturan peninggalan ini mengekalkan keserasian upsert separa; peninggalan tidak sama dengan menghantar tatasusunan kosong.

Contoh perubahan yang memecahkan keserasian:

Membuang atau menamakan semula medan.
Mengubah jenis medan.
Menjadikan medan permintaan pilihan sebagai wajib.
Membuang titik akhir.
Mengubah maksud kod status sedia ada atau reason khusus domain.

Penamatan

Apabila perubahan yang memecahkan keserasian diperlukan, Performance Hub akan mengelak daripada mengubah versi sedia ada secara langsung di mana-mana yang boleh. Sebaliknya, kami akan memperkenalkan versi atau laluan migrasi baharu dan memaklumkan perubahan itu kepada rakan kongsi yang terjejas.

Notis penamatan boleh termasuk:

Entri log perubahan.
Komunikasi terus dengan rakan kongsi.
Nota dalam Partner Console.
Panduan migrasi dalam dokumentasi.

Cadangan untuk klien

Bina klien yang dapat menerima perubahan tambahan:

Abaikan medan respons yang tidak anda gunakan.
Anggap nilai enum yang tidak diketahui sebagai tidak disokong dan bukannya menyebabkan ranap.
Elakkan semakan kesamaan respons yang ketat.
Log nilai yang tidak dikenali supaya anda boleh mengemas kini integrasi anda dengan sengaja.

Untuk partisi Ahli bersemakan seperti Access Time Windows, simpan semakan dan muatan dinormalkan yang dihantar sehingga hasilnya diketahui. Menggunakan semula semakan untuk kandungan yang berubah ialah konflik, manakala memainkan semula kandungan yang sama adalah idempoten. Lihat Access Time Windows.

Spesifikasi OpenAPI

Gunakan spesifikasi OpenAPI yang diterbitkan untuk menjana klien, mengesahkan permintaan dan menjejak perubahan bentuk API dari semasa ke semasa.

Lihat Spesifikasi OpenAPI.