Login

  • Domains
  • Post Tokens

Token

This method allows you to receive a token to authenticate calls.

Resource

  • Production environment: https://oauth.altravia.com/token/
  • Testing environment: https://test.oauth.altravia.com/token/

Parameters

Property name Type Description
username string Username with which you are registered with the service.
apikey string Apykey that has been assigned to you by the service.
scopes string Formula consisting of "method:domain/endpoint".

List of allowed scopes

Property name Type Formula
GET string GET:test.domains.altravia.com/domain
GET string GET:test.domains.altravia.com/contact
POST string POST:test.domains.altravia.com/domain
POST string POST:test.domains.altravia.com/contact
PUT string PUT:test.domains.altravia.com/domain
PUT string PUT:test.domains.altravia.com/contact
DELETE string DELETE:test.domains.altravia.com/domain
DELETE string DELETE:test.domains.altravia.com/contact

Parameters

Request examples

Response

Response Format

If successful, the response header HTTP status code will be 200 OK and the request will be answered.

If you try to get a request without authorization, you will receive an error 401 Unauthorized.

Additionally you should also handle the 400 Bad request status. For more info on HTTP status handling see dedicated section in Integration best practices page.

Request Response

Parameter Type Description
scopes array List of scopes related to the token.
expire int Token expiration time.
token string Token that will be used for requests.
success boolean True or false.
message string Contains error or success messages.
error int Contains the encoding of the error or NULL if successful.