MENU navbar-image

Introduction

API utilisée dans le cadre des enseignements de développement du BTS SIO du Campus Notre Dame du Roc.
Toutes les données sont fictives.

This documentation aims to provide all the information you need to work with our API.

Base URL

https://alizon.btssioroc.com

Authenticating requests

Authenticate requests to this API's endpoints by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

All users

GET api/v1/user

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/user

GET api/v2/user

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/user" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/user"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/user

Endpoints

POST api/v1/login

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v1/login" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/login"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/login

GET api/v1/salesman/activeOrders

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/salesman/activeOrders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/salesman/activeOrders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/salesman/activeOrders

GET api/v1/salesman/ordersCount

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/salesman/ordersCount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/salesman/ordersCount"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/salesman/ordersCount

GET api/v1/salesman/orders

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/salesman/orders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/salesman/orders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/salesman/orders

GET api/v1/salesman/customersCount

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/salesman/customersCount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/salesman/customersCount"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/salesman/customersCount

GET api/v1/salesman/customers

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/salesman/customers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/salesman/customers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/salesman/customers

Find products for which the name or the description contain a keyword.

requires authentication

The keyword needs to have at least 3 characters. The response is limited to 100 elements.

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/product" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/product"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/product

POST api/v1/register

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v1/register" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quos\",
    \"email\": \"mrodriguez@example.net\",
    \"password\": \"et\"
}"

const url = new URL(
    "https://alizon.btssioroc.com/api/v1/register"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "quos",
    "email": "mrodriguez@example.net",
    "password": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/register

Body Parameters

name  string  

email  string  

Must be a valid email address.

password  string  

Remove the category from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://alizon.btssioroc.com/api/v1/category/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/category/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/category/{id}

URL Parameters

id  integer  

The ID of the category.

Update the category in storage.

requires authentication

Example request:
curl --request PUT \
    "https://alizon.btssioroc.com/api/v1/category/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/category/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/v1/category/{id}

PATCH api/v1/category/{id}

URL Parameters

id  integer  

The ID of the category.

Display informations, children and products from a categpry.

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/category/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/category/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/category/{id}

URL Parameters

id  integer  

The ID of the category.

Store a newly created category in storage.

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v1/category" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/category"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/category

Display all root categories.

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/category" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/category"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/category

Display all permissions

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/permission" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/permission"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/permission

display all roles

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/role" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/role"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/role

GET api/v1/salesman/activeOrdersCount

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/salesman/activeOrdersCount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/salesman/activeOrdersCount"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/salesman/activeOrdersCount

Display informations about a product

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/product/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/product/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 2,
    "ref": "bxc-710274",
    "name": "Mock Turtle persisted. 'How.",
    "description": "Velit sunt et suscipit doloremque rerum. Magni molestias distinctio eum magnam. Beatae aut fuga consequuntur quidem. Illo quia veritatis molestias ducimus eos. Ut iste sed distinctio voluptatem voluptas quas quas. Rerum praesentium deserunt ut. Ad aperiam magnam dolores rerum aut ut. Corrupti vel omnis dolorem fugit. In consequuntur non ea repellat est molestiae. Architecto voluptatum aliquid id qui. Est ea omnis laborum ducimus eum. Nobis quibusdam et harum aliquam eaque deserunt qui. Iste qui adipisci expedita qui modi. Tempora aut quo natus sapiente. Possimus deleniti cum distinctio quaerat. In minima perferendis ducimus maxime. Soluta enim neque ad ea reprehenderit voluptas omnis. Corrupti reiciendis hic sint velit magnam tempora. Voluptatem inventore hic dolore praesentium. Quia ullam consequatur commodi ipsam voluptatum. Commodi quod expedita culpa est sed. Tempore rerum non aperiam labore. Officia voluptatibus nisi ipsum rerum eveniet molestiae at. Distinctio soluta minima aut est vero eos. Blanditiis molestiae molestiae totam odit voluptas cum aut. Atque ullam quia et. Autem quisquam velit eaque nobis. Impedit nihil omnis vel voluptatem. Consectetur asperiores labore libero fugit. Eum sit corrupti quis et rerum. Autem quo ea alias debitis vel accusantium. Quo quisquam est modi aliquam blanditiis sed aliquam. Sapiente harum adipisci aspernatur ipsum laudantium accusantium. Labore corrupti sapiente in omnis eius fugiat. Enim voluptate similique sapiente tempora. Qui quo officiis omnis quos explicabo voluptatum doloremque qui. Molestias consequatur excepturi necessitatibus. Et minus ut aut explicabo. Nisi deserunt reprehenderit aut perspiciatis nulla ipsam. Hic architecto laborum explicabo commodi velit corporis. Amet nobis ut distinctio consequatur ut consequuntur et.",
    "category_id": 1,
    "quantity": "107"
}

