API'де авторизация
WazzaBee API'ге бардык суроо-талаптар Bearer-токен менен Authorization HTTP-аталышы аркылуу авторизацияланат. Токен — бул API коннекторун туташтырганда алган API-ачкычыңыз.
Аталыштын форматы
Authorization: Bearer ВАШ_API_КЛЮЧ
Негизги URL
https://api.wazzabee.com/api-gateway
Бардык эндпоинттер ушул негизги URL менен башталат. Мисалы, билдирүү жөнөтүү үчүн толук URL:
https://api.wazzabee.com/api-gateway/v1/messages/send
API-ачкычты кайдан алса болот
- WazzaBee жеке кабинетине кириңиз
- Каптал менюдагы Коннекторлор бөлүмүнө өтүңүз
- «API» карточкасын таап, «Туташтыруу» баскычын басыңыз
- API-ачкыч автоматтык түрдө түзүлүп, экранда көрсөтүлөт
- Ачкычты көчүрүп, ишенимдүү жерде сактаңыз
- API-ачкычты эч качан URL'де же суроо-талаптын параметрлеринде бербеңиз
- Ачкычты ачык репозиторийлерге (GitHub, GitLab ж.б.) жарыяламаңыз
- Ачкычты коддо эмес, чөйрө өзгөрмөлөрүндө сактаңыз
- Эгер ачкыч бөтөн колго түшүп калса, интеграцияны өчүрүп, жаңысын түзүңүз
Суроо-талаптын мисалы
curl -X GET "https://api.wazzabee.com/api-gateway/v1/channels" \
-H "Authorization: Bearer wac_live_sk_a1b2c3d4e5f6..."
Авторизация катасындагы жооп
Authorization аталышы жок (401)
{
"error": "Отсутствует заголовок Authorization. Формат: Bearer <api_key>"
}
Ачкычтын форматы туура эмес (401)
{
"error": "Неверный формат API-ключа"
}
Ачкыч системада табылган жок (401)
{
"error": "Неверный API-ключ"
}
Интеграция өчүрүлгөн (403)
{
"error": "Интеграция деактивирована"
}
Каналдарды интеграцияга байлоо
Ар бир интеграцияны белгилүү байланыш линияларына (каналдарга) байлоого болот. Бул API-ачкычтын жетүүсүн керектүү каналдар менен гана чектөөгө мүмкүндүк берет.
- Эгер жөндөөлөрдө каналдар көрсөтүлбөсө, API-ачкыч аккаунттун бардык каналдарына жете алат
- Эгер каналдар көрсөтүлсө, жетүү тизмедеги каналдарга гана болот
- Бөтөн каналга кайрылууга аракет кылганда
403катасы кайтат
Колдоого алынган HTTP-методдор
| Метод | Эндпоинт | Сүрөттөмө |
|---|---|---|
GET | /v1/channels | Каналдардын тизмеси |
POST | /v1/messages/send | Билдирүү жөнөтүү |
GET | /v1/messages | Билдирүүлөрдүн тарыхы |
PATCH | /v1/webhooks | Вебхукту жөндөө |
GET | /v1/webhooks | Вебхук жөндөөлөрүн алуу |
POST | /v1/iframe | iframe-сессия түзүү |
CORS
API'ге суроо-талаптарды өз сервериңизден да, браузерден да жөнөтсө болот. Браузер адегенде алдын ала OPTIONS суроо-талабын жөнөтөт, ал эми API жоопто браузер санап берген методго жана аталыштарга уруксат берет. Методду баш тамгалар менен жазыңыз: patch эмес, PATCH.
Барактын кодундагы API ачкычын ар бир келүүчү көрө алат, ошондуктан иштөөчү суроо-талаптарды өз сервериңизден жөнөткөнүңүз жакшы. Вебхукту кабинетте туташтыруу эң оңой: «Коннекторлор» → «API» → «Webhook для входящих» блогу.
