Intégration complète des utilisateurs dans Oplead : webhook, batch et gestion des critères

Apprenez à intégrer automatiquement vos utilisateurs dans la plateforme Oplead avec ou sans webhook, à gérer les mises à jour, et à configurer les règles d’attribution métier via l’API REST.

Pré-requis

Avant de commencer :

• Obtenez un token API valide (via l’administrateur de plateforme)

• Ayez un outil de test API : curl, Postman, etc.

• Consultez la documentation Swagger d’Oplead (onglet "Schema")

• Respectez les règles obligatoires pour un utilisateur :

  • civility, lastname, login, email valides

  • une adresse complète (pays, code postal, ville)

  • un profile utilisateur valide (GET /v1/settings/user-profiles)

  • un parentUserIdentifier cohérent avec la hiérarchie des profils

CAS 1 — Intégration via Webhook (temps réel)

Flux général

1. Webhook émis depuis le système source à chaque création/mise à jour utilisateur.

2. Traitement middleware qui appelle :

   • POST /v1/users si l'utilisateur n'existe pas

   • PUT /v1/users/{userIdentification} s’il est déjà présent

3. Réponse API confirme la synchronisation

CAS 2 — Intégration via Batch (polling régulier)

Flux par tâche planifiée

1. Le script interroge périodiquement l’API du système source

2. Il récupère les données utilisateurs à jour

3. Il effectue les appels :

   • POST /v1/users (si nouveau)

   • PUT /v1/users/{userIdentification} (si modification)

4. Il valide la réponse API

Gestion de l’identifiant utilisateur

Si vous ne stockez pas l’ID retourné lors du POST, utilisez un identifiant externe via accountNumber (unique).

Stratégie :

• Tentez un PUT via accountNumber

• Si 404, alors créez l’utilisateur avec POST

Règles d’attribution des leads via API

Ces critères ne sont pris en compte que si activés sur votre plateforme Oplead.

1. Critères Géographiques

Définit les zones géographiques couvertes par un utilisateur.

Endpoints :

• GET /v1/types/countries

• GET /v1/types/country/{code}

• PUT /v1/users/{id}/rule/geographical

{
  "handledCountries": [
    {
      "handledCountry": { "code": "FR" },
      "handledCounties": [
        {
          "handledCounty": { "number": "75" },
          "handledPostCodeZips": ["75001", "75002"]
        }
      ]
    }
  ]
}

2. Rayon de couverture (maxDistance)

Définit une distance max en km entre utilisateur et lead.

// PUT /v1/users/{id}/rule/max-distance
{ "maxDistance": 30 }

3. Compétences (Ranges et Request Types)

• Si seul Range est activé :

[
  { "range": { "code": "RNG_XXX" } },
  { "range": { "code": "RNG_YYY" } }
]

• Si Range + Request Type sont activés :

[
  { "range": { "code": "RNG_XXX" }, "requestType": { "code": "RTY_XXX" } },
  { "range": { "code": "RNG_YYY" }, "requestType": { "code": "RTY_YYY" } }
]

4. Profils de contact

• Codes de profils de contact : GET /v1/settings/contact-profiles

• Affectation à un user : 

[
  { "code": "CPR_XXX" },
  { "code": "CPR_YYY" }
]

5. Types de profils de contact (pro / single)

// PUT /v1/users/{id}/rule/profile-types
["pro", "single"]

Bonnes pratiques & recommandations

• Protéger votre clé API : Ne jamais exposer la clé dans du code côté client ou dans des URL accessibles.

• Utiliser les code plutôt que les labels : Les code (ex : FR, RNG_XXX) sont stables et indépendants de la langue, contrairement aux libellés.

• Tester avec test=true : Ce paramètre permet de simuler des appels API sans modifier les données réelles (sandbox intégrée).

• Sauvegarder l’identifiant utilisateur Oplead : Cela permet de savoir si l'utilisateur a déjà été créé et d’éviter les doublons.

• Utiliser accountNumber si ID non stocké : Cet identifiant unique vous permet de retrouver un utilisateur sans dépendre de l’ID interne Oplead.

• Limiter la fréquence des mises à jour en batch : Évitez d’interroger l’API plus d’une fois par jour, sauf si vous limitez fortement le volume d’appels.

• Remonter les erreurs 500 via l’admin : En cas de retour serveur non documenté, contactez votre administrateur pour escalade vers l’équipe Care.

Pourquoi industrialiser l’intégration utilisateur dans Oplead ?

• 🚀 Automatisation : plus besoin de saisie manuelle dans l’interface — les utilisateurs sont créés ou mis à jour automatiquement.
• 🔄 Mise à jour en temps réel (via Webhook) : dès qu’un utilisateur est modifié dans le système source, l’information est propagée dans Oplead sans délai.
• 📈 Scalabilité : gère facilement des centaines ou milliers d’utilisateurs via scripts ou connecteurs API.
• 🧠 Attribution intelligente : les leads sont automatiquement assignés grâce aux règles : géographie, compétences, profils de contact...
• 🛡️ Sécurité : authentification par token, sandbox (test=true), séparation des environnements prod/test.
• 🧩 Flexibilité : chaque entreprise peut adapter son modèle d’intégration (batch, webhook, mixte) selon ses contraintes techniques.