Autentikasi
Setiap permintaan ke API membawa kunci API. Permintaan tidak pernah dicocokkan dengan sesi browser.
Membuat kunci API
Buat kunci di Kunci API pada akun Anda, hingga 5 kunci. Anda dapat menyalin kunci dari halaman itu kapan saja selama Anda masuk: kami menyimpannya dalam bentuk terenkripsi, dan hanya menampilkannya kepada Anda. Jaga kerahasiaannya seperti kata sandi, dan jika kunci mungkin telah terlihat, cabut lalu buat kunci baru.
Mengirim kunci API
Kirim di header Authorization sebagai Bearer diikuti kuncinya. X-API-Key juga bisa dipakai.
curl "https://api.talismanleads.io/v1/account" \
-H "Authorization: Bearer tl_live_your_key_here"Yang dapat dilakukan kunci API
Kunci API baru dapat melakukan semuanya: melihat saldo Anda, pemeriksa, pesanan Anda, dan hasilnya, serta memakai POST /uploads, POST /estimates, dan POST /orders, yang menyimpan daftar Anda atau memakai saldo Anda. Kunci yang dibuat sebelum 8 November 2026 mungkin hanya-baca: kunci itu dapat melihat semuanya, tetapi ketiga panggilan tersebut menolaknya dengan missing_scope.
Masa berlaku dan alamat IP
Kunci API baru tidak pernah kedaluwarsa dan berfungsi dari alamat mana pun. Kunci yang dibuat sebelum 8 November 2026 mungkin memiliki tanggal kedaluwarsa, yang setelahnya kunci ditolak dengan expired_key, atau dibatasi ke alamat IP server Anda, sehingga permintaan dari tempat lain ditolak dengan ip_not_allowed. Untuk mengubah salah satunya, buat kunci baru dan cabut kunci lama.
Menjaga kunci API tetap aman
- Perlakukan kunci API seperti kata sandi: siapa pun yang memegangnya dapat memakai saldo Anda.
- Pakai hanya di server Anda. API tidak mengizinkan panggilan dari halaman web.
- Jauhkan dari kode dan sistem kontrol versi Anda.
- Jika kunci API mungkin telah terlihat, segera cabut di akun Anda. Kunci langsung berhenti berfungsi. Pesanan yang sudah dibuat tetap berjalan.
- Kirim hanya ke API. Tautan unggah dan unduh membawa izinnya sendiri, jadi jangan kirim kunci API Anda ke tautan itu.
Saat kunci API ditolak
Kunci API yang salah, dicabut, atau melewati tanggal berlakunya mendapat respons 401. Kunci API atau akun yang diblokir mendapat respons 403. Lihat Error.