Bemærk
Adgang til denne side kræver godkendelse. Du kan prøve at logge på eller ændre mapper.
Adgang til denne side kræver godkendelse. Du kan prøve at ændre mapper.
Hændelses-API'en er en programmatisk metode til at få adgang til data fra hændelser, sessioner, sessionsnumre, afleveringer, talere og sponsorater. Derudover giver hændelses-API'en dig mulighed for at tilmelde dig hændelser og sessioner.
Den API, der opnås adgang til, er via HTTPS-protokollen og tilgås fra det API-slutpunkt, du modtager, mens du opretter et webprogramtoken. Alle data sendes og modtages som JSON.
Tilmeld dig hændelses-API'en
I afsnittet Indstillinger underWebprogrammer til > skal du oprette et nyt webprogram. Det er vigtigt at vælge den korrekte oprindelse. Hvis du f.eks. vælger https://contoso.com, kan JavaScript, der hostes på et andet domæne, ikke få adgang til API'en til hændelsesstyring.
Når du har oprettet et webprogram, kan du se et link til OpenAPI-specifikationen i Dokumentationen til Slutpunkt (prøveversion).
Du kan vælge linket og kopiere og indsætte API-kontrakten i en OpenAPI-editor, f.eks . Swagger Editor, som automatisk genererer en ombrydning, som du kan bruge til at finde din API. Hvis du vil have adgang til din API, skal du være godkendt (angiv kolonnen Token ).
Opret en hændelsesside eller hændelsesportal
Hændelses-API'en giver dig mulighed for at oprette en tilpasset hændelsesside og en hændelsesportal, der viser alle tilgængelige begivenheder, der er live og publiceret ved hjælp af publiceringsindstillingen "Brugerdefineret løsning ved hjælp af hændelses-API". Hændelses-API'en giver dig mulighed for at:
- Hent en liste over livebegivenheder, der indeholder deres navn, beskrivelse, placering og klokkeslæt.
- For hændelsessiden giver det dig mulighed for at hente vigtige oplysninger om hændelsen, f.eks.:
- Navn
- Tid
- Placering
- QR-kode for hændelse
- Kapacitet
- Sessionsliste
- Liste over talere
- Liste over sponsorer og deres logoer
Opret en brugerdefineret hændelsesregistreringsoplevelse
Hændelses-API'en giver dig også mulighed for at oprette en indsendelse af registrering uden at skulle bruge marketingformularer i realtid, samtidig med at du stadig kan drage fordel af vigtige funktioner som matchende strategi, samtykke, målgruppeindstillinger og meget mere.
Først skal du definere nøgleindstillingerne for din målgruppe ved at gå til Indstillinger>Hændelsesstyring>Indstillinger for hændelsesregistrering og definere:
- Standardmålgruppe
- Standardregel for sammenkædning
- Standardoverholdelsesprofil
Standardindstillingerne for hændelsesregistrering bruges ved behandling af indsendelser fra API'en. Når du har angivet registreringsindstillingerne, giver slutpunktet for indsendelse af hændelses-API dig mulighed for at:
- Opret en registreringsafsendelse for en hændelse:
{
"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"
}
]
}
]
}
- Opret en registreringsafsendelse for en 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"
}
]
}
]
}
- Opret en registrering af en venteliste:
{
"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"
}
]
}
]
}
Ydeevne og grænser
Hændelses-API'en understøtter registreringsscenarier med mange volumener via asynkron behandling, smart cachelagring og indbygget forsøgslogik.
Når en registreringsanmodning modtages via hændelses-API'en, systemet:
- Validerer, at hændelsen er aktiv, og at alle relaterede objekter er i en gyldig tilstand
- Returnerer et øjeblikkeligt svar på, om opkaldet lykkedes.
- Starter en processor af arbejdselementet i baggrunden for at oprette hændelsesregistreringen og de tilknyttede enheder asynkront.
Cachelagringens funktionsmåde
Læs cache: Systemet anvender en 10-minutters cache til hændelses- og enhedsvalidering. Dette reducerer redundante læsninger af Dataverse og forbedrer gennemløb under indlæsning.
Bemærkning
Læsecachen påvirker kun valideringen, ikke selve registreringsposterne.
Forsøg logik og håndtering af fejl igen
Hvis baggrundsprocessoren ikke kan oprette en hændelsesregistrering, prøver systemet automatisk igen i op til seks timer. Dette gælder synkrone og asynkrone fejlscenarier, der sikrer datapålidelighed uden at kræve manuel indgriben.
Grænser for dataoverførselshastighed og dataverse
Den primære begrænsningsfaktor for formløse registreringsscenarier er den hastighed, hvormed objekter til registrering af billetter kan oprettes i Dataverse. Under normale omstændigheder gennemtvinger Dataverse en grænse på 6.000 API-anmodninger inden for et skydevindue på fem minutter pr. bruger og webserver. Platformen kan returnere en 429 Too Many Requests fejl, hvis disse grænser overskrides. Få mere at vide: API-grænser for tjenestebeskyttelse.
Vigtigt!
Hvis hændelsen bruger en betalingsgateway, kan der være yderligere valideringstrin, og det effektive gennemløb kan være lavere. Kunder, der bruger betalingsgateways, skal validere cachelagringsfunktionsmåden for deres specifikke konfiguration.