Request      

GET api/v1/product/{id}

URL Parameters

id  integer  

The ID of the product.

GET api/v1/productbyref/{ref}

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/productbyref/voluptatem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/productbyref/voluptatem"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/productbyref/{ref}

URL Parameters

ref  string  

GET api/v1/order/createOrders/{count?}

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/order/createOrders/hic" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/order/createOrders/hic"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/order/createOrders/{count?}

URL Parameters

count  string optional  

GET api/v1/order/toPrepare

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/order/toPrepare" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/order/toPrepare"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/order/toPrepare

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/order/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/order/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/order/{id}

URL Parameters

id  integer  

The ID of the order.

GET api/v1/role/{role_id}

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/role/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/role/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/role/{role_id}

URL Parameters

role_id  integer  

The ID of the role.

display a permission and roles allowed

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v1/permission/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/permission/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/permission/{permission_id}

URL Parameters

permission_id  integer  

The ID of the permission.

POST api/v1/order/prepare/{order_id}

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v1/order/prepare/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/order/prepare/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/order/prepare/{order_id}

URL Parameters

order_id  integer  

The ID of the order.

POST api/v1/order/prepared/{order_id}

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v1/order/prepared/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v1/order/prepared/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/order/prepared/{order_id}

URL Parameters

order_id  integer  

The ID of the order.

POST api/v2/login

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v2/login" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/login"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v2/login

POST api/v2/register

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v2/register" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"modi\",
    \"email\": \"ggoodwin@example.com\",
    \"password\": \"amet\"
}"

