REST API

REST programming

The Swagger documentation is available at: https://turtlequeue.com/api/swagger/swagger/index.html?url=/api/swagger/swagger.json This is generated automatically from the swagger 2.0 specification at https://turtlequeue.com/api/swagger/swagger.json

Authenticate

In order to use the swagger API interface you need to authenticate. Find your UserToken and ApiKey in https://turtlequeue.com/dashboard/security

Then authenticate, in the swagger UI.

First, click on the authenticate button of the method you want to use. For instance, "POST publish". See screenshots below:

swagger authenticate need login

This will give you a popup, which allows you to put you ApiKey and UserToken:

Auth popup screenshot

Once done, you should be able to use the swagger UI to make requests and generate sample cUrl commands.

swagger authenticate publish ok

Publish

For the POST Publish method, a minimal set of data would be:

{"channel": "test", "payload": "some data"}
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'ApiKey: YOUR_API_KEY' --header 'UserToken: YOUR_USER_TOKEN' -d '{"channel": "test", "payload": "some data"}' 'http://turtlequeue.com/api/publish'