Dokumentacja API

Zintegruj WhatsApp, SMS i Email w minuty

Proste, udokumentowane, gotowe do produkcji REST API v4. Auth JWT, webhooki, wysylanie masowe i wiele wiecej.

  • Bezpieczne uwierzytelnianie JWT Bearer
  • Webhooki w czasie rzeczywistym dla wszystkich zdarzen
  • Darmowy sandbox, karta kredytowa nie wymagana
  • Kompletna dokumentacja OpenAPI 3.0
Szybki start

Zintegruj w 3 krokach

Od zera do wyslanych wiadomosci w mniej niz 10 minut.

1

Pobierz token

Wywolaj endpoint uwierzytelniania ze swoimi danymi, aby uzyskac token JWT uzywany we wszystkich kolejnych zadaniach.

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

Wyslij pierwsza wiadomosc

Uzyj tokenu w naglowku Authorization i wywolaj endpoint do wysylania wiadomosci WhatsApp, SMS lub Email.

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

Odbieraj zdarzenia

Skonfiguruj webhook, aby odbierac przychodzace wiadomosci, potwierdzenia dostarczenia i aktualizacje statusu w czasie rzeczywistym.

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

Uwierzytelnianie JWT Bearer

Wszystkie API Chat API uzywaja tokenow JWT. Wygeneruj token jednym wywolaniem POST i dolacz go do naglowka Authorization kazdego zadania.

Konfigurowalne wygasanie

Tokeny wygasaja po konfigurowalnym czasie. Regeneruj automatycznie przez API bez przerwy.

HTTPS wymagane

Cala komunikacja odbywa sie przez HTTPS z TLS 1.2+. Brak akceptacji niezszyfrowanych wywolan.

Bezpieczne dane uwierzytelniajace

Nazwa uzytkownika i haslo sa wymieniane tylko raz, aby uzyskac token uzywany w wywolaniach API.

POST /api/v4/auth/token
{
  "username": "your@email.com",
  "password": "your-password"
}
200 OK Response
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
  "expiresIn": 3600,
  "type": "Bearer"
}
Uzyj tokenu w kazdym zadaniu
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
Endpointy

Wszystkie dostepne endpointy

Kazdy endpoint jest udokumentowany z parametrami, odpowiedziami i przykladami w naszej dokumentacji OpenAPI.

WhatsApp
POST

Wyslij wiadomosc

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

Wyslij bezposrednia wiadomosc WhatsApp

GET

Lista szablonow

/api/v4/notifications/whatsapp/templates

Przegladaj zatwierdzone szablony WhatsApp

POST

Powiadomienie szablonowe

/api/v4/whatsapp/notifications

Wyslij indywidualne powiadomienie poza oknem 24h

POST

Wysylanie masowe

/api/v4/whatsapp/bulk

Wysylaj do tysiecy kontaktow w jednej partii

SMS
POST

Wyslij SMS

/api/v4/sms/send

Wyslij SMS na dowolny numer na swiecie

POST

Kampania SMS

/api/v4/sms/bulk

Masowe wysylanie do list kontaktow

GET

Raport dostarczenia

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

Sprawdz status dostarczenia

Email
POST

Wyslij email

/api/v4/email/send

Email transakcyjny z DKIM/SPF

POST

Kampania email

/api/v4/email/bulk

Masowe wysylanie kampanii marketingowych

GET

Zdarzenia email

/api/v4/email/events

Wskaznik otwarcia, klikniecia, odrzucenia, rezygnacje z subskrypcji

System
POST

Uwierzytelnianie

/api/v4/auth/token

Generuj token JWT Bearer

POST

Webhooki

/api/v4/webhooks/create

Konfiguruj odbieranie zdarzen w czasie rzeczywistym

POST

Widget czatu

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

Generuj iframe dla czatu WhatsApp

Przyklady kodu

Integruj w swoim jezyku

Gotowe do uzycia przyklady do uwierzytelnienia i wyslania pierwszej wiadomosci.

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!" })
});
Srodowiska

Sandbox i produkcja

Testuj dowolnie w srodowisku sandbox bez kosztow, a nastepnie przelacz na produkcje jednorazowa zmiana URL. Zero refaktoryzacji.

Darmowy sandbox

Brak zuzycia kredytow. Symulowane wiadomosci. Nieograniczone testowanie bez dodatkowej konfiguracji.

Skalowalna produkcja

Infrastruktura enterprise z SLA 99,9% i dedykowanym wsparciem technicznym.

Natychmiastowe przelaczanie

Zmien tylko bazowy URL, aby przejsc z sandboxa na produkcje. Ten sam kod, ta sama umowa API.

Sandbox

Bazowy URL

https://sandbox.roxpay.eu

✓ Symulowane wiadomosci  ·  ✓ Bez kosztow  ·  ✓ Dane testowe

Produkcja

Bazowy URL

https://app.roxpay.eu

✓ Prawdziwe wiadomosci  ·  ✓ SLA 99,9%  ·  ✓ Dedykowane wsparcie

OpenAPI 3.0 - Swagger UI

Pelna dokumentacja dostepna

Wszystkie parametry, schematy odpowiedzi, kody bledow i interaktywne przyklady w interfejsie Swagger.