const url = new URL(
    "https://alizon.btssioroc.com/api/v2/register"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "modi",
    "email": "ggoodwin@example.com",
    "password": "amet"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v2/register

Body Parameters

name  string  

email  string  

Must be a valid email address.

password  string  

display all roles

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/role" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/role"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/role

GET api/v2/role/{role_id}

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/role/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/role/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/role/{role_id}

URL Parameters

role_id  integer  

The ID of the role.

Display all permissions

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/permission" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/permission"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/permission

display a permission and roles allowed

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/permission/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/permission/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/permission/{permission_id}

URL Parameters

permission_id  integer  

The ID of the permission.

Display all root categories.

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/category" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/category"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/category

Store a newly created category in storage.

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v2/category" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/category"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v2/category

Display informations, children and products from a categpry.

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/category/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/category/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/category/{id}

URL Parameters

id  integer  

The ID of the category.

Update the category in storage.

requires authentication

Example request:
curl --request PUT \
    "https://alizon.btssioroc.com/api/v2/category/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/category/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/v2/category/{id}

PATCH api/v2/category/{id}

URL Parameters

id  integer  

The ID of the category.

Remove the category from storage.

requires authentication

Example request:
curl --request DELETE \
    "https://alizon.btssioroc.com/api/v2/category/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/category/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v2/category/{id}

URL Parameters

id  integer  

The ID of the category.

GET api/v2/salesman/customers

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/salesman/customers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/salesman/customers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/salesman/customers

GET api/v2/salesman/customersCount

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/salesman/customersCount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/salesman/customersCount"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/salesman/customersCount

GET api/v2/salesman/orders

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/salesman/orders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/salesman/orders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/salesman/orders

GET api/v2/salesman/ordersCount

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/salesman/ordersCount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/salesman/ordersCount"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/salesman/ordersCount

GET api/v2/salesman/activeOrders

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/salesman/activeOrders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/salesman/activeOrders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/salesman/activeOrders

GET api/v2/salesman/activeOrdersCount

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/salesman/activeOrdersCount" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/salesman/activeOrdersCount"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/salesman/activeOrdersCount

Display informations about a product

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/product/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/product/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 2,
    "ref": "bxc-710274",
    "name": "Mock Turtle persisted. 'How.",
    "description": "Velit sunt et suscipit doloremque rerum. Magni molestias distinctio eum magnam. Beatae aut fuga consequuntur quidem. Illo quia veritatis molestias ducimus eos. Ut iste sed distinctio voluptatem voluptas quas quas. Rerum praesentium deserunt ut. Ad aperiam magnam dolores rerum aut ut. Corrupti vel omnis dolorem fugit. In consequuntur non ea repellat est molestiae. Architecto voluptatum aliquid id qui. Est ea omnis laborum ducimus eum. Nobis quibusdam et harum aliquam eaque deserunt qui. Iste qui adipisci expedita qui modi. Tempora aut quo natus sapiente. Possimus deleniti cum distinctio quaerat. In minima perferendis ducimus maxime. Soluta enim neque ad ea reprehenderit voluptas omnis. Corrupti reiciendis hic sint velit magnam tempora. Voluptatem inventore hic dolore praesentium. Quia ullam consequatur commodi ipsam voluptatum. Commodi quod expedita culpa est sed. Tempore rerum non aperiam labore. Officia voluptatibus nisi ipsum rerum eveniet molestiae at. Distinctio soluta minima aut est vero eos. Blanditiis molestiae molestiae totam odit voluptas cum aut. Atque ullam quia et. Autem quisquam velit eaque nobis. Impedit nihil omnis vel voluptatem. Consectetur asperiores labore libero fugit. Eum sit corrupti quis et rerum. Autem quo ea alias debitis vel accusantium. Quo quisquam est modi aliquam blanditiis sed aliquam. Sapiente harum adipisci aspernatur ipsum laudantium accusantium. Labore corrupti sapiente in omnis eius fugiat. Enim voluptate similique sapiente tempora. Qui quo officiis omnis quos explicabo voluptatum doloremque qui. Molestias consequatur excepturi necessitatibus. Et minus ut aut explicabo. Nisi deserunt reprehenderit aut perspiciatis nulla ipsam. Hic architecto laborum explicabo commodi velit corporis. Amet nobis ut distinctio consequatur ut consequuntur et.",
    "category_id": 1,
    "quantity": "107"
}

Request      

GET api/v2/product/{id}

URL Parameters

id  integer  

The ID of the product.

GET api/v2/productbyref/{ref}

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/productbyref/odit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/productbyref/odit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/productbyref/{ref}

URL Parameters

ref  string  

Find products for which the name or the description contain a keyword.

requires authentication

The keyword needs to have at least 3 characters. The response is limited to 100 elements.

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/product" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/product"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/product

GET api/v2/order/createOrders/{count?}

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/order/createOrders/commodi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/order/createOrders/commodi"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/order/createOrders/{count?}

URL Parameters

count  string optional  

GET api/v2/order/toPrepare

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/order/toPrepare" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/order/toPrepare"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/order/toPrepare

POST api/v2/order/prepare/{order_id}

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v2/order/prepare/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/order/prepare/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v2/order/prepare/{order_id}

URL Parameters

order_id  integer  

The ID of the order.

POST api/v2/order/prepared/{order_id}

requires authentication

Example request:
curl --request POST \
    "https://alizon.btssioroc.com/api/v2/order/prepared/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/order/prepared/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v2/order/prepared/{order_id}

URL Parameters

order_id  integer  

The ID of the order.

Display the specified resource.

requires authentication

Example request:
curl --request GET \
    --get "https://alizon.btssioroc.com/api/v2/order/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://alizon.btssioroc.com/api/v2/order/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v2/order/{id}

URL Parameters

id  integer  

The ID of the order.