Welcome

OGI API Reference

Dokumentasi teknis Orbit Global Informasi untuk integrasi OCR KTP, face match, liveness, NIK validation, SDK session, webhook, usage, dan billing.

Semua endpoint menggunakan REST + JSON, autentikasi via API Key, dan format response yang seragam. Pilih layanan dari sidebar di kiri untuk melihat detail endpoint, atau scroll panduan singkat di bawah ini.

Pendahuluan

Orbit Global Informasi menyediakan API untuk alur verifikasi identitas: OCR KTP, face match, active liveness, SDK session, usage log, billing, dan webhook operasional. Integrasi publik dijaga melalui kontrak endpoint yang jelas agar sistem Anda dapat memanggil layanan dengan pola yang sama.

Base URL: https://api.orbitglobalinformasi.com/api/v1
Evaluasi: API tester dan kuota request disiapkan sesuai kesepakatan integrasi.
Format: JSON over HTTPS
Region: Indonesia (Jakarta, JKT-DC1)

Autentikasi

Setiap request harus menyertakan header berikut:

X-API-Key required

Secret Key untuk server-to-server API.

Content-Type required

application/json atau multipart/form-data sesuai kebutuhan endpoint.

Gunakan X-API-Key (Secret Key) untuk server-to-server API. Untuk SDK client (browser/mobile), backend Anda membuat session menggunakan X-Publishable-Key, lalu mengirim session token tersebut ke aplikasi client.

Secret Key hanya disimpan di backend.
API tester dan kuota evaluasi digunakan untuk validasi teknis sebelum production.

Error handling

Semua response error mengikuti struktur seragam:

{
  "request_id": "req_12345",
  "status": "error",
  "processing_time_ms": 45,
  "error": {
    "code": "invalid_api_key",
    "message": "API key tidak valid atau tidak aktif."
  }
}

Code	Status	Deskripsi
`200`	OK	Request berhasil diproses.
`400`	Bad Request	Payload tidak valid (field hilang/format salah).
`401`	Unauthorized	API key tidak valid atau tidak disertakan.
`429`	Too Many Requests	Rate limit terlampaui.
`500`	Internal Server Error	Kesalahan internal sistem.

Rate limit

Secara default, seluruh API kami dibatasi 100 request per detik per IP dan 1000 request per menit per akun.

Apabila limit ini terlampaui, API akan mengembalikan status 429 Too Many Requests. Silakan implementasikan mekanisme exponential backoff di sistem Anda untuk melakukan retry setelah beberapa saat.

Idempotency

Beberapa endpoint kami mendukung pengiriman header Idempotency-Key untuk mencegah duplikasi eksekusi request yang sama secara tidak sengaja akibat network timeout atau retry otomatis.

Sertakan UUID pada header ini, dan apabila kami mendeteksi key yang sama dikirimkan dalam kurun waktu 24 jam dengan status sebelumnya berhasil, kami akan mengembalikan response tersimpan tanpa memproses ulang dari awal.

Eksplorasi cepat

Pilih kategori untuk lihat seluruh endpoint: