REDA One Centre d’aide
FR
Langue
English EN Español ES Português PT Italiano bientôt disponible Français FR Deutsch bientôt disponible العربية bientôt disponible
reda.one ↗
Accueil / REDA One / Intégrations / API et données / REDA Data Service : connecter vos formulaires

REDA Data Service : connecter vos formulaires

Un formulaire externe — formulaire de contact du site marketing, page de campagne ou microsite Webflow — peut alimenter REDA avec les coordonnées du prospect et les informations d’attribution. Le Data Service est le moteur de réception web inclus dans REDA : une intégration compatible transmet une requête, REDA vérifie les autorisations configurées, puis les correspondances de champs servent à créer ou à mettre à jour un enregistrement en arrière-plan. La connexion peut nécessiter un adaptateur côté serveur ; sa mise en place dépend de votre outil de formulaires. Ce guide s’adresse à l’administrateur ou au développeur web chargé de cette connexion. Il présente l’adresse de destination, l’authentification, le format des données, les champs préconfigurés pour les demandes web et le diagnostic des échecs. Comme il s’adresse aux intégrateurs, il conserve les adresses et paramètres techniques à utiliser.

Accès. Un administrateur configure le Data Service, puis l’intégration de votre site l’appelle. Pour rechercher les erreurs de traitement journalisées, ouvrez le Lanceur d’application (l’icône en grille en haut à gauche) → REDA Admin → l’onglet Journaux asynchrones REDA.
Droits nécessaires. L’activation du service et la définition des opérations acceptées relèvent de l’administration. L’ensemble d’autorisations REDA - Master Data - Read Only, ou des droits équivalents, permet de consulter ces journaux. L’administrateur doit configurer et sécuriser l’accès au service depuis le site public. Le visiteur n’a pas besoin de se connecter à REDA pour soumettre le formulaire ; l’intégration doit néanmoins respecter les contrôles définis.
Ne publiez jamais une clé d’API. Les exemples utilisent des valeurs fictives. La clé de réception est un secret propre à l’environnement : traitez-la comme un mot de passe. Conservez-la dans l’adaptateur côté serveur, jamais dans le code envoyé au navigateur, un dépôt public ou une capture d’écran. Remplacez-la si elle a été exposée. Une valeur de démonstration ne convient pas à la production. Si vous autorisez les mises à jour, l’intégration doit aussi vérifier que le demandeur peut modifier l’enregistrement ciblé.
Vous utilisez l’édition REDA Sales Cloud ? Les exemples d’URL ci-dessous utilisent l’édition Platform, où le prospect est une Demande (objet Salesforce standard Lead dans Sales Cloud) et l’intervention une Demande de service (objet standard Case). Les noms d’API et les préfixes diffèrent : Platform utilise reda1 et reda1__Inquiry__c ; Sales Cloud utilise reda et Lead. Adaptez aussi les noms de champs à votre édition. Consultez les éditions REDA.

Fonctionnement

Le Data Service reçoit la requête de votre formulaire, vérifie qu’elle est autorisée, puis la transmet au traitement qui construit l’enregistrement. L’acceptation et l’écriture sont deux étapes distinctes :

Le formulaire transmet la requête. Un visiteur soumet le formulaire ; l’intégration côté serveur transmet les valeurs à l’adresse du service REDA.
REDA vérifie les autorisations. Le service est-il activé ? L’objet cible et la méthode sont-ils autorisés ? La clé est-elle correcte si elle est exigée ? La création ou la modification est-elle permise ? Si un contrôle échoue, REDA renvoie une erreur sans transmettre la demande au traitement d’écriture.
REDA accepte et met en file d’attente. Si les contrôles et la publication de l’événement réussissent, REDA renvoie success puis l’événement est traité en arrière-plan. Le formulaire n’attend pas la création de l’enregistrement ; vérifiez ensuite le résultat.
Les correspondances construisent l’enregistrement. REDA applique d’abord les valeurs par défaut, puis les valeurs reçues pour les paramètres configurés, et tente d’enregistrer le résultat.

La réponse success signifie donc « requête acceptée », et non « enregistrement créé ». Vérifiez ensuite l’enregistrement attendu. Les erreurs interceptées pendant son écriture font l’objet d’une tentative de journalisation dans les journaux asynchrones ; consultez En cas d’échec.

Le délai dépend du traitement des événements et de la charge. Lors d’un pic de soumissions, par exemple après l’envoi d’une campagne, les enregistrements peuvent apparaître après les réponses d’acceptation. Cette réponse ne garantit ni un délai précis ni la réussite de l’écriture ; rapprochez les soumissions attendues des enregistrements et des erreurs disponibles.

Activation et contrôles d’accès

Avant qu’un formulaire puisse alimenter REDA, quatre contrôles doivent être satisfaits. Les requêtes GET et POST passent ces contrôles ; sur ce service, toutes deux servent à transmettre des données pour création ou modification, et non à lire des enregistrements :

