Espaces

Notes
Niveau expert
La clé API doit être envoyée sous forme de jeton Bearer dans l'en-tête Authorization de la requête. Obtenez votre clé API.
Liste

Point d'accès API:

GET 
https://tuz.fr/api/v1/spaces

Exemple de requête: 

curl --location --request GET 'https://tuz.fr/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
La requête de recherche.
search_by
facultatif string
Rechercher par. Les valeurs possibles sont : name pour Nom. Par défaut : name.
sort_by
facultatif string
Trier par. Les valeurs possibles sont : id pour Date de création, name pour Nom. Par défaut : id.
sort
facultatif string
Trier. Les valeurs possibles sont : desc pour Descendant, asc pour Ascendant. Par défaut : desc.
per_page
facultatif int
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Par défaut : 50.
Afficher

Point d'accès API:

GET 
https://tuz.fr/api/v1/spaces/{id}

Exemple de requête: 

curl --location --request GET 'https://tuz.fr/api/v1/spaces/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Magasin

Point d'accès API:

POST 
https://tuz.fr/api/v1/spaces

Exemple de requête: 

curl --location --request POST 'https://tuz.fr/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
Paramètre
Type
Description
name
requis string
Le nom de l'espace.
color
facultatif integer
Le code couleur. Les valeurs possibles sont : 1, 2, 3, 4, 5, 6. Par défaut : 1.
Mettre à jour

Point d'accès API:

PUT PATCH 
https://tuz.fr/api/v1/spaces/{id}

Exemple de requête: 

curl --location --request PUT 'https://tuz.fr/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
name
facultatif string
Le nom de l'espace.
color
facultatif integer
Le code couleur. Les valeurs possibles sont : 1, 2, 3, 4, 5, 6.
Supprimer

Point d'accès API:

DELETE 
https://tuz.fr/api/v1/spaces/{id}

Exemple de requête: 

curl --location --request DELETE 'https://tuz.fr/api/v1/spaces/{id}' \
--header 'Authorization: Bearer {api_key}'