Wenn Sie einen Entwickler in Ihrem Team haben, der weiß, wie man eine GraphQL-API verwendet, könnte die Webex Events-API Ihr Tor zu leistungsstarken Automatisierungen für Event- und Produkteinrichtung und -verwaltung, Plattformintegrationen von Drittanbietern, leistungsstarken Daten-Dashboards für mehrere Veranstaltungen und mehr sein.
Was die Webex Events API kann
Einfach ausgedrückt, eine API ist eine Programmierschnittstelle, die Entwickler verwenden können, um Daten von einer Online-Plattform abzurufen oder Daten in diese zu übertragen — 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, wie einen Teilnehmer, eine Sitzung oder eine ganze Veranstaltung.
-
Aktualisieren Sie alles, wofür die API verwendet werden kann, plus ein paar weitere Dinge. Zum Beispiel kann die API verwendet werden, um einen neuen Teilnehmer zu erstellen und dann den Namen, die E-Mail-Adresse, den Status, die Gruppen, Telefonnummern und sozialen Konten dieses Teilnehmers zu bearbeiten.
-
Lesen Sie Informationen über alles, was mit der API erstellt oder bearbeitet werden kann, und über einige Dinge, die sie nicht kann.
-
Löschen Sie alles, wofür die API verwendet werden kann, mit einigen Ausnahmen.
Behalten Sie diese Konzepte im Hinterkopf, wenn Sie den Abschnitt „Zusammenarbeit mit Entwicklern“ in diesem Artikel lesen.
Erste Schritte
1. Erhalten Sie Zugriff auf die API
Wenn Sie ein Webex Suite Enterprise Agreement (Suite EA) -Kunde sind und Webex Events bereits aktiviert haben, erhalten Sie automatisch Zugriff auf die Webex Events API! Für alle anderen Kunden sprechen Sie mit Ihrem Webex Events-Ansprechpartner oder unserem Support-Team, um mehr über den Zugriff auf die API zu erfahren.
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“ auf der Webex Events-Plattform ein neuer Tab hinzugefügt. So greifen Sie auf den neuen Tab zu und erstellen Ihren ersten Schlüssel:
Denken Sie daran, dass nur Organisationsadministratoren auf die API-Seite zugreifen können.
-
Klicken Sie von überall auf der Webex Events-Plattform auf Ihr Profilbild in der oberen rechten Ecke des Bildschirms und wählen Sie dann Organisationseinstellungen aus dem Drop-down-Menü aus.
-
Klicken Sie auf der Seite mit den Organisationseinstellungen im linken Menü auf den API-Tab. 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 Modal „Neuen Schlüssel erstellen“ eine Bezeichnung für den API-Schlüssel ein, die erklärt, wofür er verwendet wird.
-
In der Dropdownliste API-Version ist bereits die aktuelle Version ausgewählt, also klicken Sie einfach auf Speichern. Das enthüllt den API-Schlüssel.
-
Klicken Sie auf die Schaltfläche Kopieren neben dem Schlüssel 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 Modal geschlossen haben, kann der vollständige Schlüssel nicht noch einmal 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. In Situationen, in denen Sie mit mehreren Teams arbeiten, möchten Sie jedoch vielleicht 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 ein, auf die API zuzugreifen
Wenn Sie Ihren ersten API-Schlüssel erstellen, wird automatisch ein neues API-Team auf der Webex Events-Plattform erstellt. Ihren Entwicklern Zugriff zu geben, um die Webex Events-API auszuprobieren, ist so einfach, wie sie in dieses API-Team einzuladen. Folgen Sie den Anweisungen in unserem Artikel über die Verwaltung 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 entwickelt wurde. Das bedeutet, dass alle neuen Mitglieder des API-Sandbox-Teams ein neues Plattformkonto erstellen müssen, um die Sandbox nutzen zu können, auch wenn sie bereits ein Plattformkonto haben oder sich mit dem SSO ihrer Organisation anmelden.
Die Mitglieder Ihres API-Teams haben keinen Zugriff auf den Rest der Webex Events-Plattform wie Organisatoren. Stattdessen haben die Mitglieder des API-Teams Zugriff auf eine API-"Sandbox“, in der sie testen können, was sie entwickeln, ohne reale Daten zu beeinträchtigen. Wenn Sie möchten, dass Entwickler auch Zugriff auf einige oder alle Ihrer echten Events und Apps auf der Webex Events-Plattform haben, laden Sie sie in entsprechende Nicht-API-Teams ein.
4. Seien Sie nett zu Ihren Entwicklern
Das ist entscheidend, also haben wir einen ganzen Schritt daraus gemacht. 😉
„Rom wurde nicht an einem Tag erbaut“ und auch keine gute API-Integration. Seien Sie Ihren Entwicklern ein guter Freund und geben Sie ihnen ausreichend Zeit, um sich mit der Webex Events API vertraut zu machen, bevor Sie erwarten, dass sie Integrationen bereitstellen. Sie werden dankbar sein, nicht unter Druck gesetzt zu werden.
Wir empfehlen, mindestens sechs Monate, bevor Integrationen funktionieren müssen, Gespräche mit Ihren Entwicklern zu beginnen. Lesen Sie weiter, um zu erfahren, wie Sie sich auf diese Gespräche vorbereiten und diese führen können.
Mit Entwicklern zusammenarbeiten
Nachdem Sie Entwickler in Ihr Webex Events Sandbox-Team eingeladen haben, könnte eine Ihrer ersten Fragen lauten: „Wie lange wird es dauern, Integrationen zu erstellen?“ Die Beantwortung dieser Frage hängt von vielen Faktoren ab, einschließlich der Anzahl der Entwickler, mit denen Sie zusammenarbeiten, wie viel Zeit sie haben, um an Integrationen zu arbeiten, wie komplex die Integrationen sind und mehr.
Nur Ihre Entwickler können Ihnen sagen, wie lange die Einrichtung einer Integration dauern wird, und das erst nach ein paar wichtigen Schritten:
-
Lesen Sie zunächst die folgenden Abschnitte, um zu erfahren, was die API kann. Das wird Ihnen helfen zu verstehen, was möglich ist, sodass Sie Ihre Bedürfnisse klar mit Ihren Entwicklern kommunizieren können.
-
Treffen Sie sich mit Ihren Entwicklern, teilen Sie ihnen unsere API-Dokumentation mit und besprechen Sie, was Sie wollen. Sie werden in der Lage sein, grundlegendes Feedback dazu zu geben, was sie für Sie tun können und was nicht. Sie können Ihnen jedoch keine spezifischen Zeitpläne nennen, bis sie mit der Webex Events-API vertraut sind.
-
Geben Sie Ihren Entwicklern Zeit, sich mit der API vertraut zu machen. Stellen Sie sich zur Verfügung, um konzeptionelle oder praktische Fragen zu Ihren Veranstaltungen, Daten, der Webex Events-Plattform und allem anderen zu beantworten.
Was die API kann
Die API hat zwei grundlegende Funktionen:
-
Lesen — Holen Sie sich Daten von Webex Events, damit Sie sie untersuchen oder in ein anderes System übertragen können.
-
Update — Geben Sie Daten in Webex Events ein, um neue Elemente zu erstellen oder Daten, wie Teilnehmer, von einer anderen Plattform zu synchronisieren. Alles, was etwas an der Webex Events-Plattform ändert, ist ein Update.
Teams und Organisationen
-
Teams und Teammitglieder erstellen, aktualisieren, lesen und löschen
Ereignisse
-
Aktualisieren, klonen und lesen. Ereignisse können mit der API nicht erstellt oder gelöscht werden.
Teilnehmer
-
Erstellen, aktualisieren, lesen, Sitzungen zuweisen, Gruppen zuweisen und Kontoinformationen für soziale Netzwerke löschen (Telefonnummer, Accountnamen für soziale Netzwerke usw.). Teilnehmer können nicht gelöscht werden, sie können jedoch blockiert werden.
Fragen
-
Erstellen, aktualisieren, lesen und löschen
Tipp: In der API werden Fragen „benutzerdefinierte Felder“ genannt
Gruppen
-
Sowohl exklusive als auch nicht exklusive Gruppen erstellen, aktualisieren, lesen und löschen
Sitzungen
-
Erstellen, aktualisieren, lesen und löschen
Standorte
-
Erstellen, aktualisieren, lesen und löschen
Tipp: In der API werden Standorte „Regionen“ genannt.
Apps mit Markenlogo
-
Lesen Sie die Namen, den Status der Marken-Apps und die Namen der zugewiesenen Ereignisse
Event-App
-
Lesen Sie Grundlagen, Aussehen und Web App Einstellungen sowie Informationen zu Video Center-Aufzeichnungen
-
Erstellen, aktualisieren, lesen und löschen Sie die folgenden Event-App-Funktionen und deren Artikel, falls zutreffend:
-
Tagesordnung
-
Sponsoren
-
Lautsprecher
-
Aussteller
-
Livestream
-
Teilnehmer
-
Benutzerdefinierte Liste
-
Einzelner Artikel
-
Weblink
-
Web-Liste
-
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 Funktionen „Komponenten“ genannt.
Registrierung
-
Lesen Sie die Informationen zu Grundlagen, Aussehen und Einstellungen, einschließlich Checkout-Einstellungen
-
Tickets, Formulare, Fragen, Promo-Codes erstellen, lesen, aktualisieren und löschen
-
Bestellungen erstellen, lesen und aktualisieren
-
Bestell- und Ticketbestätigungs-E-Mails senden
-
Scheck- oder Rechnungsbestellungen als bezahlt markieren
-
Informationen zum Käufer der Bestellung aktualisieren
-
Tickets stornieren und erstatten
-
Promo-Codes erstellen, lesen, aktualisieren, löschen, pausieren und fortsetzen
-
Steuern erstellen, lesen, aktualisieren und löschen
Tipp: In der API werden Fragen „benutzerdefinierte Felder“ genannt.
Vor Ort
-
Lesen und aktualisieren Sie die Grundlagen und Informationen zur Onsite-App
Lead-Abruf und Live-Anzeige
-
Lesen Sie, ob das Produkt aktiv ist oder in der Veranstaltung veröffentlicht wurde
Wissenswertes
-
Die API kann nicht verwendet werden, um eine Veranstaltung zu erstellen oder eines der Produkte einer Veranstaltung zu aktivieren, wie z. B. die Event-App und Onsite. Bevor Entwickler ein Event mit der API ändern können, müssen Sie jedes Produkt, das Sie verwenden möchten, aktivieren und die grundlegenden erforderlichen Informationen für jedes Produkt eingeben.
-
Wir werden gelegentlich neue Versionen der API mit Verbesserungen und Korrekturen veröffentlichen. Wir werden alte Versionen weiterhin so lange unterstützen, dass jeder auf die neue Version umsteigen kann. Wir senden E-Mail-Updates über neue Versionen, bevorstehende Veraltungstermine für alte Versionen und offizielle Veraltungstermine.
-
API-Anfragen werden gemessen und begrenzt, um Missbrauch zu verhindern.
-
Communities werden auch für Suite-Kunden unterstützt.