Quickstart

Dari API key sampai request pertama dalam empat langkah.

1. 1
   Dapatkan API key
2. 2
   Pasang header
3. 3
   Kirim request
4. 4
   Sesuaikan payload

1. Dapatkan API key

Masuk ke Dashboard api.co.id dan salin API key Anda. Simpan juga di sini agar fitur Coba langsung di halaman produk langsung memakainya.

API key Anda

Disimpan hanya di browser ini dan dipakai oleh fitur Coba langsung.

2. Pasang header x-api-co-id

Setiap request membawa API key di header x-api-co-id. Simpan key sebagai variabel lingkungan, jangan menuliskannya langsung di kode.

export API_CO_ID_KEY="YOUR_API_KEY"

3. Kirim request

Pilih endpoint dari halaman produk. Contoh berikut mengambil daftar provinsi dari Wilayah Indonesia:

GET /regional/indonesia/provinces

curl -X GET "https://use.api.co.id/regional/indonesia/provinces" \  -H "x-api-co-id: $API_CO_ID_KEY"

Hasil yang diharapkan

Status 200 dengan is_success: true dan daftar provinsi di data.

4. Sesuaikan payload

Endpoint pemrosesan file (OCR, Face Matching, dan sejenisnya) menerima multipart/form-data:

curl -X POST "<endpoint>" \
  -H "x-api-co-id: $API_CO_ID_KEY" \
  -F "file=@/path/to/image.jpg"

• Untuk endpoint JSON, ganti -F dengan -H "Content-Type: application/json" -d '{...}'.
• Cek halaman produk untuk field wajib serta batas ukuran dan format file.
• Untuk hasil OCR terbaik, gunakan gambar yang jelas, beresolusi tinggi, dan tanpa pantulan cahaya.