Sites web

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

Point de terminaison API:

GET 
https://web.aubin.dev/api/v1/websites

Exemple de requête: 

curl --location --request GET 'https://web.aubin.dev/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
search
facultatif string
Requête de recherche.
search_by
facultatif string
Rechercher par. Les valeurs possibles sont : domain pour Domaine. Valeur par défaut : domain.
favorite
facultatif boolean
Filtrer par favori.
sort_by
facultatif string
Trier par. Les valeurs possibles sont : id pour Date de création, domain pour Domaine. Valeur par défaut : id.
sort
facultatif string
Trier. Les valeurs possibles sont : desc pour Décroissant, asc pour Croissant. Valeur par défaut : desc.
per_page
facultatif integer
Résultats par page. Les valeurs possibles sont : 10, 25, 50, 100. Valeur par défaut : 50.
Afficher

Point de terminaison API:

GET 
https://web.aubin.dev/api/v1/websites/{id}

Exemple de requête: 

curl --location --request GET 'https://web.aubin.dev/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Stocker

Point de terminaison API:

POST 
https://web.aubin.dev/api/v1/websites

Exemple de requête: 

curl --location --request POST 'https://web.aubin.dev/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Paramètre
Type
Description
domain
requis string
Nom de domaine
privacy
facultatif integer
Confidentialité. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe. Valeur par défaut : 1.
password
facultatif string
Mot de passe. Fonctionne uniquement lorsque le champ privacy est défini sur 2.
email
facultatif integer
Rapports périodiques par e-mail. Les valeurs possibles sont : 0 pour Désactivé, 1 pour Activé. Valeur par défaut : 0.
exclude_bots
facultatif integer
Exclure les robots courants du suivi. Les valeurs possibles sont : 0 pour Désactivé, 1 pour Activé. Valeur par défaut : 1.
exclude_params
facultatif string
Exclude URL query parameters from being tracked. Un par ligne.
exclude_ips
facultatif string
Exclure les adresses IP du suivi. Un par ligne.
favorite
facultatif boolean
Favori.
Mettre à jour

Point de terminaison API:

PUT PATCH 
https://web.aubin.dev/api/v1/websites/{id}

Exemple de requête: 

curl --location --request PUT 'https://web.aubin.dev/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Paramètre
Type
Description
privacy
facultatif integer
Confidentialité. Les valeurs possibles sont : 0 pour Public, 1 pour Privé, 2 pour Mot de passe.
password
facultatif string
Mot de passe. Fonctionne uniquement lorsque le champ privacy est défini sur 2.
email
facultatif integer
Rapports périodiques par e-mail. Les valeurs possibles sont : 0 pour Désactivé, 1 pour Activé.
exclude_bots
facultatif integer
Exclure les robots courants du suivi. Les valeurs possibles sont : 0 pour Désactivé, 1 pour Activé.
exclude_params
facultatif string
Exclude URL query parameters from being tracked. Un par ligne.
exclude_ips
facultatif string
Exclure les adresses IP du suivi. Un par ligne.
favorite
facultatif boolean
Favori.
Supprimer

Point de terminaison API:

DELETE 
https://web.aubin.dev/api/v1/websites/{id}

Exemple de requête: 

curl --location --request DELETE 'https://web.aubin.dev/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'