API Key pada Xendit

Xendit mengautentikasi API request Anda dapat menggunakan API Key pada Akun Xendit Anda. Jika Anda tidak menyertakan API Key saat melakukan API request atau menggunakan salah satu API Key yang salah atau API Key yang telah dihapus, maka Xendit akan memberikan response error dari request API Anda.

Terdapat dua tipe API key pada Xendit, yaitu sebagai berikut:

• Secret API key: Secret API Key digunakan untuk membuat semua perintah atas nama akun Anda. Kunci ini harus dirahasiakan dan disimpan hanya di server Anda.
• Public API key: Public API Key digunakan untuk mengidentifikasi akun Anda di Xendit. Dengan kata lain, key ini dicantumkan dalam kode Xendit.js Javascript atau aplikasi Android atau iPhone Anda. Public key hanya dapat digunakan untuk membuat token dan otentikasi pada Kartu Kredit/Debit.

Bagaimana saya dapat membuat API Key melalui dashboard?

Membuat API Key melalui Dashboard Xendit Anda dapat dilakukan dengan melakukan beberapa hal sederhana di bawah ini: 

1. Pertama, pastikan email yang digunakan untuk masuk ke Akun Xendit Anda merupakan email dengan akses 'Developer', dimana akses yang diberikan tersebut dapat membuat Anda melakukan pembuatan API Key melalui dashboard Xendit; 
   • Klik di sini untuk mengetahui lebih lanjut mengenai permission atau akses yang dapat diberikan untuk masing-masing member pada Dashboard Xendit Anda.
2. Kedua, pastikan Anda telah berada pada mode environment yang tepat ("Live Mode" atau "Test Mode") pada pengaturan di bagian kiri atas halaman utama dashboard Anda. 
   • Pilih mode 'Live' apabila Anda ingin membuat API untuk mode Live dimana Anda akan melakukan integrasi untuk transaksi dengan uang sungguhan atau transaksi secara nyata. 
   • Pilih mode 'Test' apabila Anda ingin membuat API Key untuk mode test / sandbox dimana Anda akan melakukan integrasi dalam mode simulasi atau transaksi yang fiktif.
3. Klik bagian API Key pada menu pengaturan di Dashboard Xendit Anda
4. Pilih tipe API Key yang ingin Anda buat (Secret atau Public API Key) 

Public API Key

1. Dikarenakan Public API Key Anda sudah secara otomatis terbuat pada Dashboard Xendit Anda, Anda dapat langsung mengklik 'copy' pada tombol biru di bawah bagian 'Public Key'
2. Nantinya, Anda akan melihat karakter pada API Key Anda dimulai dengan awalan "xnd_public"

Secret API Key

1. Klik tombol biru bertulisan "Generate secret key" untuk membuat Secret API Key
2. Maukan nama dari Secret API Key yang ingin Anda buat
   1. Nama dari Secret API Key Anda dapat berisi hingga maksimum 15 karakter alfanumerik;
   2. Nama dari Secret API Key Anda tidak boleh sama dengan nama Secret API Key yang telah Anda buat sebelumnya
3. Tentukan akses dari Secret API Key yang ingin Anda buat 
   •  
   • Setiap Secret API key yang terbuat di sisi Anda harus memiliki permission yang Anda dapat konfigurasi. Terdapat tiga tipe permission API key, yaitu:
     
     • None: Anda tidak memberikan akses API terhadap produk tersebut.
     • Read: Anda memberikan akses API untuk membaca data saja pada produk yang Anda tentukan. Anda dapat memberikan akses Read ketika Anda hanya ingin, sebagai contoh, mengecek saldo akun Anda atau mengecek suatu detil pembayaran.
     • Write: Anda memberikan akses API untuk membaca dan mengubah data pada produk yang Anda tentukan. Anda dapat memberikan akses Write ketika Anda ingin membaca dan juga melakukan suatu aksi tertentu seperti membuat Invoice, membuat Disbursement, atau mengecek VA, dll
   • Jika Anda tidak ingin menggunakan produk spesifik pada Xendit pada saat ingin membuat Secret API Key, pilih izin akses None sebagai tindakan keamanan yang bertujuan untuk mencegah adanya transaksi yang tidak diingikan dan tidak diketahui jika nantinya Secret API Key Anda diketahui oleh pihak diluar bisnis Anda. 
     • Akun yang aktif melalui Instant-Activated flow hanya bisa memilih None untuk izin penggunaan produk pengiriman uang (Money-out) untuk diperbolehkan membuat API Key;
     • Jika akun yang aktif melalui Instant-Activated flow mencoba membuat API Key dengan izin penggunaan Readatau Writeuntuk produk pengiriman uang (Money-out), maka Anda akan mendapatkan error "User tidak memiliki izin yang diperlukan"
     • Anda akan bisa membuat API Key dengan izin penggunaan Reador Writeuntuk produk pengiriman uang (Money-out) ketika kami sudah selesai memverifikasi dokumen legalitas akun Anda, dan akun Anda berstatus LIVE;
4. Masukan password dari Akun Xendit Anda sebagai bagian dari autentikasi 
5. Apabila nantinya Secret API Key Anda telah terbuat, Secret API Key Anda akan dimulai dengan karakter "xnd_production" untuk LIVE Mode dan "xnd_development" untuk TEST Mode
6. Simpan Secret API Key Anda dan integrate Secret API Key tersebut pada sistem website Anda. 
   1. Sebagai peringatan untuk Anda, Secret API Key yang telah Anda buat tidak akan dapat dilihat kembali. Sehingga pastikan Anda sudah mengingat dan mengcopy Secret API Key Anda dan menyimpannya di folder yang aman
   2. Jika Anda lupa atau salah menempatkan Secret API Key Anda, silakan hapus API Key tersebut dan buat API Key yang baru. 

Bagaimana saya dapat mengintegrasikan API Key saya?

1. Salin API key yang sudah dibuat
2. Gunakan Basic Access Authentication (`BASIC AUTH`) sebagai metode otentikasi di server Anda
3. Format `BASIC AUTH` adalah:

   • {{username}}:{{password}}

4. Masukkan API key ke dalam `username` dan kosongkan `password`.
5. Pastikan Anda menyertakan `:` di belakang

Opsional:

1. Enkripsi nilai tersebut dengan Base64 (https://www.base64encode.org/)
2. Sertakan frasa sandi Base64 tersebut ke dalam header `Authorization`

Selengkapnya mengenai API Key pada Xendit, silahkan mempelajarinya secara lebih lanjut melalui dokumentasi kami di bawah ini: 

• API Integration
• API Keys