Token: Get

Generates a unique, self-expiring time token that can be used to authenticate a series of API calls performed by a user within a given time frame.

Headers

The data to be submitted to the API is composed of the following fields:

NOTE:

• Headers: the user_api_key value can be included in either the header section or the body of the request. If the key is provided in both locations, the API will process and validate only the value provided in the headers.

• The token_interval is optional. It is a limit on the validity of the token, in seconds. If not given, it will default to 60 seconds. This means the token will no longer be valid after that time interval (ie: will result in an error when the "Token - Validate" API call is made to validate it.)

Example PHP Request:

If you are using PHP, the $data array would look like this:

1. $data['API'] = '1.5';
2. $data['user_id'] = 'john1970';
3. $data['user_api_key'] = '1959caadac9b13dcb3';
4. $data['account_id'] = 'greatwidgets';
5. $data['type'] = 'generate_time_token';
6. $data['token_interval'] = '86400';

Success XML Response:

1. <response status="success">
2. <token>CHFBTABPGWGBRLCKETCKGDDKEAFFBBFBETTI</token>
3. </response>

Error XML Response:

1. <response status="error">
2. <error>Error message</error>
3. </response>