fbpx

Authentication

Data Concepts
March 2, 2018
Groups
March 4, 2018

This section provides an overview of how to authenticate with the Pay as you Track API.

Calls in this section:


Logging on

Necessary before any subsequent call to the API. Look for a return of “ok” and a GUID in the “ticketid”. Any previously allocated tickets for these login credentials will expired. This means you cannot use the same authentication details more than once.

Request (Query Parameters)
ParameterValueNotes
opAuthenticateRequired
subopLoginRequired
clientname{LEAVE BLANK}Required
username{email}Required
password{password}Required
Response
{
"version":"0.6"
,"reqId":"0"
,"status":"ok"
,"sig":"-685892104"
,"ticketid":"16E59D20-5FFF-4D9B-99D2-67C071E26483"
}

Logging out

This is not strictly necessary but good practice. Look for “ok” in the response. The authentication ticket will be immediately expired and cannot be reused.

Query Parameters
ParameterValueNotes
opAuthenticateRequired
subopLogoutRequired

*Optional Parameters

Response
{
"version":"0.6"
,"reqId":"0"
,"status":"ok"
,"sig":"-685892104"
,"value":""
}

Next: Data Concepts