Pengenalan API
API Medivy memungkinkan sistem Anda (ERP, aplikasi internal, dashboard BI) membaca data organisasi Anda, seperti outlet, produk, stok, pelanggan, transaksi POS, faktur, dan laporan pendapatan.
Dasar-dasar
Section titled “Dasar-dasar”- Base URL:
https://api.medivy.id - Cakupan: setiap endpoint berada di bawah
/api/dash/<orgId>/…. Satu API key hanya berlaku untuk satu organisasi. - Autentikasi: kirim API key di header
x-api-key. Lihat Autentikasi. - Format: JSON, selalu lewat HTTPS.
curl -H "x-api-key: mdv_…" https://api.medivy.id/api/dash/<orgId>/outletsFormat respons
Section titled “Format respons”Respons yang berhasil:
{ "ok": true, "requestId": "…", "data": { }, "metadata": { } }Respons gagal:
{ "ok": false, "message": "Penjelasan error" }| Status | Arti |
|---|---|
401 |
API key tidak ada, tidak valid, dinonaktifkan, atau kedaluwarsa. |
403 |
Key milik organisasi lain, dipakai dari IP di luar daftar izin, atau pengguna key tidak punya izin untuk endpoint tersebut. |
429 |
Terlalu banyak permintaan dari organisasi Anda. Batasnya longgar (sekitar 600 permintaan per menit per organisasi); tunggu sebentar lalu coba lagi. |
Referensi endpoint
Section titled “Referensi endpoint”Daftar endpoint lengkap ada di Referensi API. Referensi dibuat otomatis dari kode dan ditulis dalam bahasa Inggris. Hanya endpoint yang tercantum di referensi yang didukung untuk integrasi.