Autentikasi
Cara membuktikan permintaan berasal dari Anda memakai kunci API.
Setiap permintaan ke /v1/* wajib membawa kunci API di header Authorization dengan skema Bearer. Tidak ada signature tambahan untuk permintaan keluar dari sistem Anda.
Header
Authorization: Bearer zp_test_3f9a1c0b7e5d4a28b6c1e0f9d8a7b6c5d4e3f2a1Jenis kunci
| Awalan | Mode | Diterima di |
|---|---|---|
zp_test_ | Sandbox | https://api-sandbox.zevalpay.com |
zp_live_ | Live | https://api.zevalpay.com |
Kunci berbentuk awalan lalu 40 karakter heksadesimal. Satu merchant punya satu kunci per mode. Merchant yang belum lolos verifikasi usaha hanya punya kunci test.
Mendapatkan dan mengganti kunci
- Buka menu Kunci API di dashboard. Halaman mengikuti saklar Sandbox/Live di bagian atas.
- Pemilik dan developer bisa melihat dan menyalin kunci.
- Buat ulang kunci bila bocor. Kunci lama langsung berhenti berlaku, jadi perbarui sistem Anda segera.
Jaga kerahasiaan kunciSimpan kunci di server (variabel lingkungan atau penyimpan rahasia). Jangan menaruhnya di aplikasi mobile, kode web yang dilihat pengguna, atau repositori publik. Panggil API hanya dari server Anda.
Membatasi IP (disarankan untuk live)
Di halaman Kunci API pada dashboard, Anda bisa mengisi daftar IP yang diizinkan untuk tiap kunci. Bila terisi, kunci hanya diterima dari alamat itu, sehingga kunci yang bocor tidak bisa dipakai dari server lain. Kosong berarti semua IP diizinkan.
- Satu alamat per baris: IPv4, IPv6, atau rentang CIDR (mis.
203.0.113.0/24). Maksimal 20. - Daftar berlaku per kunci, jadi kunci Sandbox dan Live punya daftar sendiri.
- Pakai IP keluar server Anda, yaitu IP yang terlihat oleh internet, bukan IP internal.
- Permintaan dari IP lain dijawab
403 ip_not_alloweddan pesannya menyebut IP yang kami lihat.
Contoh kode
cURL
curl https://api-sandbox.zevalpay.com/v1/channels \
-H "Authorization: Bearer zp_test_KUNCI_ANDA"PHP
<?php
$ch = curl_init('https://api-sandbox.zevalpay.com/v1/channels');
curl_setopt_array($ch, [
CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('ZEVALPAY_KEY')],
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$result = json_decode(curl_exec($ch), true);Node.js
const res = await fetch('https://api-sandbox.zevalpay.com/v1/channels', {
headers: { Authorization: 'Bearer ' + process.env.ZEVALPAY_KEY },
});
const result = await res.json();Python
import os, requests
res = requests.get(
"https://api-sandbox.zevalpay.com/v1/channels",
headers={"Authorization": "Bearer " + os.environ["ZEVALPAY_KEY"]},
timeout=30,
)
result = res.json()Galat autentikasi
| Kode | HTTP | Penyebab |
|---|---|---|
invalid_api_key | 401 | Header tidak ada, bentuk kunci salah, kunci tidak dikenal, atau kunci sudah dibuat ulang. |
wrong_environment | 403 | Kunci test dipakai di alamat live, atau kunci live di alamat sandbox. |
merchant_not_active | 403 | Kunci live dipakai sebelum verifikasi usaha (KYB) disetujui, atau merchant tidak lagi aktif. |
ip_not_allowed | 403 | Kunci punya daftar IP dan alamat pemanggil tidak ada di dalamnya. |
merchant_suspended | 403 | Merchant sedang ditangguhkan. |
rate_limited | 429 | Lebih dari 120 permintaan per menit untuk kunci ini. |