API Clients - Administrator and Customer Roles, Plus a Permission Viewer
Give an API Client the same role as a User
Until now, API Clients were permissioned only through the API Roles checkbox grid. You could not give a client the same Administrator or Customer role you already use for people in CartonCloud, so it was hard to know whether an integration had the same access as the user it was meant to match.
Add and Edit API Client now include a Role field. Choose one of:
Administrator — the client gets the same API permissions as an Administrator User.
Customer — the client gets the same API permissions as a Customer User.
Manual — the existing API Roles checkbox grid, for a custom set of permissions.
You must choose a role before you can save a new API Client. Choosing Administrator or Customer hides the checkbox grid. Choosing Manual brings it back.
Check permissions before you save
View permissions shows exactly what the client will be able to do for the role you have selected right now, including changes you have not saved yet.
Each row lists the permission code, a short description, and which role it comes from. Use the search field to filter by code, description, or role name, then close the window to return to Add or Edit. You cannot change permissions from inside this window.
What Administrator and Customer now include
Administrator and Customer are the same roles assigned to web app Users, not roles created only for API Clients. A few API permissions have been added to (or, for Customer, removed from) those roles, so they apply to every Administrator or Customer User already in your account, as well as to any API Client using that preset.
Administrator now includes: Add Consignment Quote, Delete Inbound Order, Delete Outbound Order, Edit Consignment Charges, and Trigger Webhook Request.
Customer now includes: Add Consignment Quote, Delete Inbound Order, and Delete Outbound Order.
The Customer role no longer includes Edit Warehouse Product. Updating a Warehouse Product via the API is rejected for Customer-role tokens, including products that belong to that Customer. Creating Warehouse Products is unaffected. If a Customer needs to update Warehouse Products via the API, set the API Client to Manual and grant WMS Edit Product.
For setup steps, sandbox testing, and credential handling, see the Help Centre article on API Clients.