OmniStream CRM API

Omnichannel CRM platform REST API. Centralizes WhatsApp, Instagram DM, and Email into a unified inbox with real-time messaging, agent management, analytics, and contact tracking.

Authentication

Semua endpoint memerlukan autentikasi menggunakan API Key melalui header X-API-Key.

Code
X-API-Key: os_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Buat API key melalui menu Developer > API Keys di aplikasi, atau via endpoint POST /api/api-keys (memerlukan login sebagai supervisor/admin). Key lama dengan format omni_... tetap diterima dan diarahkan ke tenant default.

Catatan: key berformat os_00000000_... yang dibuat oleh tenant non-default sebelum perbaikan multi-tenant tidak pernah valid dan tetap tidak valid setelah perbaikan — buat ulang key dari menu Developer > API Keys.

RBAC dan Izin

Platform menggunakan RBAC berbasis izin. Tiga role sistem bawaan tersedia (admin, supervisor, agent) dengan hak akses tetap. Admin dapat membuat role kustom dengan kombinasi izin yang fleksibel. Izin diperiksa per-endpoint menggunakan kode seperti agents.manage, campaigns.manage, dan developer.access.

Error Responses

All errors return a consistent JSON format:

Code
{ "error": { "message": "description", "code": 401 } }