Comment utiliser l'API Oplead ?

Accès à la Documentation API

Pour accéder à la documentation complète de l'API Oplead, veuillez cliquer sur le lien suivant : https://api.oplead.com/documentation/index.html

Cette documentation utilise Swagger pour offrir une interface interactive qui permet d'explorer et de tester les différentes méthodes API disponibles.

Pour des détails techniques sur l'import de leads via l'API, consultez notre page détaillée à destination des développeurs web.

Fonctionnalités Principales de l'API Oplead

1. Gestion des leads :
   - Endpoint : `/leads`
   - Description : Permet de créer et récupérer des informations sur les leads.

2. Import de Pièces Jointes :
   - Endpoint : `/leads/{leadIdentifier}/document/add`
   - Description : Permet d'importer des pièces jointes, telles que des devis ou factures, pour un lead spécifique.

3. Gestion des statuts
   - Endpoint : `/leads/{leadIdentifier}/status`
   - Description : Permet de mettre à jour le statut d'un lead, pour le passer au statut "En cours" ou "Nurserie".

 

4. S'abonner à des webhooks (retours d'informations automatisés):

- Endpoint : `/subscriptions`

- recevoir les nouveaux leads attribués

- recevoir les changements de statut des leads

- recevoir les MAJ de RDV sur les lead

 

5. Organiser une boucle de retour dès l'import des leads : 

- Vous êtes fournisseur de leads vers un utilisateur d'Oplead? Vous pouvez lui envoyer vos leads directement dans sa solution de gestion, et avoir un retour automatisé de l'état de traitement de vos leads à intégrer à votre propre système.

- Vous êtes utilisateur d'Oplead et vous recevez des leads de la part d'un fournisseur, fabricant, réseau? Demandez lui de vous envoyer directement ses leads sur votre plateforme Oplead : vous gagnerez du temps sur le traitement, et il aura un retour d'info sans que vous ayez à MAJ son intranet/espace pro ou autre système 😁

- Comment? 

Lors de l’import du lead (cf point 1, Endpoint : `/leads`), indiquer le nom du [Fournisseur] du lead dans le champs provider.name, et l’url d’endpoint sur laquelle vous souhaitez recevoir les MAJ de statut de ce lead dans provider.url.

 

Limites de Requêtes

Veuillez noter que la limite de requêtes est fixée à 100 par minute. Assurez-vous de gérer vos requêtes en conséquence pour éviter les dépassements de limite.

FAQ

Question : Comment obtenir un token d'authentification ?
Réponse : 

• Un token d'accès à l'API est requis, il est disponible dans les paramétrages (roue crantée), menu API, onglet par défaut "API Oplead". 

 

Plusieurs types de tokens sont disponibles en fonction de l'accès que vous souhaitez donner : 

1. Accès à un fournisseur de lead -> il pourra vous envoyer des leads, et recevoir le retour automatisé uniquement sur ces leads. Il pourra également consulter la configuration de votre plateforme pour savoir par exemple quels canaux marketing vous avez configuré et il pourra utiliser pour son envoi de leads, ou encore quels sont vos champs personnalisés si vous souhaitez collecter des informations complémentaires liés à la demande.
   1. Pour créer un accès à un nouveau fournisseur, cliquez sur le bouton identifié par la bulle 3 dans l'image ci-dessous; et copiez la clé du fournisseur pour lui envoyer.
2. Accès interne ou pour un partenaire qui pourra à la fois créer des leads, modifier des leads, ou encore voir tous vos leads et vos statistiques : 
   1. Il existe une clé API par utilisateur, car ils ne voient pas les tous mêmes leads => Pour accéder aux leads d'un utilisateur en particulier, utilisez sa clé API. Pour accéder à tous les leads de la plateforme, utilisez la clé de l'admin client (recommandation standard). Copiez ensuite la clé API de l'utilisateur souhaité via le bouton indiqué par la bulle 4 dans l'image ci-dessous.

 

Question : Puis-je importer des devis et des factures ?
Réponse : Oui, utilisez l'endpoint `/leads/{leadId}/attachments` pour importer des pièces jointes telles que des devis et factures.

Question : Cette intégration peut-elle modifier le statut du lead à "devis à relancer" ?
Réponse : Oui, l'intégration peut modifier le statut du lead à "devis relancer".
Les fonctionnalités en cours de développement incluent la possibilité de changer le statut du lead lors de l'importation ou de l'upload de pièces jointes.

Question : Peut-on enregistrer l'identifiant de click des annonceurs en ligne Google Ads, Meta Ads, etc... (Gclid, fbclid, etc...) ?
Réponse : Oui, nous vous recommandons d'envoyer ces informations dans le champs externalID dans la section leadData. Vous pouvez ensuite utilisez les webhooks ou des appels APIs dédiés pour renvoyer les identifiants de clicks aux outils de gestion des annonceurs (Google Ads, Meta Ads).

Voir l'article :Pourquoi connecter Oplead aux régies publicitaires

De la même manière, vous pouvez aussi enregistrer les UTMs (utm_source, utm_medium et utm_campaign) sur des champs dédiés.