Dieser Artikel wurde maschinell aus dem Englischen übersetzt.
Wenn Sie in Ihrem Team einen Entwickler haben, der weiß, wie man eine GraphQL-API verwendet, könnte die Webex Events API Ihr Tor zu leistungsstarken Automatisierungen für die Einrichtung und Verwaltung von Events und Produkten, zur Integration von Plattformen von Drittanbietern, zu leistungsstarken Dashboards für Multi-Event-Daten und mehr sein.
Was die Webex Events API kann
Einfach ausgedrückt ist eine API eine Programmierschnittstelle, die Entwickler verwenden können, um Daten von einer Online-Plattform abzurufen oder in eine Online-Plattform einzufügen – in diesem Fall Webex Events.
Die Funktionen der API können auf vier grundlegende Konzepte vereinfacht werden:
Erstellen Sie etwas, das es vorher nicht gab, beispielsweise einen Teilnehmer, eine Sitzung oder ein ganzes Ereignis.
Aktualisieren Sie alles, was mit der API erstellt werden kann, und noch ein paar weitere Dinge. Beispielsweise können Sie mit der API einen neuen Teilnehmer erstellen und dann dessen Namen, E-Mail-Adresse, Status, Gruppen, Telefonnummern und Social-Media-Konten bearbeiten.
Lesen Sie Informationen zu allem, was mit der API erstellt oder bearbeitet werden kann, sowie zu einigen Dingen, die nicht mit der API erstellt oder bearbeitet werden können.
Löschen Sie , mit einigen Ausnahmen, alles, was mit der API erstellt werden kann.
Behalten Sie diese Konzepte im Hinterkopf, wenn Sie den Abschnitt „Mit Entwicklern arbeiten“ dieses Artikels lesen.
Wie man anfängt
1. Erhalten Sie Zugriff auf die API
Wenn Sie Kunde mit Webex Suite Enterprise Agreement (Suite EA) sind und Webex Events bereits aktiviert haben, erhalten Sie automatisch Zugriff auf die Webex Events API! Alle anderen Kunden wenden sich an ihren Webex Events Kontakt oder unser Supportteam, um Informationen zum Zugriff auf die API zu erhalten.
2. Erstellen Sie einen API-Schlüssel
Jetzt müssen Sie einen neuen API-Schlüssel erstellen, den Ihre Entwickler verwenden können. Wenn Sie Zugriff auf die API haben, wird der Seite „Organisationseinstellungen“ in der Webex Events Plattform eine neue Registerkarte hinzugefügt. So greifen Sie auf die neue Registerkarte zu und erstellen Ihren ersten Schlüssel:
💡 Denken Sie daran, dass nur Organisationsadministratoren auf die API-Seite zugreifen können.
Klicken Sie an einer beliebigen Stelle auf der Webex Events Plattform oben rechts auf dem Bildschirm auf Ihr Profilbild und wählen Sie dann im Dropdown-Menü „Organisationseinstellungen“ aus.
Klicken Sie auf der Seite „Organisationseinstellungen“ im linken Menü auf die Registerkarte „ API “. Dadurch gelangen Sie zum API-Dashboard, wo Sie die API-Nutzung überprüfen, Nutzungsprotokolle exportieren, Schlüssel verwalten und auf unsere API-Dokumentation zugreifen können.
Klicken Sie auf Schlüssel erstellen .
Geben Sie im Modalfenster „Neuen Schlüssel erstellen“ eine Bezeichnung für den API-Schlüssel ein, die erklärt, wofür er verwendet wird.
In der Dropdown-Liste „API-Version“ ist bereits die aktuelle Version ausgewählt. Klicken Sie einfach auf „ Speichern“ . Dadurch wird der API-Schlüssel angezeigt.
Klicken Sie neben dem Schlüssel auf die Schaltfläche „Kopieren“ und fügen Sie den Schlüssel in ein sicheres Dokument ein, um sicherzustellen, dass er nie verloren geht.
⚠️ WARNUNG! Dies ist das einzige Mal, dass auf den vollständigen API-Schlüssel zugegriffen werden kann. Nachdem Sie das Modalfenster geschlossen haben, kann der vollständige Schlüssel nicht mehr gelesen werden.
Nachdem Sie den Schlüssel kopiert und gespeichert haben, klicken Sie auf die Schaltfläche Schließen .
In den meisten Fällen benötigen Sie nur einen API-Schlüssel. Wenn Sie jedoch mit mehreren Teams zusammenarbeiten, möchten Sie möglicherweise für jedes Team einen Schlüssel erstellen. Sprechen Sie mit Ihren Entwicklern über Ihre spezifischen Anwendungsfälle, um die beste Lösung zu finden.
3. Laden Sie Entwickler zum Zugriff auf die API ein
Wenn Sie Ihren ersten API-Schlüssel erstellen, wird automatisch ein neues API-Team in der Webex Events Plattform erstellt. Um Ihren Entwicklern Zugriff zum Ausprobieren der Webex Events API zu gewähren, müssen Sie sie nur zu diesem API-Team einladen. Folgen Sie den Anweisungen in unserem Artikel zum Verwalten von Teams, Mitgliedern und Credits, um zu erfahren, wie das geht.
💡 Denken Sie daran, dass die API-Sandbox eine separate Version der Webex Events Plattform ist, die speziell für Tests erstellt wurde. Dies bedeutet, dass alle neuen Mitglieder des API-Sandbox-Teams ein neues Plattformkonto erstellen müssen, um die Sandbox verwenden zu können, selbst wenn sie bereits ein Plattformkonto haben oder sich mit dem SSO ihrer Organisation anmelden.
Die Mitglieder Ihres API-Teams haben im Gegensatz zu den Organisatoren keinen Zugriff auf den Rest der Webex Events Plattform. Stattdessen haben die Mitglieder des API-Teams Zugriff auf eine API-„Sandbox“, in der sie testen können, was sie erstellen, ohne reale Daten zu beeinträchtigen. Wenn Sie möchten, dass Entwickler auch Zugriff auf einige oder alle Ihrer realen Events und Apps in der Webex Events Plattform haben, laden Sie sie zu relevanten Nicht-API-Teams ein.
4. Bereiten Sie eine Veranstaltung vor
Da die API keines der Produkte in einem Event, etwa die Event App und Onsite, aktivieren kann, müssen Sie jedes Produkt, das Sie in Ihrem Event verwenden möchten, aktivieren und die erforderlichen grundlegenden Informationen eingeben.
Zusammenarbeit mit Entwicklern
Es ist wichtig, dass Sie klar mit Ihren Entwicklern kommunizieren, damit diese das entwickeln können, was Sie brauchen. Das bedeutet, dass Sie wissen müssen, auf welche Teile der Webex Events Plattform die API zugreifen kann. Lesen Sie weiter, um genau zu erfahren, auf was die API zugreifen und was sie steuern kann, und erhalten Sie einige Tipps, die Ihnen helfen, „dieselbe Sprache zu sprechen“ wie Ihr Entwickler.
Wenn Sie mit den grundlegenden Funktionen vertraut sind, können Sie mit Ihrem Entwickler über die Erstellung von Tools und Automatisierungen mit der API sprechen.
Teams und Organisationen
Erstellen, Aktualisieren, Lesen und Löschen von Teams und Teammitgliedern
Veranstaltungen
Erstellen, aktualisieren, klonen und lesen. Ereignisse können nicht gelöscht werden.
Teilnehmer
Erstellen, aktualisieren, lesen, Sitzungen zuweisen, Gruppen zuweisen und Social-Media-Kontoinformationen löschen (Telefonnummer, Social-Media-Konto-Handles usw.). Teilnehmer können nicht gelöscht, aber blockiert werden.
Fragen
Erstellen, aktualisieren, lesen und löschen
Tipp: In der API werden Fragen als „benutzerdefinierte Felder“ bezeichnet.
Gruppen
Erstellen, aktualisieren, lesen und löschen Sie sowohl exklusive als auch nicht-exklusive Gruppen
Sitzungen
Erstellen, aktualisieren, lesen und löschen
Standorte
Erstellen, aktualisieren, lesen und löschen
Tipp: In der API werden Standorte als „Regionen“ bezeichnet.
Branded Apps
Lesen Sie die Namen, Status und Namen der zugewiesenen Events der Branded App
Event App
Lesen Sie die Grundlagen, das Erscheinungsbild und die Web-App-Einstellungen sowie Informationen zu Video Center Aufzeichnungen.
Erstellen, aktualisieren, lesen und löschen Sie die folgenden Event App Funktionen und deren Elemente, sofern zutreffend:
Agenda
Sponsoren
Lautsprecher
Aussteller
Liveübertragung
Teilnehmer
Benutzerdefinierte Liste
Einzelexemplar
Weblink
Webliste
Mein QR-Code
💡 Denken Sie daran, dass Sie alle Event App Funktionen, die oben nicht aufgeführt sind, manuell hinzufügen und konfigurieren müssen.
Tipp: In der API werden Features als „Komponenten“ bezeichnet.
Anmeldung
Lesen Sie die Informationen zu Grundlagen, Aussehen und Einstellungen, einschließlich der Checkout-Einstellungen
Erstellen, lesen, aktualisieren und löschen Sie Tickets, Formulare, Fragen und Promo-Codes
Aufträge erstellen, lesen und aktualisieren
Senden Sie Bestell- und Ticketbestätigungs-E-Mails
Scheck- oder Rechnungsbestellungen als bezahlt markieren
Aktualisieren Sie die Informationen zum Bestellkäufer
Tickets stornieren und erstatten
Aktionscodes erstellen, lesen, aktualisieren, löschen, pausieren und fortsetzen
Steuern erstellen, lesen, aktualisieren und löschen
Tipp: In der API werden Fragen „benutzerdefinierte Felder“ genannt.
Onsite
Lesen und aktualisieren Sie die Grundlagen und Informationen zur Onsite App
Lead Retrieval und Live Display
Lesen Sie, ob das Produkt aktiv oder im Event veröffentlicht ist
Sachen zu wissen
Wir veröffentlichen gelegentlich neue Versionen der API mit Verbesserungen und Fehlerbehebungen. Wir unterstützen alte Versionen weiterhin lange genug, damit jeder auf die neue Version umsteigen kann. Wir senden E-Mail-Updates zu neuen Versionen, bevorstehenden Veraltungsdaten alter Versionen und offiziellen Veraltungsterminen.
Um Missbrauch zu verhindern, werden API-Anfragen gemessen und begrenzt.
Für Suite-Kunden werden auch Communities unterstützt.