Set permissions on the Web API
Permissions on the Web API are granted according to the user’s role(s).
To change Web API permissions for one user role:
- Go to System and click on the Roles menu entry
- Click on the role to edit
- Click on the Web API Permissions tab
- Check/uncheck the permissions you want
- Click on the Save button to confirm your changes
The following sections will give you a detailed explanation of what each permission grant. Do not hesitate to take a look.
Give the overall access
First, there is a permission that grants access to the overall Web API. It is called Overall Web API.
If it is turned on for a given role, it will give an overall access to the API to the users that have this role. Meaning these users would be able to call any endpoints in the API.
If it is turned off, the users that have this role won't be able to make calls to the API endpoints.
Give access by endpoints
You can also be more precise in terms of endpoints you want your API users to call.
The following tables sum up the permissions you will find to restrict the access to the API, endpoint by endpoint.
| Channel endpoints | |
| List channels | Gives permission to GET on the channel endpoint |
| Create and update channels | Gives permission to POST and PATCH on the channel endpoint |
| Locale endpoints | |
| List locales | Gives permission to GET on the locale endpoint |
| Currency endpoints | |
| List currencies | Gives permission to GET on the currency endpoint |
| Family endpoints | |
| List families | Gives permission to GET on the family endpoint |
| Create and update families | Gives permission to POST and PATCH on the family endpoint |
| Attribute endpoints | |
| List attributes | Gives permission to GET on the attribute endpoint |
| Create and update attributes | Gives permission to POST and PATCH on the attribute endpoint |
| Attribute option endpoints | |
| List attribute options | Gives permission to GET on the attribute options endpoint |
| Create and update attribute options | Gives permission to POST and PATCH on the attribute options endpoint |
| Attribute group endpoints | |
| List attribute groups | Gives permission to GET on the attribute groups endpoint |
| Create and update attribute groups | Gives permission to POST and PATCH on the attribute groups endpoint |
| Category endpoints | |
| List categories | Gives permission to GET on the category endpoint |
| Create and update categories | Gives permission to POST and PATCH on the category endpoint |
| Association type endpoints | |
| List association types | Gives permission to GET on the association type endpoint |
| Create and update association types | Gives permission to POST and PATCH on the association type endpoint |
For more details about these permissions, have a look to our dedicated section in the API documentation.