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 demande. Obtenez votre clé API.
Liste

Point de terminaison de l'API:

GET 
https://pixy.link/api/v1/spaces

Exemple de requête: 

curl --location --request GET 'https://pixy.link/api/v1/spaces' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
optionnel string
Recherche de requête.
sort
optionnel string
Sorte. Les valeurs possibles sont: desc pour Décroissant, asc pour Croissant. Par défaut à: desc.
per_page
optionnel int
Résultats par page. Les valeurs possibles sont: 10 à 100. Par défaut à: 10.
Montrer

Point de terminaison de l'API:

GET 
https://pixy.link/api/v1/spaces/{id}

Exemple de requête: 

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

Point de terminaison de l'API:

POST 
https://pixy.link/api/v1/spaces

Exemple de requête: 

curl --location --request POST 'https://pixy.link/api/v1/spaces' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
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. Par défaut à: 1.
Mettre à jour

Point de terminaison de l'API:

PUT PATCH 
https://pixy.link/api/v1/spaces/{id}

Exemple de requête: 

curl --location --request PUT 'https://pixy.link/api/v1/spaces/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
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 de l'API:

DELETE 
https://pixy.link/spaces/{id}/destroy

Exemple de requête: 

curl --location --request DELETE 'https://pixy.link/spaces/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'