1Pick a language
2Credentials
3Try it!
Try It! to start a request and see the response here!Overview
The Awtomic API provides a powerful way for developers to integrate and interact with the Awtomic platform. This RESTful API supports JSON for request bodies and responses, making it a versatile tool for a range of applications. This guide will walk you through the process of getting started with the Awtomic API.
🔑 Accessing the API
All Standard Awtomic Plan’s have access to the API. If you're an Awtomic customer and haven't used the API before, you'll first need to find or create your API key.
Finding or Creating Your API Key
You can locate or create your API keys by following the instructions provided in our Authorization documentation.
In the event that you don't have access to the API and wish to use it, please contact us at [email protected].
⏱ Understanding Rate Limiting
Our API implements rate limiting to ensure fair use and prevent abuse. The standard rate limit is 100 requests per second and a total of 10,000 requests per day.
However, for our Enterprise customers, we understand that these limits may not be sufficient. In such cases, we're prepared to work with you to increase these rate limits to meet your business needs.
⚙️ Using the API Reference Tool
Our API reference tool is an invaluable resource for testing and understanding the API's various endpoints. To use this tool, click the login button in the top right navigation bar. This will redirect you to Shopify for authentication. Once authenticated, we'll pull in your API tokens, and you can easily test any of the available endpoints.
📊 Viewing and Sharing API Logs
In order to assist you with troubleshooting, our API reference tool allows you to view the recent logs from your API requests. If you encounter any issues or difficulties, these logs can be shared with our support team to help resolve your concerns more efficiently.
That's it for the basics! You're now ready to start exploring the Awtomic API. We recommend familiarizing yourself with the available endpoints next. For more detailed information, please refer to the specific sections of our API documentation.
Remember, our support team is always here to help. If you encounter any difficulties or have any questions, don't hesitate to reach out to [email protected].