Usa l'API degli eventi nei percorsi in tempo reale

L'API degli eventi consente di accedere programmaticamente ai dati di eventi, sessioni, percorsi delle sessioni, pass, relatori e sponsorizzazioni. Inoltre, l'API eventi consente di registrarsi per eventi e sessioni.

L'API a cui si accede è tramite protocollo HTTPS ed è accessibile dall'endpoint API ricevuto durante la creazione di un token dell'applicazione Web. Tutti i dati vengono inviati e ricevuti come JSON.

Registrarsi per l'API dell'evento

Nella sezione Impostazioni inApplicazioni Web> eventi creare una nuova applicazione Web. È importante selezionare l'origine corretta. Ad esempio, se si seleziona https://contoso.com, JavaScript ospitato in un dominio diverso non sarà in grado di accedere all'API di gestione degli eventi.

Screenshot delle impostazioni dell'API eventi.

Dopo aver creato un'applicazione Web, viene visualizzato un collegamento alla specifica OpenAPI nella documentazione dell'endpoint (anteprima).

Screenshot dell'endpoint dell'API evento.

È possibile selezionare il collegamento e copiare e incollare il contratto API in un editor OpenAPI, ad esempio Editor Swagger, che genera automaticamente un wrapper che è possibile usare per individuare l'API. Per accedere all'API, è necessario essere autorizzati (specificare la colonna Token ).

Screenshot dell'editor Swagger dell'Event API.

Creare una pagina eventi o un portale eventi

L'API eventi consente di creare una pagina di eventi personalizzata e un portale eventi che elenca tutti gli eventi disponibili in tempo reale e pubblicati usando l'opzione di pubblicazione "Soluzione personalizzata usando l'API evento". L'API eventi consente di:

  • Recuperare un elenco di eventi live che includono il nome, la descrizione, la posizione e l'ora.
  • Per la pagina dell'evento, consente di recuperare informazioni chiave sull'evento, ad esempio:
    • Name
    • Time
    • Posizione
    • Codice QR dell'evento
    • Capacity
    • Elenco di sessioni
    • Elenco di relatori
    • Elenco degli sponsor e dei loro logo

Creare un'esperienza di registrazione eventi personalizzata

L'API eventi consente anche di creare un invio di registrazione senza la necessità di usare moduli di marketing in tempo reale, sfruttando al tempo stesso funzionalità importanti, ad esempio strategia di corrispondenza, consenso, impostazioni del pubblico e altro ancora.

Per prima cosa, definisci le impostazioni chiave per il tuo pubblico passando a Impostazioni>Gestione evento>Impostazioni di registrazione eventi e definisci:

  1. Gruppo di destinatari predefinito
  2. Regola di corrispondenza predefinita
  3. Profilo di conformità predefinito

Le impostazioni di registrazione degli eventi predefinite vengono usate durante l'elaborazione degli invii dall'API. Dopo aver impostato le impostazioni di registrazione, l'endpoint di invio dell'API eventi consente di:

  1. Creare un invio di registrazione per un evento:
{ 
    "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. Creare un invio di registrazione per una sessione:
{ 
    "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. Creare una registrazione dell'elenco di attesa:
{
    "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" 
                } 
            ] 
        } 
    ]
}

Prestazioni e limiti

L'API eventi supporta scenari di registrazione con volumi elevati tramite l'elaborazione asincrona, la memorizzazione nella cache intelligente e la logica di ripetizione dei tentativi predefinita.

Quando arriva una richiesta di registrazione tramite l'API evento, il sistema:

  • Verifica che l'evento sia attivo e che tutte le entità correlate siano in uno stato valido
  • Restituisce una risposta immediata di esito positivo al chiamante.
  • Avvia un processore di elementi di lavoro in background per creare la registrazione degli eventi e le entità associate in modo asincrono.

Comportamento della cache

Cache di lettura: il sistema applica una cache di 10 minuti per la convalida di eventi ed entità. Ciò riduce le letture ridondanti in Dataverse e migliora la velocità effettiva in fase di caricamento.

Note

La cache di lettura influisce solo sulla convalida, non sui record di registrazione stessi.

Logica di ripetizione dei tentativi e gestione degli errori

Se il processore in background non riesce a creare una registrazione eventi, il sistema ritenta automaticamente fino a sei ore. Questo vale per gli scenari di errore sincrono e asincroni, garantendo l'affidabilità dei dati senza richiedere l'intervento manuale.

Limiti di throughput e di Dataverse

Il principale fattore limitante per gli scenari di registrazione senza modulo è la velocità con cui le entità di registrazione dei ticket possono essere create in Dataverse. In condizioni normali, Dataverse applica un limite di 6.000 richieste API, entro una finestra scorrevole di cinque minuti, per utente e server Web. La piattaforma può restituire un 429 Too Many Requests errore se questi limiti vengono superati. Altre informazioni: Limiti dell'API di protezione dei servizi.

Importante

Se l'evento utilizza un gateway di pagamento, potrebbero essere necessari ulteriori passaggi di convalida e il throughput effettivo potrebbe essere inferiore. I clienti che usano i gateway di pagamento devono convalidare il comportamento di memorizzazione nella cache per la configurazione specifica.