API REST

Intégrez le recouvrement à votre SI en quelques lignes de code

GetBill est une plateforme SaaS de recouvrement amiable par intelligence artificielle. Son API REST permet à vos équipes techniques de connecter le recouvrement directement à votre SI. Créez des dossiers, suivez leur statut en temps réel, recevez les notifications de paiement. 40% des dossiers sont soldés sans intervention humaine.

Pour équipes techniques, éditeurs de logiciels, intégrateurs.

Accéder à la sandbox Contacter l'équipe technique
REST API standard
OAuth2 Authentification
Temps réel Webhooks
CSV/XLSX Import masse
Endpoints

Créez un dossier de recouvrement en une requête

L'endpoint POST /external-api/v1/debts crée un dossier complet : coordonnées du débiteur, montant, référence, date d'échéance, scénario de relance. GetBill déclenche automatiquement les relances selon le scénario choisi. Voici un exemple concret dans trois langages.

cURL 
# Créer un dossier de recouvrement
curl -X POST https://getbill.io/external-api/v1/debts \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "debtor": {
      "name": "Jean Dupont",
      "email": "jean.dupont@email.com",
      "phone": "+33612345678"
    },
    "amount": 2340.00,
    "currency": "EUR",
    "reference": "F-2024-0847",
    "due_date": "2024-01-15",
    "scenario": "standard_3_waves"
  }'
Python 
import requests

# Créer un dossier de recouvrement
response = requests.post(
    "https://getbill.io/external-api/v1/debts",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    json={
        "debtor": {
            "name": "Jean Dupont",
            "email": "jean.dupont@email.com",
            "phone": "+33612345678"
        },
        "amount": 2340.00,
        "currency": "EUR",
        "reference": "F-2024-0847",
        "due_date": "2024-01-15",
        "scenario": "standard_3_waves"
    }
)

debt = response.json()
print(f"Dossier créé : {debt['id']}")
Node.js 
// Créer un dossier de recouvrement
const response = await fetch('https://getbill.io/external-api/v1/debts', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    debtor: {
      name: 'Jean Dupont',
      email: 'jean.dupont@email.com',
      phone: '+33612345678'
    },
    amount: 2340.00,
    currency: 'EUR',
    reference: 'F-2024-0847',
    due_date: '2024-01-15',
    scenario: 'standard_3_waves'
  })
});

const debt = await response.json();
console.log(`Dossier créé : ${debt.id}`);

Chaque dossier créé via l'API reçoit un identifiant unique. Suivez son évolution avec GET /external-api/v1/debts/{id}, listez vos dossiers avec GET /external-api/v1/debts (pagination incluse), ou mettez à jour les informations avec PUT /external-api/v1/debts/{id}. Filtres disponibles : statut, date, montant, scénario. Réponses JSON avec codes HTTP standards.

Autres endpoints disponibles

GET /external-api/v1/debts

Listez et filtrez vos dossiers. Pagination, tri par date, filtre par statut et montant.

GET /external-api/v1/followups

Historique des relances : appels IA, SMS, emails, courriers. Horodatage et canal utilisé.

GET /external-api/v1/reports

Statistiques de recouvrement : taux de résolution, montants recouvrés, délai moyen.

Webhooks

Recevez les événements en temps réel

Les webhooks GetBill notifient votre système dès qu'un événement se produit sur un dossier de recouvrement. Plus besoin de polling : votre ERP, votre CRM ou votre outil de facturation est mis à jour instantanément. Chaque webhook contient toutes les données nécessaires pour mettre à jour votre système sans requête supplémentaire.

  • debt.created : un nouveau dossier est créé
  • debt.contacted : le débiteur a été contacté avec succès
  • debt.payment_received : un paiement a été encaissé
  • debt.resolved : le dossier est soldé intégralement
  • debt.escalated : le dossier est passé en contentieux
  • followup.completed : une relance a été finalisée (avec détail)
Webhook payload 
{
  "event": "debt.payment_received",
  "timestamp": "2024-03-15T14:32:07Z",
  "data": {
    "debt_id": "debt_a1b2c3d4",
    "reference": "F-2024-0847",
    "payment": {
      "amount": 2340.00,
      "currency": "EUR",
      "method": "card",
      "stripe_payment_id": "pi_3Ox..."
    },
    "debtor": {
      "name": "Jean Dupont",
      "email": "jean.dupont@email.com"
    },
    "status": "resolved",
    "resolved_at": "2024-03-15T14:32:07Z"
  },
  "webhook_id": "wh_x9y8z7"
}

