API-documentatie

Integreer WhatsApp, SMS en e-mail in minuten

Eenvoudige, gedocumenteerde, productieklare REST API's v4. JWT Auth, webhooks, bulkverzending en veel meer.

  • Veilige JWT Bearer-authenticatie
  • Real-time webhooks voor alle evenementen
  • Gratis sandbox, geen creditcard vereist
  • Volledige OpenAPI 3.0-documentatie
Snel starten

Integreer in 3 stappen

Van nul tot verzonden berichten in minder dan 10 minuten.

1

Haal uw token op

Roep het authenticatie-endpoint aan met uw inloggegevens om een JWT-token te verkrijgen voor alle volgende verzoeken.

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

Stuur uw eerste bericht

Gebruik het token in de Authorization-header en roep het endpoint aan om een WhatsApp-, SMS- of e-mailbericht te sturen.

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

Ontvang evenementen

Configureer een webhook om inkomende berichten, bezorgbevestigingen en statusupdates in real-time te ontvangen.

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

JWT Bearer-authenticatie

Alle Chat API's gebruiken JWT-tokens. Genereer uw token met een enkele POST-aanroep en voeg het toe in de Authorization-header van elk verzoek.

Configureerbare vervaldatum

Tokens verlopen na een configureerbare periode. Automatisch regenereren via API zonder onderbreking.

HTTPS vereist

Alle communicatie vindt plaats via HTTPS met TLS 1.2+. Geen platte-tekstaanroepen geaccepteerd.

Veilige inloggegevens

Gebruikersnaam en wachtwoord worden slechts eenmaal uitgewisseld om het token te verkrijgen dat in API-aanroepen wordt gebruikt.

POST /api/v4/auth/token
{
  "username": "your@email.com",
  "password": "your-password"
}
200 OK Response
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...",
  "expiresIn": 3600,
  "type": "Bearer"
}
Gebruik het token in elk verzoek
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...
Endpoints

Alle beschikbare endpoints

Elk endpoint is gedocumenteerd met parameters, responses en voorbeelden in onze OpenAPI-documentatie.

WhatsApp
POST

Bericht sturen

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

Stuur een direct WhatsApp-bericht

GET

Sjablonen weergeven

/api/v4/notifications/whatsapp/templates

Bekijk goedgekeurde WhatsApp-sjablonen

POST

Sjabloonnotificatie

/api/v4/whatsapp/notifications

Stuur een één-op-één notificatie buiten het 24u-venster

POST

Bulkverzending

/api/v4/whatsapp/bulk

Stuur naar duizenden contacten in één batch

SMS
POST

SMS sturen

/api/v4/sms/send

Stuur een SMS naar elk nummer wereldwijd

POST

SMS-campagne

/api/v4/sms/bulk

Bulkverzending naar contactlijsten

GET

Bezorgrapport

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

Controleer de bezorgstatus

E-mail
POST

E-mail sturen

/api/v4/email/send

Transactionele e-mail met DKIM/SPF

POST

E-mailcampagne

/api/v4/email/bulk

Marketingcampagnes bulksgewijs sturen

GET

E-mailevenementen

/api/v4/email/events

Openingspercentage, kliks, bounces, uitschrijvingen

Systeem
POST

Authenticatie

/api/v4/auth/token

Genereer JWT Bearer-token

POST

Webhooks

/api/v4/webhooks/create

Configureer real-time evenementenontvangst

POST

Chat Widget

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

Genereer een iframe voor de WhatsApp-chat

Codevoorbeelden

Integreer in uw taal

Kant-en-klare voorbeelden om te authenticeren en uw eerste bericht te sturen.

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

Sandbox en productie

Test vrij in de sandboxomgeving zonder kosten, en schakel dan over naar productie met een enkele URL-wijziging. Nul refactoring.

Gratis sandbox

Geen credits verbruikt. Gesimuleerde berichten. Onbeperkt testen zonder extra configuratie.

Schaalbare productie

Enterprise-infrastructuur met 99,9% SLA en dedicated technische ondersteuning.

Directe omschakeling

Wijzig alleen de basis-URL om van sandbox naar productie te gaan. Zelfde code, zelfde API-contract.

Sandbox

Basis-URL

https://sandbox.roxpay.eu

✓ Gesimuleerde berichten  ·  ✓ Geen kosten  ·  ✓ Testgegevens

Productie

Basis-URL

https://app.roxpay.eu

✓ Echte berichten  ·  ✓ 99,9% SLA  ·  ✓ Dedicated ondersteuning

OpenAPI 3.0 · Swagger UI

Volledige documentatie beschikbaar

Alle parameters, responseschema's, foutcodes en interactieve voorbeelden in de Swagger-interface.