Documentation API

Apprenez à vous connecter et à vous intégrer avec notre 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 via la méthode d'authentification Bearer.

Authorization: Bearer {api_key}

Exemple

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

Notre API utilise les codes de statut HTTP conventionnels pour indiquer le succès ou l'échec d'une requête.

Exemple

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

Codes de statut

200 Requête réussie

400 Requête incorrecte - Des paramètres requis sont manquants ou invalides

401 Non autorisé - La clé API est manquante ou invalide

404 La ressource demandée est introuvable

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 endpoints de l'API fonctionnent avec le fuseau horaire UTC, sauf indication contraire.

Utilisateur

Sites Web

Audits

Audits archivés

Gestionnaires de notifications

Domaines personnalisés

Mes Équipes

Membres de l'équipe

Membre d'équipes

Paiements du compte

Journaux du compte