Authenticate
Given a valid Vendor login, this route returns an access token authenticating you for data retrieval. Tokens are good for three days from generation. Note that all credentials for an organization are not created equal as what data you can retrieve is tied to the credentials permissions within that organization.
| Verb | POST |
|---|---|
| Endpoint | {base-url}/authenticate/ |
| Max Page Size | N/A |
Request Body
{
"username": "me@domain.tld",
"password": "password"
}
Returns
On Success
An object containing your access token.
Response Body
Response Body
{
"accessToken": "9f57c00f-a92d-49e5-86fd-0052b56e0161",
"userName": "me@domain.com",
"issued": "9/3/2020 11:17:40 PM",
"expires": "9/6/2020 11:17:40 PM"
}
On Error
| HTTP Code | Error Code | Definition |
|---|---|---|
| 403 | INVALID_LOGIN | Your username or password was incorrect. |