Ҳуҷҷатгузории API

Аутентификатсия

Калидро дар Developer → API keys созед ва ҳамчун bearer token фиристед. Калид сирри сервер аст: онро ҳеҷ гоҳ ба JavaScript-и браузер ё барномаи мобилӣ нагузоред.

Authorization: Bearer cv_live_xxxxxxxxxxxx

Калиди cv_test_ тамоми равандро иҷро мекунад, вале ба SIM ва паёмрасонҳо даст намерасонад, бинобар ин метавонед бе сарфи кредит пайваст шавед. Калидҳои sms_, ки то ChatVendor 2.0 дода шудаанд, кор карданро идома медиҳанд.

Scope-ҳо

Ҳар калид scope-ҳо дорад, ҳар эндпоинт scope-и лозимаро нишон медиҳад. Эндпоинтҳои паёмрасонҳо инчунин нақшаи дорои API-ро талаб мекунанд.

Формати ҷавоб

Base URL https://chatvendor.net/api/v1. Ҳар ҷавоб JSON бо нишони success аст. Рӯйхатҳо объекти meta бо саҳифабандӣ доранд. Хатоҳо ҳамеша дар як формат меоянд: аз рӯи code қарор қабул кунед, на аз рӯи матни паём.

{
  "success": true,
  "data": { "id": "msg_01j…", "status": "queued" }
}

{
  "success": false,
  "error": { "code": "INVALID_API_KEY", "message": "…" }
}

Дархости аввалини шумо

1. 01

   Шабакаро пайваст кунед

   Барои SMS телефони Android-ро ҷуфт кунед ё аккаунти Telegram / WhatsApp / Instagram-ро пайваст кунед.

2. 02

   Калид созед

   Танҳо scope-ҳои лозимиро қайд кунед. Аз калиди тестӣ оғоз кунед.

3. 03

   Ба API дархост фиристед

   Рӯйхати шабакаҳоро гиред, баъд паём фиристед. Ду дархост дар поён аст.

curl https://chatvendor.net/api/v1/channels -H "Authorization: Bearer cv_live_xxxxxxxxxxxx"

curl -X POST https://chatvendor.net/api/v1/channels/1/dialogs/@username/messages \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx" -H "Content-Type: application/json" \
  -d '{"text": "Salom! Bu API orqali yuborildi."}'

curl -X POST https://chatvendor.net/api/v1/messages \
  -H "Authorization: Bearer cv_live_xxxxxxxxxxxx" -H "Content-Type: application/json" -H "Idempotency-Key: order-1234" \
  -d '{"to": "+998901234567", "message": "Your code is 483921"}'