Developer

Akses vybeflow dari kode Anda sendiri, atau dari asisten AI lewat MCP. Setiap endpoint memerlukan API key tenant dan hanya berjalan dalam cakupan izin kunci itu.

Buat kunci

Di konsol vybeflow: Pengaturan → API Key. Pilih izin yang boleh dipakai dan kapan kunci kedaluwarsa. Kunci hanya ditampilkan satu kali.

Hubungkan asisten AI

Setiap domain adalah server MCP tersendiri dengan dua tool. Pasang hanya domain yang Anda perlukan.

Paket belum ada di npm. Jalankan dari source: clone repo-nya, npm install, lalu arahkan client ke packages/<domain>/bin/cli.js.

{
  "mcpServers": {
    "vybeflow-inbox": {
      "command": "node",
      "args": ["/path/to/vybeflow-mcp/packages/inbox/bin/cli.js"],
      "env": { "VYBEFLOW_API_KEY": "vf_live_..." }
    }
  }
}

Coba tanyakan ini

Setelah server terhubung, ini hal-hal yang bisa langsung Anda ketik. Masing-masing butuh izin di sebelahnya — centang saat membuat kunci, kalau tidak asistennya akan ditolak di tengah jawaban.

Ada berapa tiket yang masih terbuka, dan mana yang paling lama belum dibalas? butuh inbox.read
Balas tiket T-1042: bilang paketnya dikirim besok pagi. butuh inbox.reply · akan minta konfirmasi dulu
Cari kontak dengan nomor 6281234567890, lalu tunjukkan riwayat tiketnya. butuh contact.read + inbox.read
Kampanye mana yang open rate-nya paling rendah bulan ini? butuh campaign.read
Buat kampanye "Promo Akhir Bulan" untuk WhatsApp, jangan dikirim dulu. butuh campaign.manage
Kirim kampanye "Promo Akhir Bulan" sekarang. butuh campaign.send · akan minta konfirmasi dulu
Produk mana yang stoknya di bawah 10? butuh product.read
Berapa sisa kuota AI saya, dan kapan langganan berakhir? butuh quota.read + billing.read
Jam kerja CS kami jam berapa? butuh tenant.setting.read

Panggil langsung

curl -H "x-api-key: vf_live_..." \
  https://vybeflow.vyber.id/api/campaign/campaigns

Untuk dibaca mesin

Daftar endpoint

contact 6

Endpoint	izin	risiko
`GET /api/user/users` Daftar kontak pelanggan milik tenant.	`contact.read`	safe
`POST /api/user/users` Tambah satu kontak baru.	`contact.manage`	confirm
`PUT /api/user/users/:id` Ubah satu kontak.	`contact.manage`	confirm
`DELETE /api/user/users/:id` Hapus satu kontak. Tidak bisa dibatalkan.	`contact.delete`	destructive
`POST /api/user/users/import` Impor banyak kontak sekaligus.	`contact.manage`	confirm
`GET /api/user/users/campaign/:campaignID` Kontak yang termasuk dalam satu kampanye.	`contact.read`	safe

campaign 7

Endpoint	izin	risiko
`GET /api/campaign/campaigns` Daftar kampanye beserta status dan jumlah penerima.	`campaign.read`	safe
`GET /api/campaign/campaigns/analytics` Ringkasan performa kampanye: terkirim, dibuka, gagal.	`campaign.read`	safe
`POST /api/campaign/campaigns` Buat kampanye baru. Membuat TIDAK mengirim — pakai campaign.send.	`campaign.manage`	confirm
`POST /api/campaign/campaigns/:id/send` MULAI mengirim kampanye ke seluruh penerimanya.	`campaign.send`	destructive
`POST /api/campaign/campaigns/:id/cancel` Hentikan kampanye yang sedang berjalan. Pesan yang sudah terkirim tetap terkirim.	`campaign.control`	confirm
`GET /api/campaign/campaigns/:id/progress` Kemajuan pengiriman satu kampanye.	`campaign.read`	safe
`DELETE /api/campaign/campaigns/:id` Hapus kampanye beserta statistiknya.	`campaign.manage`	destructive

inbox 7

Endpoint	izin	risiko
`GET /api/ai/v1/tickets` Daftar tiket percakapan.	`inbox.read`	safe
`GET /api/ai/v1/tickets/stats` Jumlah tiket per channel dan per status.	`inbox.read`	safe
`GET /api/ai/v1/tickets/:ticketID` Satu tiket beserta riwayat pesannya.	`inbox.read`	safe
`GET /api/ai/v1/tickets/status/:status` Tiket dengan satu status tertentu.	`inbox.read`	safe
`POST /api/ai/v1/tickets` Buat tiket baru.	`inbox.manage`	confirm
`POST /api/ai/v1/tickets/:ticketID/reply` Kirim balasan ke pelanggan pada satu tiket.	`inbox.reply`	destructive
`POST /api/ai/v1/tickets/:ticketID/close` Tutup tiket.	`inbox.manage`	confirm

channel 5

Endpoint	izin	risiko
`GET /api/channel/v1/channels` Daftar channel yang terhubung beserta statusnya.	`channel.read`	safe
`GET /api/channel/v1/channels/:channelId` Detail satu channel.	`channel.read`	safe
`GET /api/channel/v1/whatsapp/status` Status sambungan WhatsApp tenant.	`channel.read`	safe
`GET /api/channel/v1/whatsapp/cloud/templates` Template WhatsApp Cloud yang sudah disetujui Meta.	`channel.read`	safe
`POST /api/channel/v1/notification/send/whatsapp` Kirim satu pesan WhatsApp ke satu nomor.	`inbox.reply`	destructive

product 5

Endpoint	izin	risiko
`GET /api/product/v1/products` Daftar produk milik tenant.	`product.read`	safe
`GET /api/product/v1/products/:productID` Detail satu produk.	`product.read`	safe
`POST /api/product/v1/products` Tambah produk baru.	`product.manage`	confirm
`PUT /api/product/v1/products/:productID` Ubah satu produk.	`product.manage`	confirm
`DELETE /api/product/v1/products/:productID` Hapus satu produk beserta gambarnya.	`product.manage`	destructive

billing 5

Endpoint	izin	risiko
`GET /api/payment/v1/payment/history` Riwayat transaksi pembayaran tenant.	`billing.read`	safe
`GET /api/payment/v1/payment/history/:orderID` Satu transaksi berdasarkan orderID.	`billing.read`	safe
`GET /api/user/v1/dashboard/subscription` Paket langganan yang sedang aktif.	`billing.read`	safe
`GET /api/ai/v1/quota` Sisa kuota AI dan pesan untuk tenant ini.	`quota.read`	safe
`GET /api/ai/v1/usage` Riwayat pemakaian kuota.	`quota.read`	safe

tenant 2

Endpoint	izin	risiko
`GET /api/user/v1/dashboard/setting` Profil perusahaan: nama, alamat, kontak, jam kerja.	`tenant.setting.read`	safe
`GET /api/user/v1/dashboard/tenant/list` Tenant yang dapat diakses pemegang kredensial ini.	`tenant.read`	safe