Chaque webhook est signé avec HMAC-SHA256 pour garantir l'authenticité. En cas d'échec de livraison, GetBill retente automatiquement jusqu'à 5 fois avec un backoff exponentiel.

Import

Importez des milliers de dossiers en un clic

Vous n'avez pas encore d'intégration API ? Aucun problème. L'import masse permet de charger vos fichiers CSV ou XLSX directement dans GetBill. Le mapping des colonnes est intelligent : il reconnaît automatiquement les champs standards (nom, email, téléphone, montant, date). La validation intégrée vérifie chaque ligne avant l'import et génère un rapport d'erreurs détaillé.

  • Formats CSV et XLSX supportés nativement
  • Mapping colonnes automatique par détection intelligente
  • Validation des données avant traitement (format email, téléphone, montant)
  • Rapport d'erreurs détaillé avec numéro de ligne et correction suggérée
  • Import récurrent via SFTP pour l'automatisation complète
Import API 
# Import masse via l'endpoint batch
curl -X POST https://getbill.io/external-api/v1/debts/batch \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "debts": [ ... ] }'

# Réponse
{
  "batch_id": "batch_k4m5n6",
  "status": "processing",
  "total": 1847,
  "created": 1823,
  "errors": 24
}

Pour les imports SFTP récurrents, déposez vos fichiers dans le répertoire dédié et GetBill les traite automatiquement toutes les heures. Idéal pour les exports quotidiens depuis votre ERP.

Authentification

OAuth2 et clés API pour un accès sécurisé

L'API recouvrement GetBill utilise le protocole OAuth2 pour l'authentification en production. Obtenez un token d'accès avec vos identifiants client, puis incluez le dans l'en tête Authorization de chaque requête. Les tokens expirent après 1 heure et peuvent être renouvelés via le refresh token.

Pour l'environnement sandbox, des clés API statiques sont fournies dès l'inscription. Aucune configuration OAuth2 n'est nécessaire pour commencer à tester. Vous pouvez générer et révoquer vos clés sandbox depuis le dashboard développeur à tout moment.

OAuth2 
# Étape 1 : Obtenir un access token (OAuth 2.0)
curl -X POST https://getbill.io/external-api/v1/oauth/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET"

# Réponse
{
  "access_token": "eyJhbGciOiJSUzI1NiIs...",
  "token_type": "Bearer",
  "expires_in": 3600
}

# Étape 2 : Utiliser le token
curl https://getbill.io/external-api/v1/debts \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIs..."

Scopes granulaires

Contrôlez précisément les permissions de chaque token : lecture, écriture, gestion des webhooks, accès analytics.

Rotation automatique

Les refresh tokens permettent un renouvellement transparent, sans interruption de service ni ré authentification manuelle.

Sandbox instantanée

Clé API statique fournie dès l'inscription. Commencez à tester en moins de 2 minutes, sans configuration OAuth2.

Cas d'usage

L'API recouvrement qui s'adapte à votre architecture

Quelle que soit votre stack technique, l'API REST GetBill s'intègre nativement. Trois cas d'usage illustrent la flexibilité de l'intégration.

ERP maison ou sur mesure

Intégrez le recouvrement dans vos workflows existants. Création automatique de dossier dès qu'une facture dépasse son échéance, notifications de paiement via webhook. Zéro export manuel, données toujours à jour.

CRM et suivi commercial

Synchronisez les dossiers avec votre CRM. Dossier soldé, échéancier négocié, appel abouti : l'information remonte automatiquement dans la fiche client. Plus de silos entre recouvrement et relation client.

Facturation et comptabilité

Connectez votre outil de facturation pour relancer automatiquement les factures échues. L'API crée le dossier, lance les relances, et effectue le lettrage au paiement. Intégration bidirectionnelle pour une réconciliation complète.

Compatible Python, Node.js, Java, PHP, Ruby, Go.

Spécifications techniques

Une API conçue pour la production

L'API recouvrement GetBill respecte les standards de l'industrie pour garantir fiabilité, sécurité et performance en environnement de production.

Sécurité et conformité

