API

Intègre Skrybe dans ton stack.

API REST simple en JSON. Lance un scan, récupère les contacts vérifiés. Auth Bearer Token, rate-limit transparent.

Authentification

Auth Bearer Token.

Récupère ton token depuis ton dashboard, puis ajoute-le en en-tête Authorization sur chaque requête.

Génération du token

1. Connecte-toi à ton dashboard Skrybe
2. Va dans Paramètres → API tokens
3. Clique sur « Générer un token »

Authorization: Bearer sk_live_***********************

Important : garde ton token secret. Ne le commit jamais en clair dans un repo. Si compromis, révoque-le et regénère.

Endpoints

Les endpoints disponibles.

3 endpoints principaux pour gérer un scan complet. JSON-only, content-type application/json requis.

POST /api/scans Lance un nouveau scan
Body
{
  "domain": "stripe.com",
  "profile": "standard"
}
Réponse 201
{
  "scan_id": 1234,
  "status": "pending",
  "estimated_duration_seconds": 360
}
GET /api/scans/{id} Statut et résultats d'un scan
Headers
Authorization: Bearer {token}
Accept: application/json
Réponse 200
{
  "scan_id": 1234,
  "status": "completed",
  "domain": "stripe.com",
  "emails_total": 187,
  "emails_verified": 142,
  "score_avg": 78
}
GET /api/scans/{id}/contacts Liste des contacts vérifiés
Query params
?min_score=70
&format=json
&limit=100
Réponse 200
{
  "contacts": [{
    "email": "a.martin@stripe.com",
    "score": 94,
    "name": "Alexandre Martin",
    "title": "Head of Sales"
  }],
  "total": 142
}
Bonnes pratiques

Les règles à connaître.

  • Rate-limit : 60 requêtes par minute par token. Au-delà, réponse 429 avec Retry-After en en-tête.
  • Idempotence : un scan POST avec le même domaine dans les dernières 30 min retourne le scan existant (pas de duplicate).
  • Asynchrone : les scans tournent en arrière-plan. Polling conseillé toutes les 30 secondes sur GET /api/scans/{id}.
  • Webhooks : optionnel, configurable dans les paramètres. Évite le polling.
  • Versioning : pas de version dans l'URL pour le moment. Breaking changes annoncés 30 jours à l'avance.
  • Erreurs : codes HTTP standards (4xx client, 5xx serveur). Body JSON avec {"error": "...", "message": "..."}.

Pas encore de compte ?

Crée ton compte gratuit pour générer ton premier token API.

Créer un compte