Pengembang
Autentikasi
API Qwetty menggunakan Bearer API key untuk autentikasi. Setiap permintaan ke API harus menyertakan API key yang valid di header Authorization.
Header Authorization
Sertakan API key Anda sebagai Bearer token:
Code
Contoh Permintaan
Code
Properti API Key
| Properti | Deskripsi |
|---|---|
| Organization-scoped | Setiap API key terikat pada organisasi. Seluruh akses data dibatasi pada organisasi tersebut. |
| Expiration | Key dapat memiliki tanggal kedaluwarsa opsional. Key yang telah kedaluwarsa secara otomatis ditolak. |
| Activation | Key dapat diaktifkan atau dinonaktifkan. Key yang dinonaktifkan akan ditolak meskipun belum kedaluwarsa. |
| Permissions | Key dapat dikonfigurasi dengan izin terperinci (misalnya, baca chat, kirim pesan). |
| Channel scopes | Key dapat dibatasi pada channel tertentu. |
| IP whitelist | Key dapat dibatasi pada alamat IP tertentu. |
| Usage tracking | Jumlah permintaan dan stempel waktu terakhir digunakan dilacak secara otomatis. |
Respons Error
Ketika autentikasi gagal, API mengembalikan respons 401 Unauthorized:
Header hilang atau salah format
Code
Ini terjadi ketika:
- Header
Authorizationtidak ada - Header tidak dimulai dengan
Bearer
Key tidak valid atau kedaluwarsa
Code
Ini terjadi ketika:
- API key tidak ada
- API key telah dinonaktifkan
- API key telah kedaluwarsa
Praktik Terbaik
- Rahasiakan key — Jangan pernah mengekspos API key di kode sisi klien, repositori publik, atau log
- Gunakan variabel lingkungan — Simpan API key di variabel lingkungan, bukan di kode sumber
- Rotasi secara berkala — Buat key baru dan nonaktifkan key lama secara periodik
- Tetapkan tanggal kedaluwarsa — Gunakan tanggal kedaluwarsa untuk membatasi jendela paparan jika key disusupi
- Satu key per integrasi — Gunakan API key terpisah untuk integrasi yang berbeda untuk mengisolasi akses
- Gunakan IP whitelist — Batasi key pada IP server yang diketahui untuk keamanan tambahan
- Tetapkan izin minimal — Berikan hanya izin yang benar-benar dibutuhkan setiap integrasi
Langkah selanjutnya
- API Keys — Mempelajari cara membuat dan mengelola API key
- Kirim Pesan Pertama — Tutorial API secara menyeluruh
- Referensi API — Menjelajahi seluruh endpoint yang tersedia
Last modified on