Lewati ke konten utama

Ringkasan API

REST API GoValid menyediakan akses programatik ke fitur pembuatan, verifikasi, dan manajemen QR code.

URL Dasar​

https://api.govalid.org/api/v1/

Endpoint alternatif:

  • https://my.govalid.org/api/v1/
  • https://govalid.org/api/v1/

Versi API​

Versi saat ini: v1.1.0

Fitur​

  • RESTful JSON API
  • Autentikasi JWT dan API Key
  • Rate limiting dengan header yang jelas
  • Penanganan error komprehensif
  • Spesifikasi OpenAPI 3.0

Kategori API​

KategoriDeskripsiDokumentasi
AutentikasiRegistrasi, login, token, 2FAAutentikasi
AkunProfil, pengaturan, keamananEndpoint Akun
QR CodesBuat, kelola, scan, verifikasiEndpoint QR
FinansialLangganan, invoice, kreditEndpoint Finansial
InstitusiManajemen organisasiEndpoint Institusi
C-TraceTraceabilitas rantai pasokEndpoint C-Trace
Anti-PemalsuanAutentikasi produkEndpoint Anti-Pemalsuan
KomunitasFitur NexCommunityEndpoint Komunitas
WebhooksIntegrasi berbasis eventWebhooks

Dokumentasi Interaktif​

Jelajahi API secara interaktif:

Batas Rate​

PaketRequest
Free100/jam
Pro1.000/jam
Enterprise10.000/jam

Header batas rate disertakan di semua respons:

  • X-RateLimit-Limit - Maksimum request yang diizinkan
  • X-RateLimit-Remaining - Sisa request
  • X-RateLimit-Reset - Waktu hingga limit reset

Format Respons​

Semua respons berupa JSON:

{
  "success": true,
  "data": { ... }
}

Respons error:

{
  "error": "error_code",
  "message": "Pesan yang dapat dibaca manusia",
  "details": { ... }
}

Grup Endpoint​

Endpoint Autentikasi​

MethodEndpointDeskripsi
POST/api/v1/auth/register/Registrasi akun baru
POST/api/v1/auth/login/Login dan dapatkan token
POST/api/v1/auth/logout/Logout dan cabut token
POST/api/v1/auth/token/refresh/Refresh access token
POST/api/v1/auth/password/reset/Request reset password
POST/api/v1/auth/email/verify/Verifikasi alamat email
POST/api/v1/auth/2fa/enable/Aktifkan two-factor auth
POST/api/v1/auth/2fa/verify/Verifikasi kode 2FA
POST/api/v1/auth/2fa/disable/Nonaktifkan two-factor auth

Endpoint Akun​

MethodEndpointDeskripsi
GET/api/v1/account/profile/Dapatkan profil
PATCH/api/v1/account/profile/Update profil
GET/api/v1/account/preferences/Dapatkan preferensi
PATCH/api/v1/account/preferences/Update preferensi
POST/api/v1/account/change-password/Ubah password
GET/api/v1/account/security/Dapatkan pengaturan keamanan
GET/api/v1/account/sessions/Daftar sesi aktif
DELETE/api/v1/account/sessions/{id}/Cabut sesi
POST/api/v1/account/data-export/Request ekspor data
POST/api/v1/account/delete/Request penghapusan akun

Endpoint QR​

MethodEndpointDeskripsi
GET/api/v1/qr/Daftar QR code
POST/api/v1/qr/Buat QR code
GET/api/v1/qr/{id}/Dapatkan detail QR code
PATCH/api/v1/qr/{id}/Update QR code
DELETE/api/v1/qr/{id}/Hapus QR code
GET/api/v1/qr/{id}/scans/Dapatkan riwayat scan
GET/api/v1/qr/{id}/analytics/Dapatkan analitik
POST/api/v1/qr/bulk/Buat QR code massal

Endpoint Finansial​

MethodEndpointDeskripsi
GET/api/v1/financial/plans/Daftar paket tersedia
GET/api/v1/financial/subscription/Dapatkan status langganan
POST/api/v1/financial/subscribe/Berlangganan paket
GET/api/v1/financial/invoices/Daftar invoice
POST/api/v1/financial/topup/Top up kredit
GET/api/v1/financial/transactions/Daftar transaksi
GET/api/v1/financial/pricing/Dapatkan info harga

Endpoint Institusi​

MethodEndpointDeskripsi
GET/api/v1/institution/settings/Dapatkan pengaturan institusi
GET/api/v1/institution/departments/Daftar departemen
POST/api/v1/institution/departments/Buat departemen
GET/api/v1/institution/roles/Daftar peran
POST/api/v1/institution/roles/Buat peran

Endpoint C-Trace​

MethodEndpointDeskripsi
POST/api/v1/ctrace/verify/Verifikasi C-Trace QR
GET/api/v1/ctrace/templates/Daftar template
POST/api/v1/ctrace/batches/Buat batch
POST/api/v1/ctrace/step-checkin/Log step check-in

Endpoint Anti-Pemalsuan​

MethodEndpointDeskripsi
GET/api/v1/anti-counterfeit/profiles/Daftar profil
POST/api/v1/anti-counterfeit/assignments/Assign QR ke produk
GET/api/v1/anti-counterfeit/violations/Daftar pelanggaran
GET/api/v1/anti-counterfeit/reports/Buat laporan
POST/api/v1/anti-counterfeit/detect/Deteksi pemalsuan

Endpoint Komunitas​

MethodEndpointDeskripsi
GET/api/v1/community/feed/Dapatkan feed komunitas
POST/api/v1/community/vote/Cast trust vote
POST/api/v1/community/comments/Tambah komentar
GET/api/v1/community/friends/Daftar teman
GET/api/v1/community/badges/Daftar badge

Langkah Selanjutnya​