{% extends 'Layouts/Doc/default.html.twig' %} {% block title %}Documentation {% endblock %} {% block headerPageTitle %} {{ 'app.documentation.page.title.index'|trans |upper}} {% endblock %} {% block body %}
Foxorder's API contains diffrents roles. Each endpoint is restricted for one or multiple roles depending on its need.
If you would like to test these endpoints in our Swagger UI docs, you need to retrieve a JWT token first.
Here are the roles available in our API:
| Endpoint | Method | Description | FRONT | MANAGER | SHOP_OWNER | CUSTOMER | |
|---|---|---|---|---|---|---|---|
| {{ group.group|upper }} | |||||||
| {{ value.api }} | {% if 'POST' == value.type %} {% set typeClass = 'warning' %} {% elseif 'PUT' == value.type %} {% set typeClass = 'primary' %} {% elseif 'PATCH' == value.type %} {% set typeClass = 'info' %} {% elseif 'DELETE' == value.type %} {% set typeClass = 'danger' %} {% else %} {% set typeClass = 'success' %} {% endif %} {{ value.type|upper|badge('light-' ~ typeClass, false) }} | {{ value.description|raw }} | {{ (value.api_role ? authorized : unauthorized)|raw }} | {{ (value.manager ? authorized : unauthorized)|raw }} | {{ (value.shop_owner ? authorized : unauthorized)|raw }} | {{ (value.customer ? authorized : unauthorized)|raw }} | |
| {{ 'app.global.detail.no_record_found'|trans }} | |||||||
| {{ 'app.global.detail.no_record_found'|trans }} | |||||||