POST /keys/{keyName}/requestToken
This is the means by which clients obtain access tokens to use the service. You can see how to construct an Ably TokenRequest in the Ably TokenRequest spec documentation, although we recommend you use an Ably SDK rather to create a TokenRequest, as the construction of a TokenRequest is complex. The resulting token response object contains the token properties as defined in Ably TokenRequest spec. Authentication is not required if using a Signed TokenRequest.
Servers
- https://rest.ably.io
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyName |
String | Yes |
The key name comprises of the app ID and key ID of an API key. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
X-Ably-Version |
String | No |
The version of the API you wish to use. |
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
format |
String | No |
The response format you would like Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.