Authenticate
PEAK Connect Authenticate is used to retrieve an access token for use in subsequent requests. This is an HTTP GET resource that accepts username and password credentials.
Usernames and password will be provided to you by PEAK Connect support.
PEAK Connect URLs and Content Types
Resource URL
QA
http(s)://qa-connect.ascentgl.com/v1/authenticate.{xml,json}?username=&password=
Production
http(s)://connect.ascentgl.com/v1/authenticate.{xml,json}?username=&password= JSON Response
{
“accessToken”: ”str1234″,
“expiresIn”: ”86400″,
“issued”: ”2012-12-13T12:12:12″,
“expires”:”2012-12-14T12:12:12″
}
Authenticate Response Properties
| Property Name | Data Type | Definition |
|---|---|---|
| accessToken | String | User access token to be used in subsequent calls to the PEAK Connect API |
| issued | String | Timestamp when the accessToken was first issued, formatted as yyyyMMddThh:mm:ss |
| expires | String | Timestamp when the accessToken will expire, formatted as yyyyMMddThh:mm:ss |
| expiresIn | Long Integer | Number of seconds for which the accessToken is valid, starting from the issued timestamp |
XML Response
<?xml version=”1.0″ encoding=”utf-8″?> <AuthenticationResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns=”AuthenticationResponse”> <accessToken>str1234</accessToken> <expiresIn>86400</expiresIn> <issued>2012-12-13T12:12:12</issued> <expires>2012-12-14T12:12:12</expires> </AuthenticationResponse>
Authenticate Response Properties
| Property Name | Data Type | Definition |
|---|---|---|
| accessToken | String | User access token to be used in subsequent calls to the PEAK Connect API |
| issued | String | Timestamp when the accessToken was first issued, formatted as yyyyMMddThh:mm:ss |
| expires | String | Timestamp when the accessToken will expire, formatted as yyyyMMddThh:mm:ss |
| expiresIn | Long Integer | Number of seconds for which the accessToken is valid, starting from the issued timestamp |