Note: This is a highly technical guide webpage. Therefore, we recommend involving your IT department when reading this. Should you have any inquiries or requests, please contact us through support@azumuta.com - we'd be happy to assist you.
Our REST API uses standard HTTP response codes and verbs. When making a normal GET-request, the data is returned as JSON-encoded responses.
Authentication
The Azumuta API uses API keys to authenticate requests. You can view and manage your API keys in the devices list.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Note: Your API keys are a top-secret information that should never be shared to anyone outside of your company.
How to Access API Documentation
The Azumuta REST API is documented in our API docs, which are accessible in the Azumuta platform. Here’s how to access it:
- Click on the question mark on the top right section of your screen.
- Click on “API docs”.
There, you can access all API documentation from all Azumuta modules & add-ons (except Dashboards).
There are two main functions for having access to API documentation:
- You can find clear documentation on how the connection works between external systems/software and Azumuta in terms of core resources. For example, how to create, delete, and update your product orders via API.
- When you are authenticated, you can live-test triggers via the “Try it out” button (indicated on the image below) in the API docs and see the result in your Azumuta platform.