AntsRoute APIs allow you to automatically connect your tools (ERP, CRM, business software, e-commerce website, etc.) to the AntsRoute platform.
They are used to send your data to AntsRoute and retrieve tracking information, without any manual data entry.
💡 To access the full documentation, visit the dedicated AntsRoute APIs page on our website.
What are AntsRoute APIs used for?
The public AntsRoute API is designed to automate the management of your deliveries and routes.
With an API key, you can in particular:
-
Create, update, or delete:
- agents
- customers
- deliveries
- items
- parcels
- routes
- Synchronize your data between AntsRoute and your internal tools
- Track the progress of your deliveries in real time
☝️ Prerequisite to use the APIs: before getting started, make sure you have subscribed to at least the Essential plan.
How to generate your API key?
The API key is generated directly from your AntsRoute interface in just a few steps.
- Log in to your AntsRoute account
- Click on your initials in the top-right corner
- Go to Integrations
- Click on API Keys
- Click the “+” button in the top-right corner
- Enter a name for the key
- Select the site for which you want to generate the API key
- Click Create
- Click Copy and store the key in a secure document
- Confirm the creation by clicking Continue
⚠️ Important: this key is personal and provides access to your AntsRoute data. Keep it secure and do not share it.
What actions are possible with the API key?
Once your API key has been generated, you can use it to perform several types of actions.
➡️ Create data in AntsRoute
You can automatically send to AntsRoute:
- agents
- customers
- deliveries
- items
- parcels
- routes, etc.
This is ideal for feeding AntsRoute from your business tools without manual re-entry.
➡️ Retrieve information and statuses
The API also allows you to read data available in AntsRoute, for example:
- the status of a delivery (planned, assigned, completed, canceled, etc.)
- planned and actual dates
- information associated with a delivery
➡️ Update your data
Depending on your needs, you can:
- modify certain information (address, time slot, duration, instructions, etc.)
- update existing deliveries
- synchronize changes between AntsRoute and your systems
➡️ Automate your processes
Thanks to the AntsRoute APIs, you can for example:
- import your deliveries daily from an ERP
- automatically create deliveries from an e-commerce website
- update your internal tools based on the real-time status of deliveries
- reduce errors caused by duplicate data entry
Where can I find the technical details of the APIs?
The AntsRoute API documentation, intended for your technical teams or integrator, includes:
- the list of available resources
- the possible actions for each one (create, read, update, etc.)
- the expected parameters
- examples of requests and responses
🙋♀️ Need help?
If you encounter any issues with our APIs, feel free to contact AntsRoute support by email or via the chat available from the web interface.