Syntax

Get token

POST /token

Description

This API endpoint returns the authentication token that is used in all other API requests.

Parameters

Type	Name	Description	Schema	Default
Header	Authorization optional	This is the authorization token that must be provided in the header of all requests except this one.	string	""
Header	Et-App-Key required	This is your app’s unique key that can be retrieved from the BO Companies widget in Autoshares Trader.	string
Header	Password optional	The password of the user on whose behalf the authentication is being performed.	string	"testpassword"
Header	PinCode optional	This is the user’s pincode.	string	""
Header	Username optional	This is the name of the user on whose behalf the authentication is being performed.	string	"testusername"
Header	VerificationCode optional	This is the verification code sent by email or SMS (the second step of 2-FA).	string	""

Responses

HTTP Code	Description	Schema
200	The authentication is complete and the provided token can be used in other API requests.	No Content
202	Several authentication steps have been taken, but the server is expecting additional parameters (like the verification code). Use the token from the response and provide the required additional parameters to complete the authentication procedure.	No Content
401	The access level of the provided authorization token is not sufficient to perform this operation.	No Content

Produces

• State

• Step

• Reason

• Token

Example HTTP response

Response 200

{
  "State" : "Succeeded",
  "Token" : "VGhpcyBpcyBleGFtcGxlIHRva2Vu..."
}

Response 202

{
  "Step" : "SecutityPin",
  "Reason" : "Invalid pin",
  "State" : "Expecting",
  "Token" : "VGhpcyBpcyBleGFtcGxlIHRva2Vu...."
}

Response 401

{
  "State" : "Failed",
  "Step" : "SecutityPin",
  "Reason" : "Invalid pin"
}