JAKARTA, INDONESIAPAPAN KASUS BUKA

OpenAPI

Spesifikasi OpenAPI 3.1 yang dipakai server.

Spesifikasi

API dideskripsikan dengan OpenAPI 3.1, ditulis tangan dan disajikan oleh server API yang sama:

text
https://api.dampingin.dev.arsana.cloud/openapi.json
  • Publik, tanpa API key. Header Access-Control-Allow-Origin: *, cache 5 menit.
  • Setiap operasi punya ekstensi x-scope berisi scope yang dibutuhkan.
  • Bagian webhooks.orderEvent mendeskripsikan payload webhook.
  • GET https://api.dampingin.dev.arsana.cloud/ mengembalikan info singkat API (nama, versi, lokasi spec).

Cara pakai

bash
# lihat semua path
curl -s https://api.dampingin.dev.arsana.cloud/openapi.json | jq '.paths | keys'

# buat client TypeScript
npx openapi-typescript https://api.dampingin.dev.arsana.cloud/openapi.json -o dampingin.d.ts

Spec juga bisa diimpor ke Postman, Insomnia, Bruno, atau dipakai sebagai definisi tool untuk framework agent yang membaca OpenAPI.

Catatan

Catatan

Kalau spec dan halaman ini berbeda, perilaku server yang berlaku. Beberapa hal yang lebih rinci di dokumentasi ini daripada di spec:

intake ditandai wajib di skema CreateOrder, tetapi server menerima body tanpa intake dan menilainya terhadap field required layanan (422 INTAKE_INVALID kalau ada yang kurang). Header respons Idempotent-Replayed dan X-RateLimit-* belum didokumentasikan di spec.

Daftar lengkap kode error ada di Errors & rate limit.