KLIEN TEROTENTIKASI
-
Selamat Datang di Portal Developer
Pilih salah satu endpoint di menu sebelah kiri untuk melihat dokumentasi teknis, struktur payload, dan contoh snippet kode.
Klik tombol Export OpenAPI JSON di sudut kanan atas untuk mengunduh skema standar Swagger.
/api/v1/nama_endpoint
Sumber Data: Tabel
Query Parameters (GET)
| Parameter URL | Deskripsi / Instruksi |
|---|
Skema Field & Mutability Klien
| Nama Field / Kolom | Read (GET) | Write (POST/PUT) |
|---|
Rate Limiting & Headers
API ini dilindungi oleh sistem Token Bucket. Jika Rate Limit berlebih, request ditolak dengan kode 429 Too Many Requests. Cek HTTP Headers Response berikut:
X-RateLimit-Limit: Batas maksimal req/menit Anda.X-RateLimit-Remaining: Sisa kuota di menit saat ini.X-RateLimit-Reset: Waktu (UNIX Timestamp) reset kuota.
Code Snippets Integrasi
OTENTIKASI API KEY WAJIB
Semua request ke API Klien (v1) WAJIB menyertakan HTTP Header
UINSU-API-Key: [Token Anda]. Tidak menggunakan Authorization Bearer (JWT).
Format Standar Respons (JSON)
Seluruh respon API Core dibungkus dalam arsitektur JSend baku berikut:
{
"status": "success", // "success" atau "error"
"data": { ... }, // Kumpulan baris (GET) atau Objek Detail
"request_id": "req_64f1a2...", // ID unik pelacakan Audit Log
"error": null // Objek pesan { "message": "..." } jika gagal
}
HTTP Status Codes (Panduan Error)
| 200 OK | Kueri berhasil (GET/PUT/DELETE). |
| 201 Created | Data baru berhasil disimpan (POST). |
| 400 Bad Req | Input salah, parameter template kurang, atau JSON payload tidak valid. |
| 401 Unauth | UINSU-API-Key tidak valid, dicabut, atau header kosong. |
| 403 Forbidden | Izin Scope ditolak / IP tidak terdaftar di Whitelist Anda. |
| 404 Not Found | Endpoint dimatikan atau Data (ID) tidak ditemukan. |
| 429 Too Many | Aplikasi Anda melewati batas kuota Rate Limit per menit. |
| 500 Server Err | Kueri SQL bermasalah atau Database server UINSU terputus. |