API Endpoints

Documentation complète des endpoints disponibles dans l'API Scrypt. Intégrez nos fonctionnalités SEO dans vos applications.

Base URL

https://api.scrypt.fr/v1

Analyse SEO

Analyse de page

POST /analyze/page

{
  "url": "https://example.com/page",
  "options": {
    "depth": "complete",
    "checkLinks": true,
    "analyzeMobile": true
  }
}

Analyse complète d'une page web avec vérification des liens et version mobile.

Analyse de site

POST /analyze/site

{
  "domain": "example.com",
  "options": {
    "maxPages": 100,
    "includeSubdomains": true
  }
}

Analyse complète d'un site web avec crawl des pages et sous-domaines.

Optimisation

Optimisation de contenu

POST /optimize/content

{
  "content": "Votre contenu à optimiser",
  "keywords": ["mot-clé 1", "mot-clé 2"],
  "locale": "fr-FR"
}

Optimisation automatique de contenu avec suggestions SEO.

Suggestions de mots-clés

GET /keywords/suggest?query=votre-requête&locale=fr-FR

Response:
{
  "suggestions": [
    {
      "keyword": "mot-clé suggéré",
      "volume": 1000,
      "difficulty": 45
    }
  ]
}

Suggestions de mots-clés avec volume de recherche et difficulté.

Suivi

Positions

GET /rankings?domain=example.com&keywords[]=mot-clé-1

Response:
{
  "rankings": [
    {
      "keyword": "mot-clé-1",
      "position": 5,
      "url": "https://example.com/page"
    }
  ]
}

Suivi des positions pour vos mots-clés cibles.

Rapports

GET /reports?domain=example.com&start=2024-01-01&end=2024-01-31

Response:
{
  "metrics": {
    "visibility": 45.8,
    "rankings": {...},
    "traffic": {...}
  }
}

Rapports de performance SEO sur une période donnée.

Gestion des erreurs

Codes d'erreur

{
  "error": {
    "code": "invalid_request",
    "message": "Description détaillée de l'erreur",
    "status": 400
  }
}

Codes HTTP

  • 400 - Requête invalide
  • 401 - Non authentifié
  • 403 - Non autorisé
  • 404 - Ressource non trouvée
  • 429 - Trop de requêtes
  • 500 - Erreur serveur

Limites d'utilisation

Rate Limiting

Les limites varient selon votre forfait :

  • Gratuit : 100 requêtes/jour
  • Pro : 1000 requêtes/jour
  • Enterprise : Sur mesure

Headers de réponse pour le rate limiting :

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200