Connexion à l'API Guest Profile pour l'inscription à une newsletter depuis votre site internet

Connexion à l'API Guest Profile pour l'inscription à une newsletter depuis votre site internet

Introduction

D-EDGE CRM propose une API permettant aux partenaires d’accéder aux données des profils clients via Guest Profile. Cette API facilite l’intégration avec des services tiers tout en respectant les règles de sécurité et de confidentialité des données.

Ce guide explique en détail le processus permettant à un partenaire d'obtenir l’accès à l'API Guest Profile et de l'utiliser efficacement. Certaines étapes nécessitent une intervention de l'équipe D-EDGE CRM, qui sera mentionnée dans ce document.


Alert
Important : D-EDGE CRM fournit une API flexible pour l'inscription à la newsletter, mais ne propose pas de widget d'inscription intégré ; l'implémentation du widget doit être gérée par votre agence web.

1. Vérifications préalables et demande d'accès

Avant de pouvoir utiliser l'API Guest Profile, le partenaire doit remplir certaines conditions et effectuer une demande d'accès officielle.

1.1. Vérifications nécessaires

Avant d’entamer le processus, il est essentiel de s’assurer que :

  • Le partenaire travaille bien avec l’hôtel et a l’autorisation d’accéder aux données clients.
    • Un email envoyé par la direction de l'établissement, attestant de cette collaboration, peut vous être demandé.
  • Le client final possède un abonnement D-EDGE CRM incluant Guest Profile (plans Insight, Enterprise, etc.).
  • Le partenaire a soumis une demande d'accès via le formulaire dédié :
    Formulaire de demande d'accès API Guest Profile

Une fois ces vérifications effectuées, D-EDGE CRM peut initier la création des accès.

Info
Le remplissage du formulaire est obligatoire pour un nouveau partenaire.


2. Création des accès API

L'équipe D-EDGE CRM intervient à cette étape pour fournir les accès nécessaires.


2.1. Création d'un identifiant D-EDGE CRM ID

Le partenaire doit posséder un compte D-EDGE CRM ID pour accéder à la documentation et utiliser l'API.
➡ Action D-EDGE CRM : Création d’un compte D-EDGE CRM ID pour le partenaire et envoi d’un email contenant les informations de connexion.


2.2. Accès à la documentation

La documentation complète de l’API Guest Profile est disponible ici :
📄 Documentation API Guest Profile

Elle détaille toutes les fonctionnalités disponibles ainsi que les appels API nécessaires.

2.3. Création d'un client OAuth

Pour que le partenaire puisse authentifier ses requêtes API, il doit utiliser un client OAuth.
➡ Action D-EDGE CRM : Création et communication du client OAuth au partenaire.


2.4. Attribution des droits API

Une fois le client OAuth créé, D-EDGE CRM attribue les permissions adéquates au partenaire.
➡ Action D-EDGE CRM : Attribution du droit d’écriture sur Guest Profile.

À l’issue de ces étapes, le partenaire est prêt à utiliser l’API Guest Profile.


3. Utilisation de l'API Guest Profile

Une fois les accès obtenus, le partenaire peut commencer à interagir avec l'API. Voici les principales étapes :

3.1. Authentification et obtention du token OAuth

L’identification se fait via un appel API au serveur D-EDGE CRM ID :

  1. curl --request POST \
      --url '
  2. https://id.loungeup.com/realms/production/protocol/openid-connect/token' \
      --header 'content-type: application/x-www-form-urlencoded' \
      --data grant_type=client_credentials \
      --data client_id=CLIENT_ID \
      --data client_secret=CLIENT_SECRET
  3.   --header 'content-type: application/x-www-form-urlencoded' \
      --data grant_type=client_credentials \
      --data client_id=CLIENT_ID \
      --data client_secret=CLIENT_SECRET

Réponse attendue :

  1. {
      "access_token": "eyJ...XXXXXX",
      "expires_in": 300,
      "token_type": "Bearer"
    }

Le token OAuth obtenu est valable 5 minutes et doit être inclus dans les appels API.



3.2. Vérification de l’existence d’un profil client

Avant de créer un nouveau profil, il est recommandé de vérifier si l’email est déjà enregistré :

  1. POST https://svc.loungeup.com/api/guestprofile/entities/ENTITY_ID/guests/search-by-contact
  2. Authorization: Bearer eyJ...XXXXXX
    Content-Type: application/json

    {
      "match": "all",
      "sources": [{"source": "website"}],
      "emails": [{"value": {"email": "
  3. john.doe@email.com"}}]
    }
  4. }

Réponses possibles :

  • ❌ 404 Not Found : L'email n'est pas inscrit, il peut être ajouté.
  • ✅ 200 OK : L'email est déjà enregistré, inutile de poursuivre.

3.3. Création d’un profil client

Si l’email n’est pas encore enregistré, il peut être ajouté avec un appel API :

  1. POST https://svc.loungeup.com/api/guestprofile/entities/ENTITY_ID/guests/create
  2. Authorization: Bearer eyJ...XXXXXX
    Content-Type: application/json

    {
      "sources": [{"source": "website"}],
      "emails": [{"value": {"email": "
  3. john.doe@email.com"}, "from": "guest"}]
    }
  4. }

Réponse attendue :
✅ 200 OK – Inscription réussie.


4. Suivi et gestion des accès

Une fois la connexion effectuée, il est important de maintenir les accès et de les mettre à jour en cas de besoin.


4.1. Vérification de l’existence d’un client dans Guest Profile

Le partenaire peut consulter les profils directement via D-EDGE CRM :


🔍 Vérification des profils existants
👉 Accédez à :
https://my.loungeup.com/entities/ENTITY_ID/guests
Recherchez par nom, prénom ou email pour retrouver un profil client.

4.2. Maintien des accès et mises à jour

  • D-EDGE CRM peut modifier les droits ou révoquer des accès en cas de besoin.
  • Toute modification importante de l'API est documentée sur la documentation officielle.
  • En cas de problème, le support D-EDGE CRM est disponible pour assistance.