Give a partner API access
Create an API access integration with its own key, secret, permissions, allowed IP addresses and rate limit for a partner or your own software.
Updated October 4, 2026
Who can do this: Role level 800 or higher and the integration permission.
An API access integration gives a partner, a customer or your own software its own credentials to use the Transportial API. You decide exactly what it may do. Because each partner gets a separate integration, you can see its activity and revoke its access without affecting anyone else.
Create the access
- Open the side menu (☰, top right), choose Integrations and click + Create integration.
- Enter a Name that says who uses it, for example "Customer X order portal".
- In Select integration type, choose API access integration.
- In Select permissions, choose what the partner may do, for example read and create transport orders. Give only what is needed.
- Click Generate to create the access key and Secret key, or enter your own.
- Optionally, add the partner's IP Addresses. Calls from other addresses are refused.
- Optionally, set Maximum requests per minute to protect your platform from heavy use.
- Set Off/On to on and click Save.
- Share the access key and secret with the partner through a secure channel.
Anyone with the key and secret can act on your platform within the permissions you chose. Never send them in plain email or chat, and generate new ones if you think they have leaked.
Change or revoke access
- To change the permissions, open the integration, click the pencil (✎), change Select permissions and click Save.
- To give the partner new credentials, click Generate again and save. The old ones stop working.
- To stop access temporarily, set Off/On to off and save.
- To stop access for good, click Remove on the row in the integrations list.
Point the partner to the documentation
Developers find the API documentation in the developer portal. See Build on Transportial as a developer.