Rujukan API untuk pembangun

Sambungkan aplikasi anda sendiri ke ruang kerja anda: REST API, kunci dan skopnya, ralat, had kadar dan webhook.

Tempat mencarinya

⚙️ Tetapan › Rujukan API · Halaman utama › Sumber › Rujukan API

Buka skrin ini
Rujukan API dengan menu sisi, pengesahan dan titik akhirnya.

Langkah

  1. Buka “Rujukan API” dalam bar sisi, atau “Rujukan API” dalam menu “Sumber” halaman utama.
  2. Mulakan dengan “Mula di sini”: “URL asas & konvensyen”, “Pengesahan” dan “Skop”.
  3. Cari “Titik akhir” mengikut kumpulan; setiap satu menunjukkan parameter, badan permintaan, respons dan ralatnya dengan contoh.
  4. Baca “Ralat & kod status”, “Had kadar” dan “Webhook (keluar)” sebelum dilancarkan. “OpenAPI JSON” memuat turun keseluruhan spesifikasi.

Penyelesaian masalah

Bagaimana saya mendapatkan kunci API?

Kunci dikeluarkan untuk ruang kerja anda atas permintaan; ia belum boleh dicipta dalam aplikasi. Kunci ruang kerja anda disenaraikan pada halaman pembangun kawasan AI, tempat orang yang mengurus ruang kerja juga boleh menambah dan menguji titik akhir webhook.

Petua

  • Panggil API dari pelayan anda sahaja. Jangan sekali-kali letakkan kunci dalam halaman web atau aplikasi mudah alih.

Perlu diketahui

  • Rujukan API boleh dibaca tanpa log masuk.

Panduan berkaitan

Mula secara percuma Laman Utama