Terug

API Documentatie

Pusher-compatibele REST API voor events, channels en users.

Inhoud

Authenticatie
Trigger Event
Batch Events
Get Channels
Get Channel Info
Get Channel Users
Terminate User Connections
Voorbeelden

Authenticatie

X-Api-Key: mps_your_api_key
X-Api-Secret: your_api_secret

Je kunt credentials ook als querystring meegeven:

?apiKey=your-api-key&apiSecret=your-api-secret

POST /apps/{appId}/events

Trigger een event op een channel of meerdere channels.

{
  "name": "my-event",
  "data": "{\"message\":\"Hello World\"}",
  "channels": ["test-channel", "another-channel"]
}

POST /apps/{appId}/batch_events

Stuur meerdere events in een enkele request.

{
  "batch": [
    { "name": "event1", "channel": "channel1", "data": "{\"key\":\"value\"}" },
    { "name": "event2", "channel": "channel2", "data": "{\"other\":\"data\"}" }
  ]
}

GET /apps/{appId}/channels

Vraag actieve channels op, optioneel met filter en info.

GET /apps/{appId}/channels/{channelName}

Vraag info op voor een specifiek channel.

{ "occupied": true, "user_count": 42, "subscription_count": 51 }

GET /apps/{appId}/channels/{channelName}/users

Voor presence channels kun je online users opvragen.

{ "users": [ { "id": "user1" }, { "id": "user2" } ] }

POST /apps/{appId}/users/{userId}/terminate_connections

Verbreek actief alle verbindingen van een specifieke user.

{}

Voorbeelden

cURL

curl -X POST "https://sps.skubber.com:5187/apps/myapp/events" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-api-key" \
  -H "X-Api-Secret: your-api-secret" \
  -d '{ "name": "my-event", "channels": ["test-channel"], "data": "{\"message\":\"Hello World\"}" }'