Langsung ke konten

Cari
    Menu dokumentasi

    API Reference

    Changelog API

    Catatan perubahan Developer API OngkirHub dan webhook, dimulai dari peluncuran Developer API v1 pada 6 Oktober 2026.

    Diperbarui

    Halaman ini mencatat perubahan pada Developer API dan webhook, terbaru di atas. Perubahan produk secara umum ada di Changelog.

    Versi API ada di path, yaitu /v1. Versi spesifikasi OpenAPI tercantum di field info.version pada dokumen OpenAPI, yang juga bisa diambil langsung dari https://api.ongkirhub.com/v1/openapi.json.

    6 Oktober 2026: Developer API v1

    Developer API v1 dan webhook diluncurkan bersama OngkirHub 1.0. Versi spesifikasi OpenAPI 1.0.0.

    Endpoint:

    • GET /v1/locations: cari kelurahan, kecamatan, kota, atau kode pos.
    • GET /v1/couriers: daftar kurir, layanan yang bisa dipesan, dan dukungan pelacakan.
    • POST /v1/rates: cek tarif yang bisa dipesan, berlaku 30 menit.
    • POST /v1/shipments, GET /v1/shipments, GET /v1/shipments/{id}: buat, daftar, dan detail pengiriman.
    • POST /v1/shipments/{id}/cancel: ajukan pembatalan.
    • GET /v1/tracking/{awb}: lacak resi.
    • GET /v1/wallet, GET /v1/wallet/transactions: saldo dan mutasi saldo.
    • GET /v1/openapi.json: spesifikasi OpenAPI 3.1, tanpa kunci.

    Fitur pendukung:

    • Kunci test dan live dengan tujuh akses (scope), dikelola di menu Developer.
    • Header Idempotency-Key untuk semua POST.
    • Paginasi cursor dan format error yang seragam dengan request_id.
    • Batas 120 permintaan per 60 detik per kunci, dan 30 per 60 detik untuk membuat pengiriman dan pembatalan.

    Webhook:

    • Event shipment.booked, shipment.awb_ready, shipment.status_updated, shipment.delivered, shipment.failed, shipment.cancelled, topup.paid, dan webhook.test.
    • Tanda tangan OngkirHub-Signature dengan HMAC SHA-256.
    • Percobaan ulang otomatis setelah 1 menit, 5 menit, 30 menit, 2 jam, 6 jam, dan 24 jam.
    • Log webhook dengan Kirim ulang dan Log API di menu Developer, masing-masing menyimpan 30 hari.