Search our Help.

  1. Unleashed Support
  2. Integrations
  3. Unleashed API

Unleashed API Access

Follow

Page Contents:

Points to Note

API Usage

Buying Additional API Usage Bundles

FAQs

To access the Unleashed API page, go to Integration | Unleashed API Access.

Only the account owner can access and view the Unleashed API Access page.

For a full breakdown of all the available endpoints and resources available with Unleashed's API see our API Docs here: https://apidocs.unleashedsoftware.com/ 

Points to Note

  • The Unleashed API Access page provides the credentials needed to connect through our API to your Unleashed account. It gives you the "API ID" and "Key" needed to connect your 3rd party integration too Unleashed.
  • It is recommend to only share your account's API ID and Key with trusted 3rd parties. Unleashed is not able to block a 3rd party from connecting to your account through the API if your account's credentials have been shared with them.
  • As the API connections are created by 3rd parties, all questions relating to the functioning of these connections need to be directed to your third party or it's connection's developer.
  • We recommend all API requests always provide a "client-type" in order for us to help provide you with API support and usage stats. The client-type value must follow the convention partner_name/app_name or Accountname/app_name. For additional information please see our API Authentication Documentation.

API Usage

An "API call" with Unleashed is defined as any request sent from or received by an Unleashed account via a third-party API connection. An account's "API Usage" measures how many API calls are made within a one month period for an individual Unleashed account. 

Each Unleashed account has a base limit to the number of API calls that can be used per month. If the API Usage reaches the account's limit, no further API calls can be made for the Unleashed account until either:

  • The API Usage refreshes on the first of the following month.
  • An "API Extra Usage Bundle" has been added to the account, via the Billing page. 

To view an account's current API Usage and limits, the Account Owner can navigate to Integration, Unleashed API Access.

The following platform integrations do not contribute towards an Unleashed account's API Usage:
  • Prospect CRM
  • Mintsoft
  • Xero
  • Quickbooks
  • Magento
  • Lightspeed
  • Salesforce Connector
  • eCommerce Hub: Shopify
  • eCommerce Hub: Amazon
  • eCommerce Hub: WooCommerce

Additional API Usage Bundles

The following table details the API base usage limits and the additional bundle limits available per subscription plan.
 
  MEDIUM LARGE LARGE PLUS
API Monthly Base Calls 125,000 included 250,000 included

500,000 included
API Extra Usage Bundle - extra monthly calls 125,000 250,000

500,000

If you're reaching your API's base call limit, you can add one API bundle via your account's Billing page. 

  1. Go to Settings | Billing.
  2. Next to Products, select Modify. 
  3. In the Extra API Bundle tile, select Add. For more details on the Bundle, select the Learn More link in the tile. 
  4. Under the Billing summary on the right of your screen, select Update.
  5. You then will be required to accept Unleashed's Terms & Conditions in a pop-up.
  6. Click Upgrade.

NOTE: The Extra API Bundle is a subscription based module and as such will automatically renew in line with your base subscription's monthly renewal unless it's removed from your account via the Billing page. 

FAQs

Where do I find the API ID and Key?

To locate your Unleashed account's "API ID" and "Key":

  1. Log in to Unleashed as the Account Owner and from the main menu go to "Integration".
  2. Click on "Unleashed API Access".
  3. The Unleashed account's unique "API ID" and "Key" will be available to view and copy. 

NOTE: Only the Account Owner will be able to view and access the "Unleashed API Access" page. For more details, see Account Owner, Superusers and Partners in Unleashed

Can we refresh the API ID or Key?

There is no way of changing or refreshing the API Key and ID for Unleashed accounts. 

Our developers suggest that the best practice is always to create a Sandbox account and ask your 3rd party developer to work on them instead of your live account. Once the development work is done, you can then apply the live account API key for the integration ensuring it is never shared with the 3rd party developer. 

For details more details on Sandboxes, see Using the Sandbox.

Does the Sandbox have its Own API ID and Key?

The Sandbox account has its own unique API ID and Key. When logged in to the Sandbox account, you can find it under Integration > Unleashed API access. This allows you to integrate the Sandbox account to an integration and not to your Live account. Any updates made to your Sandbox account will not sync to your Live account and vice versa. 

Why am I getting a 403 error from an API call?

A 403 error in the API means that the authentication signature posted with your query or call is incorrect and needs to be generated again. A 403 error response is triggered if one of the following statements is true:

  • If authentication signature (auth-signature) is generated incorrectly.
  • If the API ID and Key used to generate the auth-signature does not match the Unleashed account's API ID and Key.

For a full breakdown on the requirements for generating a successful API call, see API Documentation: Authentication.

Tip: You will need to create a unique auth-signature for each unique call that you are trying to run. For instance, we cannot use the same auth-signature for: https://api.unleashedsoftware.com/v2/StockOnHand?ProductCode=BOOKSHELF as we use for: https://api.unleashedsoftware.com/v2/StockOnHand.

Was this article helpful?
2 out of 3 found this helpful