Langsung ke konten utama
Setiap aplikasi dimulai dengan rahasia utama yang memiliki akses penuh ke semua yang dapat dilakukan aplikasi. Anda dapat menambahkan kunci API bernama di samping rahasia utama, satu untuk setiap layanan atau mitra, masing-masing hanya dengan akses yang dibutuhkan. Berikan kepada penyedia pencairan dana Anda kunci yang hanya dapat membaca sesi yang disetujui dari satu alur kerja dan tidak dapat mengubah apa pun, simpan kunci terpisah untuk backend Anda, dan cabut salah satunya tanpa memengaruhi yang lain.
Kunci yang dibuat sebelum akses terbatas tersedia tetap memiliki akses penuh. Tidak ada perubahan untuk kunci tersebut sampai Anda mengedit aksesnya.

Tempat menemukannya

Di Konsol Bisnis, pilih aplikasi Anda dan buka Developers -> API keys. Daftar ini menampilkan setiap kunci aplikasi beserta statusnya, jumlah permintaannya selama 30 hari terakhir, siapa yang membuatnya, aksesnya, dan kapan terakhir digunakan. Klik kunci untuk melihat pratinjaunya di sebelah kanan, atau buka halaman lengkapnya untuk penggunaan, akses, permintaan terbaru, cuplikan panduan cepat, dan aktivitasnya. Kunci dimiliki oleh satu aplikasi dan hanya berfungsi untuk aplikasi tersebut. Kunci mengikuti lingkungan aplikasinya: kunci dari aplikasi sandbox tidak pernah membuat verifikasi yang ditagih.

URL pengalihan dan domain yang diizinkan

Buka Developers > API keys > Redirects and domains untuk mengatur dua daftar bagi aplikasi dan lingkungan yang Anda pilih. Jika daftar Domain yang diizinkan berisi entri, Buat sesi menolak callback yang tidak termasuk salah satunya dengan galat 400. Daftar kosong berarti tidak ada pembatasan. Panggilan server-ke-server tidak terpengaruh.

Membuat kunci

1

Detail

Beri nama kunci sesuai layanan yang akan menggunakannya, lalu pilih kapan kunci itu kedaluwarsa: tidak pernah, dalam 30 hari, 90 hari, satu tahun, atau pada tanggal yang Anda pilih. Kunci yang sudah kedaluwarsa berhenti berfungsi pada akhir hari tersebut, UTC.
2

Akses

Mulai dari preset, lalu sesuaikan per resource. Kunci tidak akan pernah bisa melakukan lebih dari ini.
3

Tinjauan

Konsol menjelaskan secara rinci apa yang bisa dan tidak bisa dilakukan kunci tersebut, sebelum Anda membagikannya.
4

Kunci rahasia

Salin rahasia dan simpan di pengelola rahasia Anda. Ini adalah satu-satunya saat rahasia lengkap ditampilkan. Jika Anda kehilangannya, lakukan rotasi kunci untuk mendapatkan yang baru.

Preset

Resource

Baca mencakup permintaan GET pada suatu resource; tulis juga mencakup POST, PUT, PATCH dan DELETE. Kunci dengan akses kustom berfungsi di API publik: endpoint sesi, pengguna, bisnis, transaksi, alur kerja, dan webhook, serta pemeriksaan mandiri. Endpoint yang hanya digunakan oleh Business Console mengembalikan 403 untuk kunci ini; endpoint tersebut memerlukan kunci akses penuh. Kunci tanpa izin baca Media menerima keputusan sesi dengan setiap URL gambar, video, dan PDF diatur ke null, dan endpoint laporan PDF mengembalikan 403. Kunci tanpa izin tulis Sesi tidak pernah menerima tautan verifikasi atau token sesi, karena siapa pun yang memegangnya dapat menyelesaikan verifikasi atas nama pengguna akhir: kolom tersebut dikembalikan sebagai null. Dengan alasan yang sama, membuat pengguna dengan send_verification_link: true memerlukan izin tulis Sesi selain izin tulis Orang, karena panggilan itu membuat sesi dan mengirim tautannya melalui email. Tanpa itu, panggilan mengembalikan 403 dan tidak membuat apa pun.

Batasan

Kunci yang dibatasi pada alur kerja tertentu atau pada sesi yang disetujui berfungsi pada endpoint sesi, tempat batasan tersebut dapat diterapkan. Kunci tidak dapat mengakses orang, perusahaan, transaksi, atau analitik, dan tidak dapat menjalankan pemeriksaan mandiri.

Cara API merespons kunci dengan cakupan terbatas

Daftar sesi hanya mengembalikan sesi yang diizinkan oleh batasan kunci.

Ubah akses

Buka menu kunci, pratinjaunya, atau halamannya, lalu pilih Ubah akses. Ubah preset, resource, batasan, atau kedaluwarsa, lalu tinjau hanya yang berubah, sebelum dan sesudah. Rahasia tetap sama sehingga tidak ada yang perlu di-deploy ulang, dan akses baru berlaku dalam satu menit. Rahasia utama selalu memiliki akses penuh dan tidak dapat diubah.

Rotasi kunci

Melakukan rotasi akan mengganti rahasia sebuah kunci. Rahasia baru ditampilkan sekali, dan rahasia saat ini tetap berfungsi selama 24 jam agar Anda dapat men-deploy yang baru tanpa waktu henti. Setelah itu, setiap permintaan dengan rahasia lama mengembalikan 401. Rahasia utama dirotasi dengan cara yang sama, dengan masa tumpang tindih 24 jam.

Cabut kunci

Mencabut kunci menghentikannya seketika: setiap permintaan yang dibuat dengannya mengembalikan 401. Tindakan ini tidak dapat dibatalkan. Rahasia utama tidak dapat dicabut; lakukan rotasi sebagai gantinya.

Penggunaan dan jejak audit

Setiap kunci menampilkan permintaannya selama 30 hari terakhir, tingkat kesalahan dan latensinya, serta permintaan terbarunya beserta kode statusnya, termasuk permintaan yang ditolak oleh batasannya. Setiap panggilan yang dibuat dengan kunci API muncul di log audit organisasi beserta nama kunci yang membuatnya.

Siapa yang dapat mengelola kunci

Mengelola kunci API memerlukan izin Kunci API: baca untuk melihat kunci, tulis untuk membuat, mengedit, merotasi, dan mencabut kunci. Lihat Peran dan izin.
Terakhir diubah pada 7 November 2026