Dokumentasi APIDokumentasi Teknis

Dokumentasi API dari deskripsi endpoint Anda

Biasanya selesai dalam 15 menitTermasuk revisiPemeriksaan kualitas
Paket
Perlindungan pembayaranSelengkapnya
  • Revisi dalam batas paket tidak dikenai biaya.
  • Jika Anda tidak merespons dalam 3 hari setelah penyerahan hasil, hasil kerja diterima secara otomatis.

Uang ditahan saat Anda membayar dan diteruskan hanya setelah Anda menerima hasil kerja.

Dokumentasi API dari deskripsi endpoint Anda

Contoh hasil

Contoh untuk paket Standar

Dokumentasi API: API pelacakan paket untuk toko online

Panduan cepat

  1. Ambil API key di Dashboard → Settings → API keys.
  2. Kirim setiap request dengan header Authorization: Bearer <your_key>.
  3. Base URL: https://api.trackpoint.example/v1

Mengambil data pengiriman

GET /shipments/{tracking_number}

Mengembalikan status terkini dan riwayat kejadian satu paket.

ParameterLokasiWajibDeskripsi
tracking_numberpathyaNomor resi kurir, 8–30 karakter
langquerytidakBahasa teks status: en, de, fr. Default: en

Contoh request

curl https://api.trackpoint.example/v1/shipments/JD014600006281 \
  -H "Authorization: Bearer sk_test_51x..."

Contoh response (200)

{
  "tracking_number": "JD014600006281",
  "status": "in_transit",
  "estimated_delivery": "2026-11-19",
  "events": [
    {"time": "2026-11-16T08:42:00Z", "location": "Leipzig hub", "status": "in_transit"}
  ]
}

Error

KodeArtiYang perlu dilakukan
401API key tidak ada atau salahCek header Authorization
404Nomor resi tidak ditemukanKurir bisa butuh hingga 2 jam untuk mendaftarkan paket baru
429Lebih dari 100 request per menitTunggu sesuai waktu di header Retry-After

Yang diserahkan

Dokumentasi untuk ke-14 endpoint dalam Markdown, siap dipasang di situs dokumentasi klien, plus daftar 3 bagian di mana perilaku API berbeda dari deskripsinya, yang sudah dikirim ke tim developer.

Klien: Trackpoint, startup yang REST API-nya membantu toko online menampilkan status paket; tim developer mengirim deskripsi singkat 14 endpoint dan sekumpulan contoh request Tugas: panduan cepat dan referensi endpoint yang bisa diikuti developer dalam 15 menit; cuplikannya di bawah

Klien dan semua datanya fiktif.

Tentang layanan ini

Developer menilai API dari dokumentasinya dalam hitungan menit: jika autentikasi atau permintaan pertama tidak berhasil, mereka pergi. Dari deskripsi endpoint, file OpenAPI, atau contoh kode Anda, kami menulis referensi dan panduan API: autentikasi, base URL, setiap endpoint dengan parameter, contoh permintaan dan respons, kode error, rate limit, dan paginasi. Quick start menunjukkan panggilan pertama yang berhasil dalam beberapa langkah.

Yang termasuk

  • Yang Anda dapatkanDokumentasi API dalam Markdown dengan blok kode, siap untuk ReadMe, GitBook, Docusaurus, atau repositori Anda. Kami menulis dari apa yang Anda kirim dan tidak memanggil API Anda sendiri.
  • Quick startDari API key hingga panggilan pertama
  • Referensi endpointParameter, tipe, contoh
  • Error dan batasanKode, artinya, saran percobaan ulang
  • Contoh kodecURL plus satu bahasa pilihan Anda
  • Istilah yang konsistenNama yang sama dengan skema Anda

Cara kerja

  1. 1
    BriefAnda menempelkan atau melampirkan endpoint dan contoh
  2. 2
    Struktur dan penulisanKami menulis referensi dan panduan
  3. 3
    Penyerahan hasilAnda menerima Markdown siap publikasi

Yang kami butuhkan dari Anda

Deskripsi endpoint atau file OpenAPI atau Postman yang ditempel sebagai teks, detail autentikasi, contoh permintaan dan respons, kode error, dan siapa pengguna API Anda.

Kami akan menanyakan:

  • Apa fungsi API ini, dan siapa penggunanya?
  • Bagaimana cara kerja autentikasinya?
  • Bahasa apa yang digunakan untuk contoh kode selain cURL?
  • Di mana dokumentasi akan dipublikasikan?

Bandingkan paket

PaketDasarRp 323.000StandarRp 663.000PremiumRp 1.343.000
Yang termasukQuick start dan hingga 5 endpointHingga 20 endpoint dengan panduanHingga 50 endpoint, dokumentasi lengkap
Tenggat1 hari3 hari5 hari
Revisi123
Panjanghingga 2.000 katahingga 6.000 katahingga 14.000 kata
Endpointhingga 5hingga 20hingga 50
Bahasa contoh kodecURLcURL + 1cURL + 2
Pesan DasarPesan StandarPesan Premium

Perlindungan pembayaran

Anda membayar saat memesan, tetapi uangnya diteruskan hanya untuk hasil kerja yang diterima.

  • Harga pastiHarga paket tidak berubah setelah Anda membayar.
  • Uang ditahanSaat Anda membayar, jumlahnya hanya ditahan. Dana diteruskan ke Dleex setelah Anda menerima hasil kerja.
  • Diperiksa sebelum penyerahanSetiap hasil melewati pemeriksaan kualitas sebelum sampai kepada Anda, dan Anda dapat melihatnya di halaman pesanan sebelum menerimanya.
  • Revisi gratisMinta revisi sesuai brief Anda sebanyak yang diizinkan paket.
  • Diterima setelah 3 hariJika dalam 3 hari setelah penyerahan hasil Anda tidak menerima hasil kerja maupun meminta revisi, hasil kerja diterima secara otomatis. Jika Anda menulis di chat pesanan setelah penyerahan hasil, pesanan akan menunggu; setelah kami menjawab, kami dapat memulai ulang hitungan 3 hari dan akan memberitahukannya di chat.
  • Dikerjakan ulang atau pengembalian dana penuhJika hasilnya tidak sesuai brief Anda dan revisi tidak memperbaikinya, atau pengerjaan memakan waktu lebih dari dua kali tenggatnya, tulis di chat pesanan: kami akan mengerjakan ulang atau mengembalikan pembayaran secara penuh.
Cara kerjanya →

Tanya jawab

Bisakah Anda bekerja dari spesifikasi OpenAPI kami?

Ya, tempelkan YAML atau JSON-nya ke brief. Kami mengubah deskripsinya menjadi halaman referensi yang mudah dibaca dan mengisi celah yang Anda tunjukkan.

Apakah Anda akan menguji contohnya?

Kami tidak memanggil API Anda. Contoh dibuat dari sampel permintaan dan respons Anda, jadi jalankan sekali sebelum dipublikasikan.

Apakah Anda menulis dokumentasi SDK?

Ya, jika Anda mengirim signature metode dan contoh penggunaan. Setiap SDK dihitung sebagai bagian dari volume paket.

Tidak menemukan jawabannya?

Paket