Skip to main content
Contoh payload di halaman ini disederhanakan supaya mudah dibaca. Beberapa route juga menambahkan header rate limit seperti X-RateLimit-Limit, X-RateLimit-Remaining, dan X-RateLimit-Reset.

Ringkasan endpoint

Public endpoint

Request body:
Respons sukses:
Respons umum:
Request body:
Respons sukses:
Respons umum:
Respons inti:
Catatan:
  • status 200 dipakai saat sistem sehat untuk fitur aktif,
  • status 503 dipakai saat ada fitur aktif yang belum siap atau check database gagal,
  • respons juga membawa map per fitur yang berisi enabled, missing_env, dan disabled_by_flag.

Endpoint untuk user login

Request body:
Respons sukses Midtrans:
Respons sukses Doku:
Respons umum:
Request body:
Nilai valid:
  • cancel
  • resume
Respons sukses:
Atau:
Respons umum:
Request body:
Respons sukses:
Respons umum:
Request body:
Respons sukses:
Respons umum:

Endpoint admin

Request body:
Respons sukses:
Respons umum:

Endpoint AI

Request body:
Respons sukses:
  • stream UI message response, bukan JSON biasa,
  • usage dicatat setelah stream selesai.
Respons umum:
Request body:
Respons sukses:
Respons umum:

Endpoint webhook provider

Gunakan endpoint ini sebagai callback dari Midtrans, bukan dari browser user.Yang diverifikasi:
  • order_id
  • status_code
  • gross_amount
  • signature_key
  • transaction_status
Perilaku penting:
  • signature invalid menghasilkan 401,
  • payload invalid menghasilkan 400,
  • payment record tidak ditemukan menghasilkan 404,
  • duplicate event bisa mengembalikan { "received": true, "duplicate": true },
  • event valid akan memperbarui payments, bisa mengaktifkan subscriptions, lalu menulis webhook_events dan audit_logs.
Gunakan endpoint ini sebagai callback dari Doku JOKUL, bukan dari browser user.Yang diverifikasi:
  • order.invoice_number
  • order.amount
  • transaction.status
  • transaction.original_request_id
  • security.check_word
Perilaku penting:
  • signature invalid menghasilkan 401,
  • payload invalid menghasilkan 400,
  • payment record tidak ditemukan menghasilkan 404,
  • duplicate event bisa diidentifikasi lewat webhook_events,
  • event valid memperbarui payments, bisa mengaktifkan subscriptions, lalu menulis audit trail.
Route /auth/confirm adalah callback auth, bukan endpoint /api. Untuk memahami perannya dalam login, OTP, dan OAuth flow, baca Flow end-to-end.