Authentication
The API uses token based authentication to control access. All requests should include the token as a part of the Authorization
header. You can use the username
and password
provided to request the token.
Authentication ¶
Authentication ¶
Request API KeyPOST/auth/api-token-auth/
Request API token using your username
and password
. If you don’t have a username yet, please reach out to your account representative or contact us via any of the options on http://www.ivrtechgroup.com/contact.
Please ensure that the request parameters are URL encoded.
Note: You must login via the web portal first, at least once, to accept the Terms of Use. Once this is done, you can use the API to perform further actions.
Example URI
POST /auth/api-token-auth/
Request
Headers
Content-Type: application/x-www-form-urlencoded
Body
username=your%40email.here&password=your_password_here
Response
200
Headers
Content-Type: application/json
Body
{
"token": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b",
"client_id": "57bb010e2cd5264797b017e5"
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Your API token. Use this token to gain access to the API. It should be sent as a part of the `Authorization` header like so: `Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b`."
},
"client_id": {
"type": "string",
"description": "Your unique client ID which is required to access certain API endpoints."
}
}
}