ContrôleVérification
Interrupteur généralLe service doit être activé dans l’organisation : le paramètre IS_ENABLED doit valoir 1. Vérifiez la configuration de votre environnement. Sinon, le service renvoie un message indiquant qu’il est désactivé.
Objet cibleLe nom d’API figurant dans l’adresse doit désigner un objet existant, par exemple l’objet des demandes. Il ne s’agit pas d’un type d’enregistrement Salesforce (RecordType).
Autorisations par objetUne ligne Data Service Setup correspondant à cet objet doit autoriser la méthode utilisée, via Requête GET ou Requête POST, ainsi que l’opération, via Créer un enregistrement ou Modifier l’enregistrement.
AuthentificationSi la ligne de configuration contient une Clé d’authentification, la requête doit fournir la clé correspondante dans son en-tête ; sinon REDA renvoie une réponse 401 d’accès non autorisé.

La configuration du package examinée prévoit les demandes Platform, ou Lead dans Sales Cloud, avec GET, POST, création et modification activés et une clé configurée. La ligne des demandes de service, ou Case dans Sales Cloud, est présente avec ces quatre options désactivées. Vérifiez les valeurs effectivement installées avant tout raccordement. Le même mécanisme permet de configurer d’autres objets, comme expliqué dans Ajouter des objets et des sources au Data Service.

Adresse du service

L’adresse de destination désigne l’objet cible et la source de données : cette valeur regroupe les correspondances d’une famille de formulaires, indépendamment des autres sources. Le modèle d’adresse pour Platform est le suivant :

<Your Site URL>/services/apexrest/reda1/dataservice/<Record Type>/<Data Source>

Pour la réception web préconfigurée, l’objet Platform est reda1__Inquiry__c et la source Web. L’adresse se termine donc ainsi :

.../dataservice/reda1__Inquiry__c/Web

Le début de l’adresse est l’URL du site configuré par votre administrateur. Pour Sales Cloud, le chemin correspondant est /services/apexrest/reda/dataservice/Lead/Web. Une requête acceptée renvoie 200 avec une réponse contenant {"success": true}. Un contrôle de configuration ou d’opération peut produire une réponse 400 accompagnée d’un message ; un service désactivé renvoie également 400. Une clé incorrecte produit le code 401 indiqué ci-dessus.

Format de la requête

Utilisez une requête POST pour le formulaire. Son corps est une liste JSON de paires clé/valeur, à raison d’une entrée par champ transmis :

[
  {"key": "FirstName", "value": "Aisha"},
  {"key": "LastName",  "value": "Rahman"},
  {"key": "Email",     "value": "aisha@example.com"}
]

Si l’authentification est configurée, l’adaptateur côté serveur fournit la clé dans l’en-tête x-api-key. Une requête GET peut aussi transmettre les valeurs en paramètres d’URL lorsque cette méthode est autorisée. Elle déclenche le même mécanisme d’écriture : ce n’est pas une API de lecture. Privilégiez POST pour les formulaires.

La présence du paramètre recordId détermine si le contrôle d’autorisation exige la création ou la modification. Pour mettre à jour un enregistrement, ce paramètre doit en outre être associé au champ Id et contenir un identifiant valide et autorisé.

Votre requêteOpération attendueOption requise
Sans recordIdCréation, si les correspondances et données permettent l’écritureCréer un enregistrement activé
Avec recordIdMise à jour si le paramètre est associé à Id et contient un identifiant valideModifier l’enregistrement activé

Si vous envoyez recordId alors que Modifier l’enregistrement est désactivé, ou demandez une création alors que Créer un enregistrement est désactivé, REDA répond "DML Operation not supported.". L’opération demandée n’est pas autorisée dans la ligne de configuration. La simple présence de recordId ne garantit pas qu’une mise à jour sera réalisée : vérifiez sa correspondance et sa valeur.

Correspondances web préconfigurées

Une correspondance relie une clé du formulaire à un champ REDA. La configuration Web examinée comprend 21 paramètres couvrant les coordonnées, la provenance et l’attribution marketing. Les clés reconnues alimentent les champs configurés si leurs valeurs sont valides. Deux champs ont une valeur par défaut : les valeurs par défaut sont appliquées d’abord, puis remplacées par les valeurs reçues pour les paramètres correspondants.

GroupeClés à transmettreDestinationValeur par défaut
ContactFirstName, LastName, Email, PhonePrénom, nom, e-mail et téléphone—
SociétéCompanySociété--NA--
SourceLeadSourceSource de la demande ou de la piste, selon l’éditionWeb
Identifiant de mise à jourrecordIdChamp Id de l’enregistrement à modifier—
Campagne (UTM)utm_campaign, utm_content, utm_id, utm_medium, utm_source, utm_termLes six champs UTM—
Identifiants de clic publicitairefbclid, gclid, msclkid, ttclidChamps d’identifiant de clic Facebook, Google, Microsoft et TikTok—
Contexte webform_id, landing_page, referral_url, session_idIdentifiant du formulaire web, page de destination, URL de provenance et identifiant de session—

