Welcome to the Tamio API
Our API is designed to assist developers globally in incorporating eCommerce functionalities into their business workflows, expanding customer reach, and automating processes. With a straightforward API Key, you gain access to a comprehensive suite of API resources spanning the eCommerce landscape.
To support you in troubleshooting potential challenges during integration, we provide a Developer's Dashboard featuring a Log Browsing Interface. This tool offers a detailed analysis of requests, received responses, and the timeline of each event.
Furthermore, we provide Webhooks for over 50 events, enabling you to leverage data within your application and establish connections to third-party software.
Transactions
An agile and robust headless eCommerce API, Tamio Transactions possess the power and flexibility to cater to diverse business requirements.
Products
The Tamio platform offers a robust and versatile product management solution, tailored to cater to a multitude of businesses.
Customers
A customer denotes an individual who has engaged with your business through various touchpoints such as checkout or API.
Whitelabel
Launch your very own eCommerce platform with our Whitelabel Program. We have all the tools to manage and bill clients.
Affiliates
An API for managing partners that have onboarded your affiliate programs.
Tamio provides an array of billing tools to manage recurring payments, in multiple currencies and payment gateways.
Discounts
Use discounts to curtail the amount levied on an order or recurring subscription. Tamio offers a high degree of flexibility with discounts, allowing them to be tailored to suit any business needs.
Invoices
Invoices, representing the transactional records of purchases made by customers, are automatically generated either when a customer completes an order through the checkout flow.
Webhooks
With more than 50 events available, Tamio Webhooks are an integral part of the API, enabling developers to utilise data in their apps and connect to third-party software.
Assets
The Assets API offered by Tamio presents a cost-effective and efficient solution for storing and disseminating files.
Teammates
Streamline your business operations by inviting your team members to collaborate on your Tamio activities.
Shippings
Shipping rates within the Tamio API delineate the costs associated with delivering physical products to your customers.
Leads
Leads, attached to Customers, are essential for lead management processes or sales conversion flows.
Warehouses
In the realm of Tamio, a warehouse signifies a physical location of your business that dispatches products to your customers.
Addresses
Addresses are crucial components linked with Customers, aiding in the creation of multiple billing profiles for individual customers.
Taxes
Tamio offers a comprehensive tax management module, providing both automated and manual tax rate configurations.
The exchange rates API provides access to currency conversion tools and exchange rates for all supported Tamio currencies.
Reviews
The Reviews API offers access to all the testimonials collected from your customers.
To start using the API, you need to generate a developer key. In Tamio, there are two types of keys; publishable and secret. Secret keys have access to all API resources (minus Transactions) and should not be shared publicly.
Publishable keys have access to the Transactions API. They can be shared inside your application and with the Tamio JS library for building custom checkout flows.
You can find your keys in the developer portal inside your dashboard.
- Login to your account at tamio.com
- Visit the developers section and browse the API Keys tab.
- Click the Create key button on the top right.
To use the API keys, include them in the Authorization header of your requests using the following format: Bearer your-api-key-here.
You have the ability to generate secret keys possessing specific permissions, allowing access to designated API resources. Enhancing flexibility, these permissions can be granulated to individual resource levels. This implies that keys with access limited to specific customers or products can be created.
To assist with debugging during the integration phase, the Developer's Dashboard features a Log Browsing Interface. This tool provides a comprehensive overview of requests, received responses, and the respective timing of each event.
The Tamio API is organised around REST and provides standardised HTTP response codes.
Status | Description |
|---|---|
200 | The request was successful. |
301/302 | The route has moved. |
400 | The request was received, but it's invalid. |
401 | There was an authentication error. |
403 | There was an authentication error, or you do not have the required permissions to complete the action. |
404 | The route was not found. |
500+ | There was an error on our end. Please wait for some time before retrying the request. |
While integrating the API, some of your requests might fail with status 400. This means that the request was received, but it's invalid. The response provides error clarifications to see why a failed request is invalid.
Error messages and warnings are in English. The text is not standardised and might change in the future. Please do not rely on it for triggering functionality in your application.
Rate limiting is a crucial aspect of ensuring the stability and reliability of the Tamio API for all users. By imposing limits on the number of requests that can be made within a certain timeframe, we can prevent any single user or application from overloading our servers, thus maintaining a smooth and responsive experience for everyone.
When the Tamio API's rate limit is exceeded, the API responds with a 429 status code, indicating that too many requests have been sent in a given amount of time. This response is a signal for users to reduce their request volume and wait before sending more requests.
Strategies to Handle Rate Limiting:
- Monitor Your Requests: Keep track of the number of requests your application is making to ensure it stays within the API's rate limits.
- Implement Retry Logic: In case of a 429 response, implement a retry mechanism with exponential backoff. This means waiting for a specified amount of time before retrying the request, and if necessary, increasing the wait time with each retry.
- Use batch methods when possible: Some of the most crucial methods can be batched, so try and use them when possible.
Understanding and respecting the rate limiting policies of the Tamio API is essential for developing applications that are both efficient and respectful of shared web resources. By adhering to these guidelines, you can help ensure a positive experience for all users of the Tamio platform.
Did you find a bug, documentation error or requirements outside the API's scope? Let us know at [email protected].