Utiliser l’API d’événements dans les parcours en temps réel

L’API d’événement est une méthode programmatique permettant d’accéder aux données à partir d’événements, de sessions, de suivis de session, de passes, de présentateurs et de parrainages. En outre, l’API d’événement vous permet de vous inscrire aux événements et sessions.

L’API accessible est via le protocole HTTPS et est accessible à partir du point de terminaison d’API que vous recevez lors de la création d’un jeton d’application web. Toutes les données sont envoyées et reçues au format JSON.

S’inscrire à l’API d’événement

Dans la section Paramètres, sousApplications web> événements, créez une application web. Il est important de sélectionner la bonne origine. Par exemple, si vous sélectionnez https://contoso.com, JavaScript hébergé sur un domaine différent ne pourra pas accéder à l’API gestion d’événement.

Capture d’écran des paramètres de l‘API de l’évènement.

Après avoir créé une application web, vous voyez un lien vers la spécification OpenAPI dans Documentation du point de terminaison (version préliminaire).

Capture d’écran du point de terminaison de l’API d’événement.

Vous pouvez sélectionner le lien et copier et coller le contrat d’API dans un éditeur OpenAPI tel que Swagger Editor, qui prégénère automatiquement un wrapper que vous pouvez utiliser pour découvrir votre API. Pour accéder à votre API, vous devez être autorisé (fournir la colonne Jeton).

Capture d’écran de l’éditeur Swagger de l’API d’événement.

Créer une page d’événements ou un portail d’événements

L’API d’événement vous permet de créer une page d’événements personnalisée et un portail d’événements qui répertorie tous les événements disponibles en direct et publiés à l’aide de l’option de publication « Solution personnalisée utilisant l’API d’événement ». L’API d’événement vous permet de :

  • Récupérez la liste des événements en direct qui incluent leur nom, leur description, leur emplacement et leur heure.
  • Pour la page d’événements, elle vous permet de récupérer des informations clés sur l’événement, telles que :
    • Name
    • Time
    • Lieu
    • Code QR d’événement
    • Capacité
    • Liste des sessions
    • Liste des orateurs
    • Liste des commanditaires et de leurs logos

Créer une expérience d’inscription d’événement personnalisée

L’API d’événement vous permet également de créer une soumission d’inscription sans avoir besoin d’utiliser des formulaires marketing en temps réel, tout en bénéficiant toujours de fonctionnalités importantes telles que la stratégie de correspondance, le consentement, les paramètres d’audience, etc.

Tout d’abord, définissez les paramètres clés pour votre audience en accédant à Paramètres>Gestion des événements>Paramètres d'inscription aux événements et définissez :

  1. Audience par défaut
  2. Règle de correspondance par défaut
  3. Profil de conformité par défaut

Les paramètres d’inscription d’événement par défaut sont utilisés lors du traitement des soumissions à partir de l’API. Une fois que vous avez défini les paramètres d’inscription, le point de terminaison de soumission de l’API d’événement vous permet de :

  1. Créez une soumission d’inscription pour un événement :
{ 
    "attendees": [ 
        { 
            "lastName": "Sample Contact Last Name", 
            "firstName": "Sample Contact First Name", 
            "email": "email@contoso.com", 
            "responses": [ 
                { 
                    "id": "jobtitle", 
                    "value": "Sample Contact Job Title" 
                }, 
                { 
                    "id": "customUnmappedField1", 
                    "value": "Sample Custom Unmapped Field 1" 
                }, 
                { 
                    "id": "customUnmappedField2", 
                    "value": "Sample Custom Unmapped Field 2" 
                } 
            ] 
        } 
    ] 
}
  1. Créez une soumission d’inscription pour une session :
{ 
    "attendees": [ 
        { 
            "lastName": "Sample Contact Last Name", 
            "firstName": "Sample Contact First Name", 
            "email": "email@contoso.com", 
            "responses": [ 
                { 
                    "id": "jobtitle", 
                    "value": "Sample Contact Job Title" 
                } 
            ], 
            "attendeeSessions": [ 
                { 
                    "sessionId": "d5f513c6-989f-f011-bbd3-000d3a5b6385" 
                }, 
                { 
                    "sessionId": "f5d4e4b9-989f-f011-bbd3-000d3a5b6385" 
                } 
            ] 
        } 
    ] 
} 
  1. Créez une inscription de liste d’attente :
{
    "attendees": [ 
        { 
            "lastName": "Sample Contact Last Name", 
            "firstName": "Sample Contact First Name", 
            "email": "email@contoso.com", 
            "waitlisted": true, 
            "responses": [ 
                { 
                    "id": "jobtitle", 
                    "value": "Sample Contact Job Title" 
                }, 
                { 
                    "id": "customUnmappedField1", 
                    "value": "Sample Custom Unmapped Field 1" 
                }, 
                { 
                    "id": "customUnmappedField2", 
                    "value": "Sample Custom Unmapped Field 2" 
                } 
            ] 
        } 
    ]
}

Performances et limites

L’API d’événement prend en charge les scénarios d’inscription à volume élevé par le biais d’un traitement asynchrone, d’une mise en cache intelligente et d’une logique de nouvelle tentative intégrée.

Lorsqu’une demande d’inscription arrive via l’API d’événement, le système :

  • Vérifie que l’événement est actif et que toutes les entités associées sont dans un état valide
  • Renvoie immédiatement une réponse de succès à l’appelant.
  • Démarre un processeur de tâches en arrière-plan pour créer l’enregistrement d’événement et les entités associées de façon asynchrone.

Comportement de mise en cache

Cache de lecture : le système applique un cache de 10 minutes pour la validation des événements et des entités. Cela réduit les lectures redondantes dans Dataverse et améliore le débit en charge.

Note

Le cache de lecture affecte uniquement la validation, et non les enregistrements d’inscription eux-mêmes.

Logique de nouvelle tentative et gestion des échecs

Si le processus d’arrière-plan ne parvient pas à créer un enregistrement d’événement, le système réessaie automatiquement pendant un maximum de six heures. Cela s’applique aux scénarios de défaillance synchrone et asynchrone, ce qui garantit la fiabilité des données sans nécessiter d’intervention manuelle.

Limites de débit et de Dataverse

Le facteur de limitation principal pour les scénarios d’inscription sans forme est le taux auquel les entités d’inscription de ticket peuvent être créées dans Dataverse. Dans des conditions normales, Dataverse applique une limite de 6 000 requêtes d’API, dans une fenêtre glissante de cinq minutes, par utilisateur et par serveur web. La plateforme peut retourner une 429 Too Many Requests erreur si ces limites sont dépassées. En savoir plus : Limites de l’API de protection des services.

Important

Si l’événement utilise une passerelle de paiement, des étapes de validation supplémentaires peuvent s’appliquer et un débit effectif peut être inférieur. Les clients qui utilisent des passerelles de paiement doivent valider le comportement de mise en cache de leur configuration spécifique.