Documentation de l'API
Voici la documentation des points d'accès API disponibles, qui sont construits autour de l'architecture REST. Tous les points d'accès API renverront une réponse JSON avec les codes de réponse HTTP standard et nécessitent une authentification Bearer via une clé API.
Authentification
Tous les points de terminaison de l'API nécessitent une clé API envoyée par la méthode d'authentification Bearer.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://you.bzh/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://you.bzh/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Erreurs
Notre API utilise les codes d'état HTTP conventionnels pour indiquer le succès ou l'échec d'une requête.
{
"errors": [
{
"title": "Vous n'avez pas acc\u00e8s \u00e0 l'API.",
"status": 401
}
]
}
200 Requête terminée avec succès
400 Mauvaise requête - Paramètres requis manquants ou invalides
401 Non autorisé - la clé API est manquante ou invalide
404 La ressource demandée n'a pas été trouvée
429 Trop de requêtes - Limite de débit dépassée
500 Erreur interne du serveur - cela signifie qu'il y a un problème de notre côté
Tous les résultats des points de terminaison de l'API fonctionnent avec le fuseau horaire UTC, sauf indication contraire.
Utilisateur
Liens
Statistiques des liens
Projets
Pixels
Pages d'accueil
Codes QR
Signatures
Données
Notifications
Domaines
Équipes
Membres de l'équipe
Membre de l'équipe
Paiements de compte
Journaux de compte