Panduan

Mulai integrasi

Dari API key hingga request pertama dalam beberapa menit. Semua contoh menggunakan base URL production dan dapat disalin langsung.

1. Minta akses API

Hubungi tim DIFAPro dan jelaskan jenis data, kebutuhan penggunaan, perkiraan volume, serta hasil yang dibutuhkan. Setelah paket API aktif, administrator dapat membuat API key melalui portal.

2. Siapkan API key

Buat key dari portal API DIFAPro, salin secret satu kali, lalu simpan dalam secret manager atau environment variable backend. Jangan meletakkan key di browser atau aplikasi mobile.

3. Verifikasi koneksi

Gunakan endpoint periode screener saham untuk memastikan base URL, API key, permission, dan konektivitas sudah benar:

curl --request GET \
  --url "https://api.difapro.id/api/equity/screener/data-period" \
  --header "X-API-Key: $DIFAPRO_API_KEY" \
  --header "Accept: application/json"

Respons 200 menandakan request berhasil. Jika mendapat 401 atau 403, periksa status key, paket, dan permission akun API.

4. Pilih endpoint dan parameter

Buka Referensi API, pilih domain, lalu baca deskripsi operation, parameter, request body, dan response schema. Untuk filter berbentuk pilihan, ambil nilainya dari endpoint yang berakhiran -option.

5. Bawa kontrak ke workflow Anda

Download OpenAPI JSON atau import URL berikut ke Postman:

https://docs.difapro.id/api/openapi

Di Postman, pilih Import, tempel URL tersebut, lalu pilih pembuatan collection dari OpenAPI.

6. Periksa respons dan batas request

Periksa status HTTP, jenis konten, satuan, tanggal, nilai kosong, bentuk error, header pagination X-Page, X-PageSize, X-TotalCount, serta header X-RateLimit-* sebelum data masuk ke sistem produksi.