🔌 Developer & API

Hubungkan CRMHUB dengan sistem eksternal menggunakan Public API — kirim pesan WhatsApp, kelola kontak, dan banyak lagi secara programatik.

Developer Apps (Kelola API Key)

Sebelum menggunakan Public API, Anda perlu membuat Developer App untuk mendapatkan API Key. API Key digunakan sebagai autentikasi di semua request API.

Cara Membuat Developer App

  1. Buka menu Developer di sidebar (hanya muncul jika diaktifkan oleh Admin).
  2. Klik "+ Buat Aplikasi".
  3. Beri nama aplikasi (contoh: "Integrasi Website", "Bot Order").
  4. Isi deskripsi singkat kegunaan aplikasi.
  5. Klik Buat. API Key akan dibuat otomatis.
  6. Salin API Key yang ditampilkan — simpan di tempat aman, key hanya ditampilkan sekali.
⚠️
Keamanan API Key

Jangan pernah menyimpan API Key di kode yang bisa dilihat publik (repository GitHub, halaman web). Jika key bocor, segera buat key baru dari halaman Developer dengan klik "Regenerate Key".

Memantau Penggunaan API

Di halaman Developer → Log API, Anda dapat melihat semua request yang masuk menggunakan API Key Anda — termasuk endpoint yang dipanggil, waktu, status code, dan payload. Berguna untuk debugging integrasi.

Public API CRMHUB

CRMHUB menyediakan REST API untuk integrasi dengan sistem eksternal. Semua endpoint menggunakan format JSON.

Autentikasi

Sertakan API Key di setiap request menggunakan header:

x-api-key: YOUR_API_KEY_HERE

Base URL

https://domain-anda.com/api/public/v1/

Endpoint Utama

EndpointMethodFungsi
/send-messagePOSTKirim pesan WhatsApp ke nomor tertentu
/send-imagePOSTKirim pesan dengan lampiran gambar
/send-documentPOSTKirim pesan dengan lampiran dokumen/file
/contactsGETAmbil daftar kontak
/contactsPOSTTambah kontak baru
/conversationsGETAmbil daftar percakapan

Contoh: Mengirim Pesan WhatsApp

POST /api/public/v1/send-message
Headers:
  x-api-key: YOUR_API_KEY
  Content-Type: application/json

Body:
{
  "phone": "628123456789",
  "message": "Halo! Pesanan Anda sudah dikonfirmasi.",
  "device_id": "123"
}

Contoh Response Sukses

{
  "success": true,
  "message_id": "WA_MSG_XYZ123",
  "status": "queued"
}

Kode Error Umum

KodeArtiSolusi
401API Key tidak valid atau tidak disertakanPeriksa API Key di header x-api-key
400Request tidak valid (field kurang/salah format)Periksa format JSON dan field yang dikirim
404Resource tidak ditemukan (device_id salah, dll)Verifikasi ID yang digunakan sudah benar
429Rate limit — terlalu banyak requestKurangi frekuensi request, tambah jeda
500Error internal serverCoba ulang beberapa saat, hubungi support jika berlanjut

Webhook (Menerima Event)

Selain mengirim request ke CRMHUB (outbound API), Anda juga dapat menerima notifikasi real-time dari CRMHUB ke sistem Anda menggunakan Webhook Outbound.

Konfigurasi webhook di Settings → Webhook Outbound. Lihat panduan Webhook Outbound.

Dokumentasi API Lengkap

Dokumentasi teknis lengkap dengan semua endpoint, parameter, dan contoh kode tersedia di halaman API Docs di dalam aplikasi:

  1. Buka menu Developer di sidebar.
  2. Klik tab "API Docs".
  3. Dokumentasi interaktif akan tampil — Anda dapat mencoba endpoint langsung dari browser (Swagger UI).