Business Reporting API Specification

Business Reporting API

authentication

This section includes functions to create, refresh, and expire a JSON Web Token (JWT) that can be used with the Authorization header to authorize requests.

Authentication

post /auth

This endpoint will return a JSON Web Token (JWT) that should be used with the Authorization header when sending requests that require authorization.

Request Schema

mid required

string

Example:

9999999999999

developerKey required

string

password required

string

Example Request

{
  "mid": "<MID>",
  "developerKey": "<DEVELOPER_KEY>",
  "password": "<DEVELOPER_PASSWORD>"
}

Example Response

200 Request Authorized

400 Invalid Post Data

404 Unauthorized Request

Refresh Session

post /auth/refreshSession

This endpoint takes a previously-authorized JWT and creates a new JWT with an extended expiration date. Data stored within the token will stay the same and the user will still have access to the endpoints. To use this function, send a valid JWT through the Authorization header and replace your stored JWT with the token response upon success. This endpoint can only refresh valid JWTs signed by this application. Invalid or expired JWTs are unauthorized and will return as such.

Example Response

200 Valid Token

401 Unauthorized

End Session

get /auth/expireToken

This endpoint logs out of and expires a JWT. This requires a previously-authorized JWT. See the /auth endpoint for more information on obtaining a JWT.

Example Response

200 Request Authorized

401 Unauthorized