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 для входящих» блогы.
