En résumé : L’API Rodz vous permet d’intégrer les signaux d’affaires B2B directement dans vos outils. Ce guide couvre la création de votre compte, la récupération de votre clé API, l’authentification via Bearer token et l’envoi de votre première requête. En 15 minutes, vous serez opérationnel.
Qu’est-ce que l’API Rodz ? Votre passerelle vers les signaux d’affaires B2B
L’API Rodz est une interface de programmation REST qui permet d’accéder par programmation aux signaux d’affaires détectés par la plateforme Rodz. Un signal d’affaires est un événement concret (levée de fonds, recrutement, déménagement, changement de dirigeant) qui indique qu’une entreprise entre dans une phase propice à l’achat d’un produit ou service. L’API vous donne accès à ces signaux en temps réel, sous forme de données structurées au format JSON.
Concrètement, l’API Rodz vous permet de :
- Lister les types de signaux disponibles parmi les 108 configurations proposées
- Configurer des alertes personnalisées selon vos critères de ciblage (secteur, zone géographique, taille d’entreprise)
- Récupérer les signaux détectés pour les injecter dans votre CRM, vos séquences d’emailing ou vos outils internes
- Recevoir des notifications en temps réel via webhooks lorsqu’un signal correspond à vos critères
L’infrastructure qui alimente cette API repose sur plus de 350 scrapers et 250 sources de données, ce qui garantit une couverture large et une détection rapide des événements.
Ce guide s’adresse aux développeurs, aux équipes RevOps et à toute personne technique souhaitant intégrer les signaux Rodz dans un workflow existant. Aucune connaissance préalable de l’API n’est requise. Seules des bases en HTTP et en ligne de commande sont nécessaires.
Prérequis
Avant de commencer, assurez-vous de disposer des éléments suivants :
- Un compte Rodz actif. Si vous n’en avez pas encore, créez-le sur app.rodz.io/register. L’inscription prend moins de deux minutes.
- Un terminal avec cURL installé. cURL est préinstallé sur macOS et la plupart des distributions Linux. Sous Windows, il est disponible nativement depuis Windows 10 ou via Git Bash.
- Une connexion internet. L’API est accessible via HTTPS sur
api.rodz.io. - Un éditeur de texte (VS Code, Sublime Text, ou tout autre) pour noter vos clés et examiner les réponses JSON.
- (Optionnel) Un client API graphique comme Postman ou Insomnia, si vous préférez une interface visuelle pour tester vos requêtes.
Étape 1 : Créer votre compte et récupérer votre clé API
Créer votre compte
Rendez-vous sur app.rodz.io/register et remplissez le formulaire d’inscription. Vous recevrez un email de confirmation. Cliquez sur le lien pour activer votre compte.
Localiser votre clé API
Une fois connecté au dashboard Rodz :
- Cliquez sur votre avatar en haut à droite
- Sélectionnez Paramètres puis API
- Votre clé API s’affiche dans la section Clés d’accès
- Cliquez sur Copier pour la placer dans votre presse-papier
Votre clé API ressemble à ceci :
rz_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6Règles de sécurité importantes :
- Ne partagez jamais votre clé API publiquement (pas de commit dans un dépôt Git public)
- Stockez-la dans une variable d’environnement ou un gestionnaire de secrets
- Chaque clé est liée à votre compte et à vos permissions. Si vous suspectez une fuite, régénérez-la immédiatement depuis le dashboard
Pour stocker votre clé dans une variable d’environnement, ajoutez cette ligne à votre fichier ~/.bashrc ou ~/.zshrc :
export RODZ_API_KEY="your_api_key_here"Rechargez ensuite votre terminal :
source ~/.bashrcÉtape 2 : Comprendre l’authentification Bearer token
L’API Rodz utilise l’authentification par Bearer token. Chaque requête HTTP doit inclure un en-tête Authorization contenant votre clé API précédée du mot-clé Bearer.
Le format est le suivant :
Authorization: Bearer your_api_key_hereCe mécanisme est standard dans les API REST modernes. Le serveur vérifie la validité du token à chaque requête. Si le token est absent, invalide ou expiré, l’API renvoie une erreur 401 Unauthorized.
Pourquoi Bearer token ?
Le Bearer token offre plusieurs avantages par rapport à d’autres méthodes d’authentification :
- Simplicité d’implémentation : un seul en-tête HTTP suffit
- Compatibilité universelle : fonctionne avec tous les clients HTTP (cURL, Postman, fetch, axios, etc.)
- Sans état (stateless) : le serveur n’a pas besoin de maintenir une session, ce qui améliore les performances
Étape 3 : Envoyer votre première requête API
Commençons par une requête simple. Nous allons interroger l’endpoint qui liste les types de signaux disponibles sur la plateforme.
Requête : lister les types de signaux
Ouvrez votre terminal et exécutez la commande suivante :
curl -X GET "https://api.rodz.io/v1/signals/types" \
-H "Authorization: Bearer your_api_key_here" \
-H "Accept: application/json"Si vous avez configuré la variable d’environnement :
curl -X GET "https://api.rodz.io/v1/signals/types" \
-H "Authorization: Bearer $RODZ_API_KEY" \
-H "Accept: application/json"Décortiquer la commande
curl -X GET: envoie une requête HTTP GET"https://api.rodz.io/v1/signals/types": l’URL de l’endpoint. Le préfixe/v1/indique la version de l’API-H "Authorization: Bearer ...": l’en-tête d’authentification-H "Accept: application/json": indique au serveur que vous attendez une réponse au format JSON
Réponse attendue
Si tout est correct, vous recevrez une réponse HTTP 200 OK avec un corps JSON similaire à celui-ci :
{
"status": "success",
"data": {
"signal_types": [
{
"id": "fundraising",
"name": "Levée de fonds",
"description": "Détecte les entreprises ayant récemment réalisé une levée de fonds",
"category": "financial",
"available_filters": ["amount_min", "amount_max", "sector", "location"]
},
{
"id": "hiring",
"name": "Recrutement",
"description": "Détecte les entreprises publiant activement des offres d'emploi",
"category": "hr",
"available_filters": ["job_title", "department", "sector", "location"]
},
{
"id": "management_change",
"name": "Changement de dirigeant",
"description": "Détecte les nominations et départs de dirigeants",
"category": "organizational",
"available_filters": ["role", "sector", "company_size"]
}
],
"total": 108
}
}Ce résultat vous montre trois choses essentielles :
- Chaque signal a un identifiant unique (
id) que vous utiliserez dans vos requêtes suivantes - Les signaux sont catégorisés (financier, RH, organisationnel, etc.)
- Des filtres sont disponibles pour affiner vos recherches selon vos critères de prospection
Étape 4 : Comprendre le format de réponse
Toutes les réponses de l’API Rodz suivent une structure JSON cohérente.
Structure standard d’une réponse réussie
{
"status": "success",
"data": { ... },
"meta": {
"page": 1,
"per_page": 25,
"total": 108,
"total_pages": 5
}
}status:"success"ou"error"data: les données demandées (objet ou tableau selon l’endpoint)meta: les informations de pagination pour les endpoints qui retournent des listes
Structure d’une réponse d’erreur
{
"status": "error",
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"details": null
}
}Le champ code vous donne une valeur programmatique exploitable, tandis que message fournit une explication lisible pour le débogage.
Étape 5 : Gérer les erreurs courantes
Trois codes d’erreur HTTP reviennent régulièrement lors de l’utilisation de l’API. Voici comment les interpréter et les résoudre.
401 Unauthorized
HTTP/1.1 401 UnauthorizedCause : votre clé API est absente, mal formatée ou invalide.
Solutions :
- Vérifiez que l’en-tête
Authorizationest bien présent dans votre requête - Assurez-vous que le format est
Bearer your_api_key_here(avec un espace aprèsBearer) - Régénérez votre clé depuis le dashboard si nécessaire
Pour diagnostiquer le problème, ajoutez l’option -v (verbose) à votre commande cURL :
curl -v -X GET "https://api.rodz.io/v1/signals/types" \
-H "Authorization: Bearer your_api_key_here"403 Forbidden
HTTP/1.1 403 ForbiddenCause : votre clé est valide, mais vous n’avez pas les permissions nécessaires pour accéder à cette ressource.
Solutions :
- Vérifiez que votre abonnement inclut l’accès à l’endpoint demandé
- Certains endpoints sont réservés aux plans Pro et Enterprise
- Contactez l’équipe Rodz si vous pensez que vos permissions sont incorrectes
429 Too Many Requests
HTTP/1.1 429 Too Many RequestsCause : vous avez dépassé le nombre de requêtes autorisées dans la fenêtre de temps définie (rate limiting).
Solutions :
- Consultez les en-têtes de réponse pour connaître vos limites :
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1709654400-
X-RateLimit-Limit: nombre maximum de requêtes par fenêtre -
X-RateLimit-Remaining: requêtes restantes -
X-RateLimit-Reset: timestamp UNIX de réinitialisation du compteur -
Implémentez un mécanisme de retry avec backoff exponentiel
-
Mettez en cache les réponses qui ne changent pas fréquemment (comme la liste des types de signaux)
Pour une documentation complète des endpoints, des limites et de la gestion d’erreurs, consultez la référence API Rodz.
Étape 6 : Aller plus loin
Maintenant que vous savez vous authentifier et envoyer des requêtes, voici les prochaines étapes pour exploiter pleinement l’API.
Configurer votre premier signal
L’étape suivante consiste à créer une configuration de signal adaptée à votre cible commerciale. Par exemple, pour surveiller les levées de fonds dans le secteur SaaS en France :
curl -X POST "https://api.rodz.io/v1/signals/configurations" \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"signal_type": "fundraising",
"name": "Levées de fonds SaaS France",
"filters": {
"sector": "saas",
"location": "FR",
"amount_min": 1000000
},
"delivery": {
"method": "api_polling"
}
}'Le guide complet pour configurer votre premier signal est disponible dans l’article Configurer son premier signal d’affaires via l’API Rodz.
Recevoir les signaux en temps réel
Plutôt que d’interroger l’API régulièrement (polling), vous pouvez configurer un webhook pour recevoir les signaux automatiquement dès leur détection. Cela réduit la latence et simplifie votre architecture.
Consultez notre guide dédié : Recevoir des signaux en temps réel avec les webhooks Rodz.
Intégrer les signaux dans votre CRM
Les signaux récupérés via l’API peuvent alimenter directement votre CRM. Les intégrations les plus courantes passent par :
- Un script personnalisé qui interroge l’API et crée des tâches ou des contacts dans votre CRM
- Un outil d’automatisation comme Make qui orchestre le flux entre l’API Rodz et vos outils
- Les webhooks combinés à un middleware pour transformer les données avant injection
Questions fréquentes
L’API Rodz est-elle gratuite ?
L’API est incluse dans les abonnements Rodz. Le nombre de requêtes autorisées et les endpoints accessibles dépendent de votre plan. Créez un compte sur app.rodz.io/register pour découvrir les options disponibles.
Quelle est la différence entre l’API et le dashboard Rodz ?
Le dashboard est une interface visuelle pour consulter et configurer vos signaux manuellement. L’API offre les mêmes fonctionnalités, mais de manière programmatique. Elle est conçue pour les équipes qui veulent automatiser l’intégration des signaux dans leurs workflows existants.
Puis-je utiliser l’API avec Python, JavaScript ou un autre langage ?
Oui. L’API est une API REST standard accessible via HTTPS. Tout langage capable d’envoyer des requêtes HTTP peut l’utiliser. Voici un exemple rapide en Python :
import requests
headers = {
"Authorization": "Bearer your_api_key_here",
"Accept": "application/json"
}
response = requests.get("https://api.rodz.io/v1/signals/types", headers=headers)
data = response.json()
for signal_type in data["data"]["signal_types"]:
print(f"{signal_type['id']}: {signal_type['name']}")Comment régénérer ma clé API ?
Connectez-vous au dashboard Rodz, accédez à Paramètres > API, puis cliquez sur Régénérer la clé. L’ancienne clé sera immédiatement invalidée. Pensez à mettre à jour tous vos scripts et intégrations avec la nouvelle clé.
Quelles sont les limites de requêtes (rate limits) ?
Les limites varient selon votre plan. Les en-têtes X-RateLimit-* de chaque réponse vous indiquent vos limites actuelles et le nombre de requêtes restantes. Pour connaître les détails complets, consultez la référence API.
L’API supporte-t-elle la pagination ?
Oui. Les endpoints qui retournent des listes supportent la pagination via les paramètres page et per_page :
curl -X GET "https://api.rodz.io/v1/signals/types?page=2&per_page=10" \
-H "Authorization: Bearer your_api_key_here"Les informations de pagination sont incluses dans l’objet meta de la réponse.
Les données de l’API sont-elles conformes au RGPD ?
Oui. Rodz traite exclusivement des données d’entreprises issues de sources publiques. Aucune donnée personnelle au sens du RGPD n’est collectée sans base légale. Pour en savoir plus, consultez notre article sur le RGPD et les signaux d’affaires.
Où trouver la documentation complète de l’API ?
La documentation technique complète, avec la liste de tous les endpoints, les paramètres acceptés et les exemples de réponses, est disponible sur api.rodz.io/docs.
Commencez à exploiter les signaux d’affaires par API
Vous avez maintenant les bases pour interagir avec l’API Rodz : authentification, première requête, compréhension des réponses et gestion des erreurs. L’étape suivante est de configurer votre premier signal pour commencer à recevoir des opportunités commerciales qualifiées.
Pour explorer tous les endpoints disponibles, consultez la documentation API complète.
Besoin d’aide pour intégrer l’API dans votre stack technique ? Réservez un appel avec notre équipe pour un accompagnement personnalisé.