Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Die Ereignis-API ist eine programmgesteuerte Methode für den Zugriff auf Daten aus Ereignissen, Sitzungen, Sitzungsspuren, Pässen, Sprechern und Sponsorings. Darüber hinaus ermöglicht ihnen die Ereignis-API die Registrierung für Ereignisse und Sitzungen.
Auf die API wird über das HTTPS-Protokoll zugegriffen und über den API-Endpunkt zugegriffen, den Sie beim Erstellen eines Webanwendungstokens erhalten. Alle Daten werden als JSON gesendet und empfangen.
Registrieren für die Ereignis-API
Erstellen Sie im Abschnitt "Einstellungen" unter"Ereignisverwaltungswebanwendungen>" eine neue Webanwendung. Es ist wichtig, den richtigen Ursprung auszuwählen. Wenn Sie beispielsweise https://contoso.com, JavaScript, auswählen, das auf einer anderen Domain gehostet wird, kann nicht auf die Ereignisverwaltungs-API zugegriffen werden.
Nachdem Sie eine Webanwendung erstellt haben, sehen Sie einen Link zur OpenAPI-Spezifikation in der Endpunktdokumentation (Vorschauversion).
Sie können den Link auswählen und den API-Vertrag kopieren und in einen OpenAPI-Editor wie Swagger Editor einfügen, der automatisch einen Wrapper generiert, den Sie zum Ermitteln Ihrer API verwenden können. Um auf Ihre API zugreifen zu können, müssen Sie autorisiert sein (geben Sie die Spalte Token an).
Erstellen einer Ereignisseite oder eines Ereignisportals
Mit der Ereignis-API können Sie eine angepasste Ereignisseite und ein Ereignisportal erstellen, in dem alle verfügbaren Ereignisse aufgelistet sind, die mit der Veröffentlichungsoption "Benutzerdefinierte Lösung mit Ereignis-API" live und veröffentlicht werden. Die Ereignis-API ermöglicht Folgendes:
- Dient zum Abrufen einer Liste von Liveereignissen, die ihren Namen, die Beschreibung, den Ort und die Uhrzeit enthalten.
- Auf der Ereignisseite können Sie wichtige Informationen zu dem Ereignis abrufen, z. B.:
- Name
- Uhrzeit
- Ort
- QR-Code des Ereignisses
- Kapazität
- Liste der Sitzungen
- Liste der Redner
- Liste der Sponsoren und deren Logos
Einen benutzerdefinierte Ereignisregistrierungserfahrung erstellen
Mit der Ereignis-API können Sie auch eine Registrierungsübermittlung erstellen, ohne Echtzeit-Marketingformulare verwenden zu müssen, während Sie weiterhin von wichtigen Features wie Abgleichsstrategie, Zustimmung, Zielgruppeneinstellungen und mehr profitieren.
Definieren Sie zunächst die Schlüsseleinstellungen für Ihre Zielgruppe, indem Sie zu Einstellungen>, Veranstaltungsverwaltung> und Veranstaltungsregistrierungseinstellungen navigieren und Folgendes definieren:
- Standardzielgruppe
- Standardabgleichsregel
- Voreingestelltes Konformitätsprofil
Die Standardeinstellungen für die Ereignisregistrierung werden beim Verarbeiten von Übermittlungen aus der API verwendet. Nachdem Sie die Registrierungseinstellungen festgelegt haben, ermöglicht Ihnen der Endpunkt der Ereignis-API-Übermittlung Folgendes:
- Erstellen einer Registrierung für eine Veranstaltung:
{
"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"
}
]
}
]
}
- Erstellen einer Registrierungseinreichung für eine Sitzung:
{
"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"
}
]
}
]
}
- Erstellen sie eine Warteliste-Registrierung:
{
"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"
}
]
}
]
}
Leistung und Grenzwerte
Die Ereignis-API unterstützt Szenarien mit hoher Volumenregistrierung durch asynchrone Verarbeitung, intelligentes Zwischenspeichern und integrierte Wiederholungslogik.
Wenn eine Registrierungsanfrage über die Ereignis-API eingeht, führt das System Folgendes aus:
- Überprüft, ob das Ereignis aktiv ist und alle verwandten Entitäten in einem gültigen Zustand sind.
- Gibt eine sofortige Erfolgsantwort an den Aufrufer zurück.
- Startet einen Prozessor für Hintergrundaufgaben, um die Registrierung des Ereignisses und die zugehörigen Entitäten asynchron zu erstellen.
Cache-Verhalten
Lesecache: Das System wendet einen 10-Minütigen Cache für die Ereignis- und Entitätsüberprüfung an. Dadurch werden redundante Lesevorgänge an Dataverse reduziert und der Durchsatz unter Last verbessert.
Note
Der Lesecache wirkt sich nur auf die Überprüfung aus, nicht auf die Registrierungsdatensätze selbst.
Wiederholungslogik und Fehlerbehandlung
Wenn der Hintergrundprozessor keine Ereignisregistrierung erstellt, wird vom System automatisch eine Wiederholung von bis zu sechs Stunden ausgeführt. Dies gilt für synchrone und asynchrone Fehlerszenarien, um die Datenzuverlässigkeit sicherzustellen, ohne dass ein manueller Eingriff erforderlich ist.
Durchsatz- und Dataverse-Grenzwerte
Der primäre Begrenzungsfaktor für Formularlose Registrierungsszenarien ist die Rate, mit der Ticketregistrierungsentitäten in Dataverse erstellt werden können. Unter normalen Bedingungen erzwingt Dataverse eine Beschränkung von 6.000 API-Anforderungen innerhalb eines fünfminütigen Gleitfensters pro Benutzer und Webserver. Die Plattform kann einen 429 Too Many Requests Fehler zurückgeben, wenn diese Grenzwerte überschritten werden. Weitere Informationen: Dienstschutz-API-Grenzwerte.
Important
Wenn das Ereignis ein Zahlungsgateway verwendet, können zusätzliche Überprüfungsschritte angewendet werden, und der effektive Durchsatz kann niedriger sein. Kunden, die Zahlungsgateways verwenden, sollten das Zwischenspeicherungsverhalten für ihre spezifische Einrichtung überprüfen.