Espaces

Notes
Niveau expert
La clé API doit être envoyée en tant que jeton Bearer dans l'en-tête d'autorisation de la requête. Obtenez votre clé API.
Lister

Point de terminaison API:

GET 
https://stats.tomco.tech/api/v1/spaces

Exemple de requête: 

curl --location --request GET 'https://stats.tomco.tech/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
optionnel string
La requête de recherche.
search_by
optionnel string
Rechercher par. Les valeurs possibles sont : name pour Nom. La valeur par défaut est : name.
sort_by
optionnel string
Trier par. Les valeurs possibles sont : id pour Date de création, name pour Nom. La valeur par défaut est : id.
sort
optionnel string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. La valeur par défaut est : desc.
per_page
optionnel integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. La valeur par défaut est : 10.
Montrer

Point de terminaison API:

GET 
https://stats.tomco.tech/api/v1/spaces/{id}

Exemple de requête: 

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

Point de terminaison API:

POST 
https://stats.tomco.tech/api/v1/spaces

Exemple de requête: 

curl --location --request POST 'https://stats.tomco.tech/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
optionnel integer
Le code couleur. Les valeurs possibles sont : 1, 2, 3, 4, 5, 6. La valeur par défaut est : 1.
Mettre à jour

Point de terminaison API:

PUT PATCH 
https://stats.tomco.tech/api/v1/spaces/{id}

Exemple de requête: 

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

Point de terminaison API:

DELETE 
https://stats.tomco.tech/api/v1/spaces/{id}

Exemple de requête: 

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