Kunci API dan API

Kunci API adalah kata sandi yang dimiliki oleh program, bukan orang. Perlakukan dengan cara yang sama: keluarkan satu per sistem, dan gantikan saat sistem tersebut berubah.

Buat kunci

1. Buka API → Manajemen API dan tekan Kunci baru.
2. Berikan nama yang menunjukkan sistem mana yang menggunakannya.
3. Pilih Izin: Akses penuh, atau hanya area yang dibutuhkan sistem. Sebagian besar area membedakan membaca, membuat, dan mengubah.
4. Pilih tanggal kedaluwarsa, atau tidak ada.
5. Gunakan Tampilkan dan Salin pada kartu kunci untuk menyerahkan kunci kepada sistem pemanggil. Sistem mengirimkannya dalam authtoken header.

Setiap kartu kunci menunjukkan izin, tanggal pembuatan, Terakhir digunakan dan lencana seperti “aktif” atau “berakhir dalam 5 hari”.

Perbarui kunci sebelum kedaluwarsa

Empat belas hari sebelum kunci kedaluwarsa, Anda mendapatkan satu notifikasi di lonceng. Tekan Perbarui pada kartu kunci dan pilih tanggal kedaluwarsa baru. IDup membuat kunci baru dengan izin yang sama. Salin segera, karena tampilan ini hanya muncul sekali. Kunci lama tetap berlaku hingga kedaluwarsa sendiri, sehingga Anda dapat mengalihkan sistem tanpa jeda.

Area-area yang dapat Anda jangkau

API mencakup data pelanggan Anda dan, tergantung pada rencana Anda, properti dan penyewaan, profil pencarian, file pajak, file wali amanat, akuntansi, penggajian, dan pemindaian tanda terima. AI Studio dan kotak masuk memiliki area mereka sendiri. Panduan API hanya mencantumkan area yang termasuk dalam rencana Anda.

Panduan API

Buka Dokumentasi tab pada halaman manajemen API, atau API → Panduan API. Setiap area menunjukkan bidangnya, contoh permintaan yang dapat Anda salin, contoh jawaban, dan kode kesalahan.

Webhook dan antarmuka lainnya

• The Webhook tab mengirimkan peristiwa ke sistem Anda saat terjadi — lihat Kirim acara ke sistem Anda sendiri dengan webhooks.
• Jika Customer API diaktifkan, sebuah Pengaturan API Pelanggan tab membuka pengaturannya, misalnya apakah pelanggan dapat mendaftar melalui API.
• Otomatisasi / alur kerja → Antarmuka teknis mengeluarkan token untuk antarmuka GraphQL.
• AI Studio → Kunci API Pribadi adalah satu set kunci yang terpisah.

Menjaganya tetap aman

1. Satu kunci per sistem, tidak pernah berbagi.
2. Berikan kunci hanya izin yang dibutuhkan sistem.
3. Tetapkan tanggal kedaluwarsa dan perbarui sesuai jadwal.
4. Hapus kunci segera setelah seseorang yang mengetahuinya pergi, atau sistem dimatikan.