Documentation
Carte en cours du clonage...
Merci d'attendre la fin du clonage avant de modifier quoi que ce soit.
Architecture
Workflow
APIs
APIs access
API errors responses
Notifications
Webhook
APIS LIST
API Access per scope
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:
SCOPE MANAGERThe manager of the franchise
SCOPE SHOP_OWNERThe manager of the shop
SCOPE FRONTFranchise's online shop
SCOPE CUSTOMERThe customer
| Endpoint | Method | Description | FRONT | MANAGER | SHOP_OWNER | CUSTOMER |
|---|---|---|---|---|---|---|
| /api/v2/shop_modes/{id} |
GET
|
Return a shop mode |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|
| /api/v2/shop_modes/{id}/attach-image |
POST
|
Change image |
Unauthorised
|
Unauthorised
|
Authorized
|
Unauthorised
|
| /api/v2/shops/{id}/shop_modes |
GET
|
Return the list of shop modes of a given shop |
Authorized
|
Unauthorised
|
Authorized
|
Unauthorised
|