Bruk hendelses-API-en i sanntidsreiser

Hendelses-API-en er en programmatisk metode for å få tilgang til data fra hendelser, økter, øktspor, pass, talere og sponsing. I tillegg kan du registrere hendelses-API-en for hendelser og økter.

Tilgang til API-en er over HTTPS-protokollen og åpnes fra API-endepunktet du mottar under oppretting av et webprogramtoken. Alle data sendes og mottas som JSON.

Registrer deg for hendelses-API-en

Opprett et nytt webprogram i Innstillinger-delen underWebprogrammer for>. Det er viktig å velge riktig opprinnelse. Hvis du for eksempel velger https://contoso.com, kan ikke JavaScript som driftes på et annet domene, få tilgang til API-en for hendelsesbehandling.

Skjermbilde av API-innstillinger for hendelse.

Når du har opprettet et nettprogram, ser du en kobling til OpenAPI-spesifikasjonen i endepunktdokumentasjon (forhåndsvisning).

Skjermbilde av hendelses-API-endepunkt.

Du kan velge koblingen og kopiere og lime inn API-kontrakten til et OpenAPI-redigeringsprogram, for eksempel Swagger Editor, som automatisk forhåndsgenererer en wrapper du kan bruke til å oppdage API-en. Hvis du vil ha tilgang til API-en, må du være autorisert (angi Token-kolonnen ).

Skjermbilde av Event API Swagger Editor.

Opprette en hendelsesside eller hendelsesportal

Med hendelses-API-en kan du opprette en tilpasset hendelsesside og en hendelsesportal som viser alle tilgjengelige hendelser som er direktesendt og publisert ved hjelp av publiseringsalternativet «Egendefinert løsning ved hjelp av hendelses-API». Med hendelses-API-en kan du:

  • Hent en liste over direktesendte arrangementer som inneholder navn, beskrivelse, sted og klokkeslett.
  • For hendelsessiden kan du hente viktig informasjon om hendelsen, for eksempel:
    • Navn
    • Tid
    • Lokasjon
    • QR-kode for hendelse
    • Kapasitet
    • Liste over økter
    • Liste over høyttalere
    • Liste over sponsorer og deres logoer

Opprette en egendefinert hendelsesregistreringsopplevelse

Hendelses-API-en lar deg også opprette en registreringsinnsending uten å måtte bruke markedsføringsskjemaer i sanntid, samtidig som du drar nytte av viktige funksjoner som samsvarende strategi, samtykke, publikumsinnstillinger og mer.

Først definerer du de viktigste innstillingene for målgruppen ved å navigere til innstillinger>hendelsesbehandling>innstillinger for hendelsesregistrering ved å definere:

  1. Standard målgruppe
  2. Standard samsvarende regel
  3. Standard samsvarsprofil

Standardinnstillingene for hendelsesregistrering brukes ved behandling av innsendinger fra API-en. Når du har angitt registreringsinnstillingene, lar hendelses-API-innsendingsendepunktet deg:

  1. Opprette en registreringsinnsending for en hendelse:
{ 
    "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. Opprette en registreringsinnsending for en økt:
{ 
    "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. Opprette en ventelisteregistrering:
{
    "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" 
                } 
            ] 
        } 
    ]
}

Ytelse og grenser

Hendelses-API-en støtter høyt volumregistreringsscenarioer gjennom asynkron behandling, smart hurtigbufring og innebygd forsøkslogikk.

Når en registreringsforespørsel kommer gjennom hendelses-API-en, systemet:

  • Validerer at hendelsen er aktiv, og at alle relaterte enheter er i en gyldig tilstand
  • Returnerer et umiddelbart suksessvar til den som kaller.
  • Starter en bakgrunnsarbeidselementbehandler for å opprette hendelsesregistrering og tilknyttede enheter asynkront.

Hurtigbufringsvirkemåte

Lesebuffer: Systemet bruker en 10-minutters hurtigbuffer for hendelses- og enhetsvalidering. Dette reduserer overflødige lesinger til Dataverse og øker gjennomstrømmingen under belastning.

Note

Lesebufferen påvirker bare valideringen, ikke selve registreringspostene.

Prøv logikk og feilhåndtering på nytt

Hvis bakgrunnsprosessoren ikke oppretter en hendelsesregistrering, starter systemet automatisk på nytt i opptil seks timer. Dette gjelder synkrone og asynkrone feilscenarioer, noe som sikrer datapålitelighet uten å kreve manuell inngripen.

Gjennomstrømmings- og dataversgrenser

Den primære begrensende faktoren for formløse registreringsscenarioer er hastigheten som billettregistreringsenheter kan opprettes i Dataverse. Under normale betingelser håndhever Dataverse en grense på 6000 API-forespørsler, innen et fem minutters skyvevindu, per bruker og nettserver. Plattformen kan returnere en 429 Too Many Requests feil hvis disse grensene overskrides. Finn ut mer: API-begrensninger for tjenestebeskyttelse.

Important

Hvis hendelsen bruker en betalingsgateway, kan flere valideringstrinn gjelde, og effektiv gjennomstrømming kan være lavere. Kunder som bruker betalingsløsninger, bør validere buf­ringsatferden for sitt spesifikke oppsett.

  • Last updated on