DocsRejea ya API

Rejea ya API

Jenga juu ya BeeCastly ukitumia API yetu ya REST iliyoangaziwa kikamilifu. Dhibiti anwani, tuma ujumbe, unda kampeni, na usanidi viboreshaji vya wavuti kwa utaratibu.

URL ya msingi

https://beecastly.com/api

Viingilio vyote vya API vinahusiana na URL hii ya msingi. Maombi lazima yajumuishe ufunguo halali wa API au tokeni ya JWT.

Anza Haraka

curl -X GET https://beecastly.com/api/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_TENANT_ID" \
  -H "Content-Type: application/json"

Uthibitishaji

Maombi yote yanahitaji uthibitishaji kupitia mojawapo ya:

Ufunguo wa API - Pasi katika Uidhinishaji: Mbeba kichwa cha YOU_API_KEY
Ishara ya JWT - Imepatikana kutoka kwa POST /auth/login

Zaidi ya hayo, jumuisha kitambulisho chako cha mpangaji: x-tenant-id: YOUR_TENANT_ID

Tazama mwongozo kamili wa uthibitishaji →

Vipimo vya API

Uthibitishaji

Ingia, sajili, funguo za API, tokeni za JWT

Anwani

Operesheni za CRUD, vitambulisho, sehemu, sehemu maalum

Ujumbe

Tuma WhatsApp, Barua pepe, SMS. Leta mazungumzo

Kampeni

Unda, ratibu na ufuatilie kampeni

Viboko vya mtandao

Usajili wa hafla, upakiaji, uthibitishaji

Vijibu

Vipindi vya bot ya AI, ujumbe, na data ya mafunzo

Umbizo la Majibu

Majibu yote yanafuata umbizo thabiti la JSON:

// Success
{
  "success": true,
  "data": { ... }
}

// Error
{
  "success": false,
  "error": "Error message description"
}

Vikomo vya Viwango

Kiwango cha bure: Maombi 100 kwa dakika

Kiwango cha Pro: Maombi 1,000 kwa dakika

Biashara: Vikomo maalum

Vijajuu vya kikomo cha viwango vinajumuishwa katika kila jibu: X-RateLimit-Remaining