API dokumentatsiya

Integrirajte WhatsApp, SMS i Email za minuti

Prosto, dokumentirano, gotovo za produkciya REST API v4. JWT auth, уебхукове, masovo изпращane i oshte.

  • Sigurna JWT Bearer autentifikatsiya
  • Уебхукове v realno vreme za vsichki sabytiya
  • Bezplaten sandbox, ne e neobkhodima kreditna karta
  • Palna OpenAPI 3.0 dokumentatsiya
Byarzo nachalo

Integrirajte v 3 stapki

Ot nula do изпратени saobshteniya за по-малко от 10 minuti.

1

Vzeмete token

Povikayte autentifikatsionniya endpoint s akreditatsionnite si dannni za да получите JWT token, izpolzvan v vsichki sledvashti zaявki.

POST /api/v4/auth/token
{"username":"...","password":"..."}
→ {"token": "eyJh..."}
2

Изпратете parvo saobshtenie

Izpolzvayte token v zaglavието Authorization i povikayte endpoint за изпращane na WhatsApp, SMS ili Email saobshteniya.

POST /whatsapp/chats/{id}/message
Authorization: Bearer <token>
→ {"status": "sent"}
3

Получавайте sabytiya

Настройте уебхук за получаване na vhodyashi saobshteniya, потвърждения na доставka i актуализации na status v realno vreme.

POST /api/v4/webhooks/create
"url": "https://your-app.com/hook"
→ {"status": "active"}
Sigurnost

JWT Bearer autentifikatsiya

Vsichki Chat API API izpolzvat JWT tokeni. Generirayte token s edno POST povikvane i go prilagayte kam zaglavието Authorization na vsяka zaяvka.

Konfiguriruemo изтичане

Tokenite изтичат след konfiguriruemo vreme. Regenerirayte avtomatichno chrez API bez prekasvanе.

HTTPS e neobkhodimo

Tsyalata komunikatsiya se izvarsshva chrez HTTPS s TLS 1.2+. Ne se priemat nekriptirани povikvaniя.

Sigurni akreditatsionni dannni

Потребителското ime i parolata se обменят само vedinaj за получаване na token, използван v API povikvaniята.

POST /api/v4/auth/token
{
  "username": "your@email.com",
  "password": "your-password"
}
200 OK Response
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
  "expiresIn": 3600,
  "type": "Bearer"
}
Izpolzvayte token v vsяka zaявka
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
Endpoints

Vsichki dostapni endpoints

Vseki endpoint e dokumentiran s parametri, skhemi na otgovori, kodove za greshki i primeri v OpenAPI dokumentatsiyata.

WhatsApp
POST

Izprashtane na saobshtenie

/api/v4/whatsapp/chats/{id}/message

Direktno WhatsApp saobshtenie

GET

Spasak na shabloni

/api/v4/notifications/whatsapp/templates

Preglezhdate odobreni WhatsApp shabloni

POST

Shablon uvedomlenie

/api/v4/whatsapp/notifications

Izprashtane na individualno uvedomlenie извън 24-chasoviya prozorec

POST

Masovo изпращane

/api/v4/whatsapp/bulk

Изпращайте do hilyadа kontakti v edin paket

SMS
POST

Изпращане na SMS

/api/v4/sms/send

Изпращайте SMS do vseki nomer v sveta

POST

SMS kampaniya

/api/v4/sms/bulk

Masovo изпращане do spasatsi na kontakti

GET

Otchet za dostavka

/api/v4/sms/reports/{id}

Проверete status na dostavka

Email
POST

Изпращane na email

/api/v4/email/send

Tranzaktsionen email s DKIM/SPF

POST

Email kampaniya

/api/v4/email/bulk

Masovo изпращane na marketingovi kampanii

GET

Email sabytiya

/api/v4/email/events

Koefitsient na otvarуane, кликвания, отскоки, отписвания

Sistema
POST

Autentifikatsiya

/api/v4/auth/token

Generirane na JWT Bearer token

POST

Уебхукове

/api/v4/webhooks/create

Konfigurirane na получаване na sabytiya v realno vreme

POST

Chat widget

/api/v4/iframes/whatsapp/chat-box

Generirane na iframe za WhatsApp chat

Primeri na kod

Integrirajte na vashiya ezik

Gotovi za izpolzvane primeri za autentifikatsiya i izprashtane na parvoto saobshtenie.

cURL
curl -X POST \
  https://app.roxpay.eu/api/v4/auth/token \
  -H "Content-Type: application/json" \
  -d '{"username":"...","password":"..."}'

# Use the token:
curl -X POST \
  .../whatsapp/chats/123/message \
  -H "Authorization: Bearer <token>" \
  -d '{"body":"Hello!"}'
Python
import requests

# Authentication
r = requests.post(
  "https://app.roxpay.eu/api/v4/auth/token",
  json={"username":"...", "password":"..."}
)
token = r.json()["token"]

# Send message
requests.post(
  "...whatsapp/chats/123/message",
  headers={"Authorization": f"Bearer {token}"},
  json={"body": "Hello!"}
)
Node.js
// Authentication
const r = await fetch(
  "https://app.roxpay.eu/api/v4/auth/token",
  { method: "POST",
    headers: {"Content-Type":"application/json"},
    body: JSON.stringify({username,password}) }
);
const { token } = await r.json();

// Send message
await fetch("...chats/123/message", {
  method: "POST",
  headers: { Authorization: `Bearer ${token}` },
  body: JSON.stringify({ body: "Hello!" })
});
Sredi

Sandbox i produkciya

Тествайте svobodno v sandbox sryadata bez razkhodi, след това преминете kam produkciya s edna promyana na URL. Nula refaktoring.

Bezplaten sandbox

Nyama izrazkhod na krediti. Simulirani saobshteniya. Neogranicheno testirane bez допalnitelna konfiguratsiya.

Мащабируema produkciya

Korporativna infrastruktura s 99.9% SLA i dedikirana tehnicheska podkrepa.

Мигновeno prevklyuchvane

Promenete samo bаzoviya URL за преминаване ot sandbox kam produkciya. Sashtiyat kod, sashtiyat API dogovor.

Sandbox

Bazov URL

https://sandbox.roxpay.eu

✓ Simulirani saobshteniya  ·  ✓ Bez razkhodi  ·  ✓ Testovi dannni

Produkciya

Bazov URL

https://app.roxpay.eu

✓ Реalni saobshteniya  ·  ✓ 99.9% SLA  ·  ✓ Dedikirana podkrepa

OpenAPI 3.0 - Swagger UI

Palna dokumentatsiya dostapna

Vsichki parametri, skhemi na otgovori, kodove za greshki i interaktivni primeri v Swagger interfeysa.