Vue d'ensemble de l'API

URL de base, authentification, format des réponses, erreurs et pagination.

Spécification OpenAPI Importez la spec directement dans Postman, Insomnia ou tout outil compatible OpenAPI. Télécharger openapi.yaml

URL de base

Tous les endpoints sont disponibles sous :

https://api.cache-boost.com/v1

Authentification

Transmettez votre clé API en tant que Bearer token dans chaque requête :

Authorization: Bearer cb_live_VOTRE_CLÉ

Consultez Authentification pour créer des clés et gérer les portées.

Format des réponses

Toutes les réponses sont en JSON. Les réponses réussies retournent l'objet directement pour les ressources uniques, ou un tableau pour les collections.

[
  { "id": 1, "domain": "www.example.com", "validated": true, ... },
  { "id": 2, "domain": "blog.example.com", "validated": false, ... }
]

Les endpoints paginés (ex. GET /runs) encapsulent les résultats dans un tableau data avec limit et offset :

{
  "data": [ ... ],
  "limit": 20,
  "offset": 0
}

Erreurs

Les erreurs retournent un objet JSON avec une chaîne error :

{
  "error": "Clé API invalide ou expirée."
}

Statut HTTP	Signification
`401`	Clé API manquante ou invalide
`403`	La clé ne dispose pas de la portée requise
`404`	Ressource introuvable ou inaccessible avec cette clé
`409`	Conflit (ex. boost déjà en cours, sitemap dupliqué)
`422`	Erreur de validation (valeur de champ invalide)
`500`	Erreur serveur

Pagination

L'endpoint GET /runs accepte limit (défaut : 20, max : 100) et offset :

GET /v1/runs?limit=50&offset=100