Documentation de l'API

Voici la documentation des points de terminaison API disponibles, qui sont construits autour de l'architecture REST. Tous les points de terminaison API renverront une réponse JSON avec les codes de réponse HTTP standard et nécessitent une authentification Bearer via une clé API.

Obtenez votre propre clé API

URL de base

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}

Exemple

curl --request GET \
--url 'https://seolytix.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Erreurs

Notre API utilise des codes d'état HTTP conventionnels pour indiquer le succès ou l'échec d'une demande.

Exemple

{
    "errors": [
        {
            "title": "Vous n'avez pas acc\u00e8s \u00e0 l'API.",
            "status": 401
        }
    ]
}

Codes d'état

200 Demande terminée avec succès

400 Mauvaise requête - Les paramètres requis sont 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 demandes - 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

Sites web

Audits

Audits archivés

Gestionnaires de notifications

domains.title

Journaux de compte