Toutes les communications transitent via HTTPS/TLS 1.3. Les données sont chiffrées au repos (AES-256) et hébergées en France (AWS Paris eu-west-3, certifié ISO 27001). Conforme au RGPD (règlement UE 2016/679) et à l'AI Act européen. L'API est conforme RGPD : chaque dossier peut être supprimé via l'endpoint DELETE /external-api/v1/debts/{id} pour respecter le droit à l'effacement. Les logs d'accès sont conservés 90 jours et accessibles depuis le dashboard développeur.

Les webhooks sont signés avec HMAC-SHA256. Vous vérifiez la signature côté serveur pour garantir que chaque notification provient bien de GetBill. La clé de signature est rotatable depuis le dashboard sans interruption de service.

Performance et fiabilité

L'API recouvrement GetBill offre un temps de réponse moyen inférieur à 200 ms. Le rate limiting est fixé à 1 000 requêtes par minute en production (100 en sandbox). Les headers de réponse X-RateLimit-Remaining et X-RateLimit-Reset vous permettent de gérer votre consommation de manière optimale.

L'infrastructure est dimensionnée pour traiter des volumes importants. Les imports masse de plusieurs milliers de dossiers via POST /external-api/v1/debts/batch sont traités en arrière plan. La disponibilité garantie est de 99,9% (SLA), avec un monitoring actif et des alertes en cas d'incident.

Environnement sandbox : testez sans risque

L'environnement sandbox reproduit fidèlement l'API de production avec des données fictives. Vous pouvez créer des dossiers, déclencher des webhooks, tester les imports masse et simuler des paiements. Les données sandbox sont réinitialisées chaque semaine. L'accès est gratuit et illimité dans le temps, sans engagement ni carte bancaire.

Sandbox 
# Testez l'API avec votre token sandbox
curl https://getbill.io/external-api/v1/debts \
  -H "Authorization: Bearer YOUR_SANDBOX_TOKEN"

# Créer un dossier de test
curl -X POST https://getbill.io/external-api/v1/debts \
  -H "Authorization: Bearer YOUR_SANDBOX_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "debtor": { "name": "Test Dupont" },
    "amount": 1500.00,
    "reference": "TEST-001"
  }'

# Les webhooks sont envoyés normalement en sandbox
FAQ

Questions fréquentes sur l'API recouvrement

En production, l'API autorise jusqu'à 1 000 requêtes par minute. En environnement sandbox, la limite est fixée à 100 requêtes par minute. Les headers de réponse incluent X-RateLimit-Remaining (requêtes restantes) et X-RateLimit-Reset (timestamp de réinitialisation) pour vous permettre de gérer vos appels de manière optimale. En cas de dépassement, l'API retourne un code HTTP 429 avec un header Retry-After.

Oui, un environnement sandbox complet est disponible dès l'inscription. Il inclut des données fictives préchargées, la simulation de tous les événements webhooks, et un accès illimité à tous les endpoints. Aucune carte bancaire n'est requise pour tester l'API. Les données sandbox sont réinitialisées chaque semaine pour garantir un environnement propre.

Documentation complète sur docs.getbill.io avec exemples de code, accompagnement personnalisé lors de la mise en production, et support technique par email (moins de 2h en jours ouvrés). Statut de l'API disponible sur status.getbill.io.

Oui, l'endpoint POST /external-api/v1/debts/batch permet d'importer des milliers de dossiers en une seule requête. La validation des données est intégrée et un rapport d'erreurs est retourné en réponse. Pour les imports récurrents, un accès SFTP est également disponible.

L'environnement sandbox permet de simuler tous les événements webhooks : debt.created, debt.contacted, debt.payment_received, debt.resolved, debt.escalated, followup.completed. Vous pouvez déclencher ces événements depuis le dashboard sandbox. Les payloads de test sont identiques à ceux de production.

Testez l'API dans la sandbox

Accédez à l'environnement de test complet, sans engagement ni carte bancaire. Créez votre premier dossier de recouvrement en moins de 5 minutes.

Déploiement rapide Sans engagement RGPD & IA Act conforme
Accéder à la sandbox Voir nos études de cas

Ils s'intègrent avec GetBill

Stripe
Axepta BNP Paribas
Google Workspace
Microsoft
Brevo
Mailjet
SendGrid
Mailgun
Postmark
Scaleway
OVHcloud
Infomaniak
Stripe
Axepta BNP Paribas
Google Workspace
Microsoft
Brevo
Mailjet
SendGrid
Mailgun
Postmark
Scaleway
OVHcloud
Infomaniak