Basic Auth

Danger

Important: We no longer support HTTP Basic Auth. Switch to OAuth 2.0 or Personal Access Tokens.

We keep this page for legacy implementations.

Note: Basic Auth only works for the account that issued your app key. It won’t let other people authenticate in your app. To access data from other accounts, you must use OAuth 2.

The API supported Basic Auth with your account username and password plus your client_key, which you get when you create an API client.

Send the client_key in the X-Client-Key header. If your platform or client makes custom headers hard to add, send it in the client_key=KEY query string parameter instead.

Authentication Errors

The API can return these errors when it can’t authenticate a request.

Bad Credentials

HTTP 401 Authorization Required

{
  "status": 401,
  "message": "Could not authenticate: rob@fobsdirect.com",
  "additional": "",
  "reference": ""
}

No API Access - Locked Account

You’ll get this when an account is suspended because of a billing issue:

HTTP 403 FORBIDDEN

{
    "status": 403,
    "message": "No API Access",
    "additional": "The authenticated account is locked due to an unpaid balance."
}

You can show the user a direct link to make a payment: https://appfigures.com/account/billing

API Access Is Disabled

You’ll get this when a user is suspended for violating the API terms:

HTTP 403 FORBIDDEN

{
    "status": 403,
    "message": "API Access is disabled",
    "additional": "API access has been disabled for this user due to API terms violation."
}

To resolve a terms violation, contact us.

No App Key Given

HTTP 400 Bad Request

{
  "status": 400,
  "message": "Must give an app key via X-Client-Key header or client_key query string parameter",
  "additional": "",
  "reference": ""
}