Looking for the Unleashed API documentation page?
Access it here: https://apidocs.unleashedsoftware.com/
What is an API?
An application programme interface (API) is a set of functions and procedures that allow the creation of applications which access the features or data of another operating system, application, or service. In other words, an API defines how software components should interact. A good API provides the building blocks of developing a program for the programmer.
As a web user, you encounter APIs all the time! For instance, Google Maps APIs lets developers embed Google Maps on webpages. Websites such as Yelp will display a Google Map to help you locate the restaurant. From a user perspective, APIs allow you to complete an action without leaving the website.
API calls
Each time users make a call to a server in the name of an application using the API, it is counted as an API call, also known as an API request. Simply put, an API call is when an API is requested to get data from another application. You might be making more API requests than you realise - logins, saves, and queries are some examples of API requests.
API usage with Unleashed Software
In Unleashed, API Usage is measured as the number of calls made to the Unleashed API. Depending on your subscription plan, there are limits to the number of calls you can make from Unleashed. An API call is any request sent or response received from the API, so if the API call fails, it won’t be counted.
Additionally, there are some events that do not increase your API call count, for instance:
- Webhook Events: Deliveries of webhook events initiated by Unleashed do not count toward your API usage. These events are automatically excluded as they are initiated by Unleashed, not your application.
- Native integrations: Data and transactions that sync between Unleashed and ecommerce platforms; Shopify, Amazon or WooCommerce, and the native integrations to Xero, Quickbooks, Access Financials, Lightspeed or couriers via the Advanced Shipping module, will be excluded from API Usage.
Check out the Unleashed Pricing page to see how many API calls are included in each pricing tier.
Custom integrations
To understand how custom integrations work with Unleashed, let’s consider a business that has implemented a custom integration between Unleashed and Wink Reports, a reporting software.
If the business wants to find out their sales revenue for the month of July on Wink Reports, then Wink Reports will need to request sales order data from Unleashed. As this is a custom integration, it counts under API calls.
We recommend that businesses looking to integrate systems to Unleashed with a custom integration enlist the help of their IT integrator or get in touch with an Implementation Partner in order to set up the integration.
Unleashed managed integrations
Unleashed builds and manages some integrations, otherwise known as ‘native integrations’. This includes integrations with Xero, Quickbooks Online, Lightspeed, Shopify, Amazon and WooCommerce. Any API calls from these managed integrations will not count towards your API usage. Visit our app marketplace to view our native integrations.
Where to find API information for Unleashed?
Access a step-by-step guide to obtaining your API key in Unleashed, visit: https://apidocs.unleashedsoftware.com/
