Getting Started With the API

Retrieve Access Token Endpoint

• URL
  • /api/v1/oauth/token
• Type
  • POST
• Content-Type
  • application/x-www-form-urlencoded
• POST params
  • grant_type
    • client_credentials
  • client_id
    • [client_id]
  • client_secret
    • [client_secret]
  • scope
    • public_api

Access Token Responses

On Success return bearer token (life time 4 hours):

{
    "access_token": "tokenStringHere",
    "expires_in": 14400, 
    "scope": "public_api", 
    "token_type": "Bearer" 
}

If an app is disabled, show error:

{
    "ErrorCode" : 401001,
    "Message"   : "The application is disabled"
}

If clientId/clientSecret pair wasn't found, show error:

{
    "ErrorCode" : 401002,
    "Message"   : "Invalid client_id and/or client_secret"
}

If site plan is less than Pro, show error:

{
    "ErrorCode" : 401003,
    "Message"   : "Public API is restricted for your site plan"
}

If scope is invalid, show error:

{
    "ErrorCode" : 401006,
    "Message"   : "Invalid Scope"
}

If grand_type is invalid, show error:

{
    "ErrorCode" : 401007,
    "Message"   : "Invalid Grant Type"
}

API Endpoint Token Errors

If any request doesn't contain access token or token can't be found in DB, show error:

{
    "ErrorCode" : 401000,
    "Message"   : "Invalid Access Token"
}

ElseIf any request contains access token but it has been expired, show error:

{
    "ErrorCode" : 401004,
    "Message"   : "Access Token expired"
}

ElseIf an app asociated with the access token is disabled, show error:

{
    "ErrorCode" : 401001,
    "Message"   : "The application is disabled"
}

ElseIf access token is revoked, show error:

{
    "ErrorCode" : 401005,
    "Message"   : "The Access Token has been revoked"
}