Docs / Référence de l'API

Prise en main

L'API REST LocalLeads vous permet de rechercher des leads d'entreprises locales, d'enrichir les données de contact et de gérer votre compte — le tout par programmation. Chaque point de terminaison qui alimente le tableau de bord est accessible via une clé d'API.

URL de base

https://leadsapi.postorbit.ioProduction

Toutes les requêtes doivent utiliser HTTPS. Les requêtes HTTP seront rejetées.

Auth. par clé d'API

Jetons à longue durée de vie, sans OAuth. Générez-les dans Paramètres → Sécurité.

REST + JSON

Verbes HTTP standard. Toutes les réponses sont au format JSON avec une structure cohérente.

Mêmes permissions

Les clés d'API disposent du même accès complet à votre compte que le tableau de bord.

Débit limité

100 req/min par IP. Utilisez un délai exponentiel pour les automatisations intensives.

Démarrage rapide

1. Générez une clé d'API dans Paramètres → Sécurité → Clés d'API.

2. Transmettez-la comme jeton Bearer à chaque requête :

curl

curl https://leadsapi.postorbit.io/api/v1/credits/balance \
  -H "Authorization: Bearer ll_your_api_key_here"

3. Vous recevez en retour un objet JSON contenant success: true et une charge utile data :

json

{
  "success": true,
  "data": {
    "monthlyCredits": 100,
    "bonusCredits": 0,
    "usedCredits": 12,
    "availableCredits": 88,
    "resetDay": 1,
    "lastResetAt": "2026-05-01T00:00:00.000Z"
  }
}

Format des réponses

Chaque réponse partage la même enveloppe :

json

// Success
{ "success": true, "data": { ... } }

// Paginated success
{ "success": true, "data": [...], "meta": { "total": 100, "page": 1, "limit": 20 } }

// Error
{ "success": false, "error": "Human-readable message" }

Toutes les sections

Authentification →

Clés d'API et jetons Bearer

Leads →

Rechercher, lister et récupérer des leads

Enrichissement →

Trouver des e-mails et enrichir les contacts

Crédits →

Solde et historique des transactions

Clés d'API →

Créer, lister et révoquer des clés d'API

Serveur MCP Claude →

Connecter Claude à LocalLeads via MCP

Authentification→