Autentikasi dan kunci API
Buat kunci
Section titled “Buat kunci”Buat kunci API sk_ di Pusat API . Kunci lengkap hanya ditampilkan satu kali, saat kunci tersebut dibuat atau diganti.
Gunakan kunci terpisah untuk setiap aplikasi, lingkungan, dan tugas otomatis, sehingga masing-masing dapat memiliki anggaran sendiri serta dapat dinonaktifkan, diganti, dan diaudit secara mandiri.
Kirim kredensial
Section titled “Kirim kredensial”Direkomendasikan:
X-API-Key: sk_your_keyBentuk standar Bearer juga berfungsi:
Authorization: Bearer sk_your_keyKirim hanya salah satu dari keduanya dalam sebuah permintaan.
curl https://omnidoc.top/api/v1/jobs \ -H "X-API-Key: $OMNIDOC_API_KEY"Apa yang diwakili oleh sebuah kunci
Section titled “Apa yang diwakili oleh sebuah kunci”Kunci berfungsi untuk akun yang membuatnya: kunci tersebut hanya dapat memanggil layanan yang dapat digunakan oleh akun itu dan mengakses sumber daya milik akun tersebut saja. Kunci tidak dapat mengubah email masuk, kata sandi, nomor telepon, atau profil, serta tidak dapat membuat, memutar, atau mencabut kunci API.
Batasan opsional:
allowed_engines: hanya pengaturan terjemahan yang terdaftar; array kosong tidak menambahkan batasan tingkat kunci.expires_at: waktu kedaluwarsa.quota_limit: anggaran masa pakai kunci dalam satuan milikredit;0tidak menetapkan anggaran tingkat kunci, dan kredit akun diselesaikan seperti biasa.
Putar dan cabut
Section titled “Putar dan cabut”Buat kunci, ubah batasnya, rotasi, atau cabut di pusat API . Setelah kunci dicabut, dinonaktifkan, atau kedaluwarsa, atau akunnya dinonaktifkan, permintaan baru akan langsung gagal.
Rotasi menghasilkan kunci rahasia baru dan sekaligus menonaktifkan kunci lama; kunci baru tetap mempertahankan batasan asli serta anggaran yang telah digunakan. Kunci yang kedaluwarsa tidak dapat dirotasi; buatlah kunci baru. Agar peralihan berjalan lancar, buatlah kunci baru dan terapkan, pastikan panggilan berhasil, lalu cabut kunci lama.
Keamanan
Section titled “Keamanan”- Simpan kunci hanya di server atau dalam runtime yang terkendali.
- Gunakan variabel lingkungan atau pengelola rahasia; jangan pernah menyimpan kunci di kode sumber, log, paket browser, atau repositori publik.
- Jangan pernah mengirim kunci ke alamat unggah atau unduh yang dikembalikan oleh API.
- Catat ID kunci, ID permintaan, dan ID operasi; jangan pernah mencatat kunci secara lengkap.
- Jika sebuah kunci bocor, segera lakukan rotasi dan tinjau pekerjaan serta tanggungannya.