Passer au contenu principal

API - Qualifications (Unitaire)

ℹ️ Voici le lien de la documentation technique (Swagger) ⇒ https://api.pinpo.com/api#/Leads

Envoyez des données depuis vos outils vers Pinpo est la manière la plus flexible d’importer des leads dans PINPO. C'est la “porte entrée de vos qualifications” : vous poussez vos leads vers Pinpo pour que vos agents les traitent. Cette méthode est recommandée pour centraliser vos données depuis vos systèmes internes.

Pour ce faire il vous suffit de cliquer sur le bouton Accéder **dans la carte **Connexion via API KEY.
---

Étape 1 : Sélectionner l'agent destinataire de votre qualification

En haut à droite de la section, un menu déroulant vous permet de choisir l'agent vers lequel les qualifications seront envoyés (par exemple : Sophie - Engager en temps réel). Chaque agent dispose de sa propre URL d'import et de son propre ID.

Étape 2 : Récupérer les informations pour l’appel HTTP

La section Accès API affiche les trois informations nécessaires pour envoyer des contacts à Pinpo depuis votre système :

Important : Votre **API Key **est une clé secrète. Ne la partagez jamais dans du code côté client, dans une URL publique ou dans un email. Traitez-la comme un mot de passe.

Étape 3 : Récupérer un exemple de requête JSON

En bas de la page, un bloc affiche un exemple de requête JSON prêt à copier pour envoyer un contact à l'agent sélectionné.
Un menu déroulant vous permet de choisir le type d'exemple :

  • Minimal - Téléphone — Le payload minimum requis : uniquement le numéro de téléphone du contact.

  • **Minimal - WhatsApp **— Le payload minimum requis : uniquement le whatsAppUserId du contact (uniquement si vous ne détenez que celui-ci, le numéro de téléphone est recommandé)

  • Complet **— Le payload complet contenant toutes les informations sur la qualification.
    **Exemple minimal :

Étape 4 : Envoyer la requête HTTP

  • Vous avez désormais tous les éléments nécessaire à l’envoi de votre requête HTTP POST.

  • Consultez le schema dans la documentation technique afin de comprendre ce qui attendu dans chaque clé et chaque partie du JSON.

Étape 5 : Traiter le retour HTTP

  • Lorsque vous utilisez la route API /agents/{agentId}/qualifications pour importer des leads dans Pinpo, le qualificationId vous sera communiqué dans la réponse de votre requête POST comem mentionné dans la documentation technique : https://api.pinpo.com/api#/Qualifications/ImportQualificationController_execute

  • Il est PRIMORDIAL de traiter les différents code et retour HTTP afin de s’assurer qu’en cas de rejet par l’API PINPO de votre tentative, votre worflow “sait comment gérer” le scas et vous alerte si besoin.


🌟 - Bonnes pratiques

  • Un agent = une URL d'import. Chaque agent possède son propre endpoint. Si vous envoyez des leads de natures différentes (acquisition, réactivation), assurez-vous de les router vers le bon agent via la bonne URL.

  • Transmettez un maximum de données. Le payload minimal (téléphone seul) fonctionne, mais plus vous enrichissez le contact (nom, prénom, email, source marketing, champs personnalisés), plus l'agent sera pertinent dans sa conversation.

  • Protégez votre API Key. Stockez-la dans une variable d'environnement ou un gestionnaire de secrets. Ne la codez jamais en dur dans votre code source.

  • Consultez la documentation. Le bouton Documentation en haut à droite de la page et le lien Documentation dédiée dans la section Accès API vous donnent accès à la référence technique complète. Lisez-la intégralement avant de développer votre intégration.

  • Testez avant la production. Utilisez le mode test pour valider votre intégration de bout en bout, puis basculez sur l'API Key de production une fois que tout fonctionne.

Avez-vous trouvé la réponse à votre question ?