Akses dan Pengesahan API

SPREEAI menyediakan rujukan API awam untuk aliran kerja rakan kongsi yang diluluskan: https://docs.spreeai.com/swagger/public/.

Model akses

Skop API, persekitaran, bukti kelayakan dan operasi yang dibenarkan dipersetujui semasa penyertaan rakan kongsi. Jangan menganggap bahawa titik akhir dalaman, pembangunan atau sejarah tersedia dalam pengeluaran.

Peraturan kelayakan

• Simpan rahsia klien dan token akses hanya di stor rahsia bahagian pelayan yang selamat.
• Jangan sekali-kali memberikan bukti kelayakan kepada Git, dokumentasi, penjejak isu, tangkapan skrin atau aplikasi sampel.
• Jangan sekali-kali menghantar bukti kelayakan ke platform analitik atau pengelogan.
• Gunakan kelayakan khusus persekitaran hanya dengan persekitaran yang mana kelayakan tersebut dikeluarkan.
• Putar bukti kelayakan serta-merta jika ia terdedah.
• Mengeluarkan pengepala dan token kebenaran daripada permintaan sokongan.

Pelayar berbanding pelayan

SDK Web menggunakan konfigurasi pelayar yang dikeluarkan oleh rakan kongsi. Rahsia klien tidak boleh disertakan dalam pelayar.

Integrasi bahagian pelayan harus mengikuti aliran pengesahan dan definisi titik akhir dalam rujukan API yang diluluskan semasa. Apabila operasi yang diperlukan tidak wujud, minta melalui Kejuruteraan Rakan Kongsi dan bukannya membina laluan tanpa dokumen.

Webhook

Webhook pelayan-push bukan sebahagian daripada dokumentasi SDK Web yang diterbitkan pada masa ini. Sahkan sebarang keperluan webhook sebelum mereka bentuk kebergantungan padanya.

Senarai semak persekitaran

• [ ] Nama persekitaran telah didokumenkan.
• [ ] URL asas datang daripada rujukan yang diluluskan atau penyerahan onboarding.
• [ ] Kelayakan telah dikeluarkan untuk persekitaran tersebut.
• [ ] Rahsia disimpan di bahagian pelayan.
• [ ] Log menyunting token dan imejan pelanggan.
• [ ] Tamat masa, percubaan semula dan tingkah laku idempotensi telah dipersetujui untuk operasi tulis.
• [ ] Ujian bukan pengeluaran berjaya sebelum akses pengeluaran digunakan.