Il n’est pas nécessaire d’envoyer les 21 paramètres : transmettez ceux que le formulaire recueille, en satisfaisant les champs obligatoires et les règles de votre organisation. La source Web regroupe ces correspondances ; une autre famille de formulaires peut utiliser une autre source et ses propres clés pour le même objet.

Collecter l’attribution ne suffit pas à connecter un réseau publicitaire. Les valeurs UTM et les identifiants de clic sont enregistrés pour l’analyse des campagnes. Leur réception par Data Service ne configure pas, à elle seule, un retour de conversion vers les plateformes publicitaires. Le connecteur publicitaire et ses paramètres constituent un parcours distinct.

En cas d’échec : journaux asynchrones

L’écriture intervient après la réponse d’acceptation. Vérifiez donc l’enregistrement attendu et, en cas d’absence, les journaux asynchrones. Lorsqu’une erreur d’écriture est interceptée — champ obligatoire manquant ou règle de validation, par exemple — le traitement annule l’écriture et tente de créer un journal d’erreur. Une absence de journal ne constitue pas une preuve de réussite.

Un journal d’échec créé par ce traitement indique l’objet et la source, le nombre d’échecs, la requête et les détails de l’exception. Utilisez ces éléments pour corriger le formulaire ou les données, puis soumettez à nouveau après avoir vérifié qu’aucun enregistrement n’a déjà été créé. Le traitement ne prévoit pas de nouvelle tentative automatique. Pour comprendre les journaux, l’indicateur d’attention et les alertes administrateur, consultez Comprendre les journaux asynchrones REDA.

Exemple : une page de campagne

Meridian Properties utilise une page de campagne de location estivale. Lorsqu’un prospect soumet le formulaire, l’adaptateur côté serveur envoie la requête suivante à .../dataservice/reda1__Inquiry__c/Web, avec la clé de Meridian dans l’en-tête x-api-key :

[
  {"key": "FirstName",    "value": "Aisha"},
  {"key": "LastName",     "value": "Rahman"},
  {"key": "Email",        "value": "aisha@example.com"},
  {"key": "utm_source",   "value": "google"},
  {"key": "utm_campaign", "value": "summer-lease"},
  {"key": "gclid",        "value": "..."}
]

REDA renvoie 200 {"success": true} pour l’acceptation. Si l’écriture aboutit, une demande Aisha Rahman apparaît ensuite, avec la source Web, la campagne et l’identifiant de clic Google. Vérifiez ces données dans l’enregistrement avant de considérer le test comme réussi.

Pour mettre à jour. Si Aisha transmet ensuite son téléphone, l’intégration peut ajouter {"key": "recordId", "value": "<her inquiry's id>"}. Après contrôle du droit à modifier cette demande, et avec la correspondance vers Id et l’option de modification activées, le traitement met à jour l’enregistrement existant si les données sont valides.

En cas d’échec. Si un champ obligatoire manque et que l’écriture est refusée, le traitement tente de créer un journal contenant la requête et l’erreur. Consultez ce journal pour corriger le formulaire ; si vous ne trouvez ni enregistrement ni journal, poursuivez le diagnostic avec l’administrateur.

Pour aller plus loin

  1. Ajouter des objets et des sources au Data Service — connecter un autre objet ou séparer les familles de formulaires.
  2. Demandes web et demandes de visite — comprendre l’autre parcours de réception depuis les annonces REDA.
  3. Comprendre les journaux asynchrones REDA — lire les détails des erreurs de traitement.
  4. Accéder aux données REDA avec les API Salesforce — découvrir les API de lecture et d’écriture authentifiées.
  5. Rechercher et fusionner les demandes en double — traiter les doublons lorsqu’un prospect soumet plusieurs formulaires.

Questions fréquentes

La ligne Data Service Setup de l’objet exige une clé et celle fournie dans l’en-tête x-api-key ne correspond pas. Vérifiez que l’adaptateur côté serveur utilise la clé actuelle du bon environnement.

La réponse confirme l’acceptation, pas l’écriture. Vérifiez le délai de traitement, recherchez l’enregistrement et consultez les journaux asynchrones pour identifier une éventuelle erreur et la requête concernée. Si ni l’enregistrement ni un journal n’est visible, faites vérifier le traitement et vos droits par l’administrateur.

L’opération n’est pas autorisée : présence de recordId sans Modifier l’enregistrement, ou création sans Créer un enregistrement. L’administrateur doit vérifier l’opération réellement nécessaire et la configuration de l’objet avant d’activer l’option correspondante.

Oui. Chaque source de données dans l’adresse sélectionne son groupe de correspondances. Plusieurs formulaires peuvent donc alimenter le même objet avec des jeux de clés différents. Consultez Ajouter des objets et des sources au Data Service.

Non. Définissez une clé propre à l’environnement dans la ligne Data Service Setup de chaque objet concerné, conservez-la côté serveur et remplacez-la immédiatement en cas d’exposition.

Cet article vous a-t-il été utile ?