Rujukan API

Rujukan ini hanya menerangkan titik akhir JSON yang sebenar dan boleh digunakan secara awam -- kaedah, laluan, jenis pengesahan, parameter wajib, contoh request dan response serta kod ralat yang didokumenkan bagi setiap titik akhir. Zentor tidak mempunyai sistem kunci API umum untuk pembangun; bergantung pada laluan, akses berlaku sama ada tanpa pengesahan atau melalui token benam widget dengan semakan origin. Laluan papan pemuka dalaman dan titik akhir Master Admin sengaja tidak dimasukkan dalam rujukan awam ini kerana ia hanya boleh dicapai melalui sesi log masuk biasa.

Setiap entri titik akhir mempunyai catatan ujian langsung yang menyatakan sama ada maklumat itu berasal daripada skema registry, ujian automatik atau pemerhatian langsung yang sebenar -- persamaan semata-mata dengan laluan kod yang berfungsi tidak dianggap sebagai bukti lengkap. Panggilan yang berjaya dari segi teknikal juga hanya mengesahkan pemprosesan request itu sendiri, bukan secara automatik proses susulan seperti penghantaran e-mel, penyelesaian pembayaran atau log masuk SSO yang telah selesai.

Perlindungan bergantung pada kumpulan masing-masing. Titik akhir awam untuk undang-undang, pemasaran dan borang tidak memerlukan sesi papan pemuka. Sebaliknya, widget sembang menggunakan pengepala `X-Widget-Token` dan senarai origin yang dibenarkan (allowlist). Log masuk papan pemuka memberikan JWT sesi dengan tempoh sah dua belas jam dan token refresh yang sah selama tujuh hari. Titik akhir SSO menggunakan kod sekali guna dan aliran callback tersendiri.

Baca setiap halaman titik akhir sebagai kontrak yang berasingan. Yang menentukan ialah kaedah HTTP, laluan, parameter wajib, jenis data, badan request, struktur response, kod ralat dan idempotensi. Contoh menunjukkan satu format yang mungkin, tetapi tidak menggantikan semakan terhadap respons sebenar. Status konfigurasi, pengesahsahihan, kebenaran dan penyedia luaran boleh mengubah hasilnya.

Had kadar seluruh platform yang disahkan ialah 2,000 request dalam tempoh 15 minit. Had berasingan bagi setiap titik akhir tidak didokumenkan secara konsisten. Oleh itu, klien tidak seharusnya menggunakan gelung polling yang terlalu rapat tanpa keperluan. Bagi operasi yang tidak idempoten, percubaan semula automatik boleh menghasilkan rekod atau mesej berganda.

Nilai sensitif tidak boleh dimasukkan ke dalam log. Ini termasuk kata laluan, token tetapan semula, kod pengesahan, token widget, ID sesi dan data contoh peribadi yang sebenar. Gunakan nilai yang dianonimkan dalam dokumentasi dan ujian. Catatan ujian langsung mesti mencerminkan bukti sebenar dengan tepat.