Volara Docs

Tema

API Reference ​

API Volara adalah REST API ber-otentikasi API key yang memungkinkan Anda mengirim pesan, mengelola kontak dan percakapan, knowledge base, serta menerima event lewat webhook. Seluruh API dideskripsikan oleh satu sumber mesin-terbaca: OpenAPI 3.1.

Referensi interaktif (Scalar)

Buka Referensi API interaktif → — daftar lengkap endpoint, parameter, contoh request/response, panel try-it, dan pemilih bahasa kode (cURL, TypeScript, Python). Dirender dengan Scalar dari /openapi.json.

Konsep API ​

Baca halaman konsep ini sebelum integrasi serius:

  • Autentikasi — API key via Authorization: Bearer.
  • Errors — amplop error + kode VLR-*.
  • Rate Limits — kuota per kunci + header RateLimit-*.
  • Pagination — kursor untuk endpoint daftar.
  • Webhooks — event masuk + verifikasi HMAC-SHA256.

Autentikasi ​

Semua permintaan memerlukan header:

Authorization: Bearer <API_KEY>

Buat API key di Settings → API Keys. Setiap kunci terikat pada satu tenant; konteks tenant ditentukan dari kunci terverifikasi, bukan dari header publik. Detail lengkap di Autentikasi.

Konvensi ​

  • Base URL: https://api.volara.chat
  • Versi: /api/v1/* adalah mirror stabil dari /api/*. Untuk integrasi yang perlu kontrak stabil, pakai prefix /api/v1.
  • Format: JSON request & response (Content-Type: application/json).
  • Pagination: endpoint daftar memakai kursor — lihat Pagination.
  • Rate limit: respons menyertakan header RateLimit-*; tangani 429 dengan backoff — lihat Rate Limits.
  • Errors: amplop konsisten { "error": { "code", "message", "details" } } — lihat Errors.
  • Timestamps: ISO 8601 (UTC).

Kelompok endpoint ​

  • Messaging — kirim pesan teks/template ke WhatsApp, Instagram, dan TikTok.
  • Contacts & CRM — kelola kontak dan pipeline CRM.
  • Conversations & Inbox — baca dan kelola percakapan Inbox.
  • Knowledge — cari sumber dan FAQ (GET /knowledge/sources?q= & GET /knowledge/faqs?q=) untuk Knowledge / RAG.
  • Broadcast & Flows — kampanye dan automation.
  • Tickets — tiket support.
  • Agency / White-label — provisioning klien di bawah /agencies/current/... (lihat Agency).
  • Webhooks — daftarkan endpoint untuk event masuk (verifikasi HMAC-SHA256, retry/backoff, idempotency) — lihat Webhooks.

Daftar endpoint persisnya selalu dari Referensi API interaktif (sumber kebenaran OpenAPI), bukan dari contoh di halaman panduan.

Contoh: kirim pesan ​

bash
curl -X POST https://api.volara.chat/api/v1/messages \
  -H "Authorization: Bearer API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "channelId": "CHANNEL_ID", "to": "6281234567890", "type": "text", "text": "Halo!" }'

Langkah selanjutnya ​