GET /authentication_token

Requests an authentication token for the specified user account. Credentials can either be passed in the HTTP Authorization header (in the format "user username:password") or via the "username" and "password" query string parameters.

Note: This call is not rate-limited. The "username" and "password" query string parameters are supported to facilitate the acquisition of an authentication token using a web browser. Applications should either pass the authentication credentials in the HTTP Authorization header or make use of the POST authentication_credentials call to avoid passing credentials in the query string.

Parameters

username

(required)

Specifies the username of the user account requesting an authentication token.

password

(required)

Specifies the password.

callback

(optional)

Only available for JSON format. If supplied, the response will use JSONP format with a callback of the given name.

Request Content Type

N/A

Response

Returns an authentication token if authentication succeeds. The client application should store the authentication token and submit it with subsequent API calls. The authentication token expires 30 minutes after it is last used. Returns '401 Unauthorized' and an error message if authentication fails.

Response Content Type

application/json, application/javascript (JSONP), application/xml or text/csv as requested

Give It A Try...

Enter appropriate parameter values then click on the link which appears to try the API call...

Note: You must have JavaScript support enabled in your browser to use this feature.

username

(required)

password

(required)

callback

(optional)

Response format

 

Request Examples

GET /authentication_token?username=me&password=my_password
GET /authentication_token.json?username=me&password=my_password
GET /authentication_token.xml?username=me&password=my_password
GET /authentication_token.csv?username=me&password=my_password

Response Examples

JSON body:

"722fa0c702f42b68e2fdb771a80caed"

XML body:

<?xml version="1.0"?>
<string>722fa0c702f42b68e2fdb771a80caed</string>

CSV body:

722fa0c702f42b68e2fdb771a80caed