Hartelijk dank voor uw feedback
Feedback?Als u een ontwikkelaar in uw team hebt die weet hoe u een GraphQL-API moet gebruiken, dan kan de Webex Events API uw toegangspoort zijn tot krachtige automatiseringen en productconfiguratie en -beheer, platformintegraties van derden, krachtige datadashboards voor meerdere gebeurtenissen en meer.
Wat de Webex Events API kan
Simpel gezegd, een API is een programmeerinterface die ontwikkelaars kunnen gebruiken om gegevens op te halen van of in een online platform te plaatsen — in dit geval Webex Events.
De mogelijkheden van de API kunnen worden vereenvoudigd tot vier basisconcepten:
-
Creëer iets dat voorheen niet bestond, zoals een deelnemer, een sessie of een heel evenement.
-
Werk alles bij waarmee de API gemaakt kan worden, plus nog een paar dingen. De API kan bijvoorbeeld worden gebruikt om een nieuwe deelnemer aan te maken en vervolgens de naam, e-mail, status, groepen, telefoonnummers en sociale accounts van die deelnemer te bewerken.
-
Lees informatie over alles waarmee de API kan worden gemaakt of bewerkt, en over enkele dingen die niet mogelijk zijn.
-
Verwijder alles waarvoor de API kan worden gemaakt, op enkele uitzonderingen na.
Houd deze concepten in gedachten wanneer u de sectie 'Samenwerken met ontwikkelaars' van dit artikel leest.
Hoe gaat u aan de slag?
1. Krijg toegang tot de API
Als u een Webex Suite Enterprise Agreement (Suite EA) klant bent die Webex Events al heeft geactiveerd, krijgt u automatisch toegang tot de Webex Events API! Neem voor alle andere klanten contact op met uw contactpersoon voor Webex Events of ons ondersteuningsteam voor meer informatie over toegang tot de API.
2. Een API-sleutel aanmaken
Nu moet u een nieuwe API-sleutel aanmaken die uw ontwikkelaars kunnen gebruiken. Als u toegang hebt tot de API, wordt er een nieuw tabblad toegevoegd aan de pagina 'Organisatie-instellingen' op het Webex Events-platform. Ga als volgt te werk om naar het nieuwe tabblad te gaan en uw eerste sleutel aan te maken:
Houd er rekening mee dat alleen beheerders van de organisatie toegang hebben tot de API-pagina.
-
Klik vanaf elke plek op het Webex Events-platform op uw profielafbeelding in de rechterbovenhoek van het scherm en selecteer vervolgens Organisatie-instellingen in de keuzelijst.
-
Klik op de instellingenpagina van de organisatie op de API-tab in het linkermenu. Dit brengt u naar het API-dashboard waar u het API-gebruik kunt bekijken, gebruikslogboeken kunt exporteren, sleutels kunt beheren en toegang kunt krijgen tot onze API-documentatie.
-
Klik op Sleutel aanmaken.
-
Voer in de module 'Nieuwe sleutel aanmaken' een label in voor de API-sleutel waarin wordt uitgelegd waarvoor deze zal worden gebruikt.
-
In de keuzelijst voor de API-versie is de huidige versie al geselecteerd, dus klik gewoon op Opslaan. Dit onthult de API-sleutel.
-
Klik op de knop Kopiëren naast de sleutel en plak de sleutel in een beveiligd document om ervoor te zorgen dat de sleutel nooit verloren gaat.
WAARSCHUWING! Dit is de enige keer dat de volledige API-sleutel toegankelijk is. Nadat u het modaal hebt gesloten, kan de volledige sleutel niet meer worden gelezen.
-
Nadat u de sleutel hebt gekopieerd en opgeslagen, klikt u op de knop Sluiten.
In de meeste gevallen hebt u maar één API-sleutel nodig. Maar in situaties waarin u met meerdere teams werkt, wilt u misschien voor elk team een sleutel aanmaken. Praat met uw ontwikkelaars over uw specifieke toepassingen om de beste oplossing te vinden.
3. Ontwikkelaars uitnodigen om toegang te krijgen tot de API
Wanneer u uw eerste API-sleutel aanmaakt, wordt er automatisch een nieuw API-team aangemaakt in het Webex Events-platform. Uw ontwikkelaars toegang geven om de Webex Events API uit te proberen, is net zo eenvoudig als ze uitnodigen voor dat API-team. Volg de instructies in ons artikel over het beheren van teams, leden en credits om te leren hoe.
Houd er rekening mee dat de API-sandbox een aparte versie is van het Webex Events-platform dat speciaal is gemaakt om te testen. Dit betekent dat alle nieuwe leden van het API Sandbox-team een nieuw platformaccount moeten aanmaken om de sandbox te kunnen gebruiken, zelfs als ze al een platformaccount hebben of inloggen met de SSO van hun organisatie.
De mensen in uw API-team hebben geen toegang tot de rest van het Webex Events-platform zoals organisatoren dat doen. In plaats daarvan hebben API-teamleden toegang tot een API-sandbox waar ze kunnen testen wat ze aan het bouwen zijn zonder dat dit gevolgen heeft voor gegevens uit de echte wereld. Als u wilt dat ontwikkelaars ook toegang hebben tot enkele of al uw echte evenementen en apps op het Webex Events-platform, nodig ze dan uit voor relevante niet-API-teams.
4. Wees vriendelijk tegen uw ontwikkelaars
Dit is cruciaal, dus hebben we er een hele stap van gemaakt. 😉
„Rome is niet in één dag gebouwd”, en een goede API-integratie ook niet. Wees een goede vriend van uw ontwikkelaars en geef ze voldoende tijd om aan de slag te gaan met de Webex Events API voordat u verwacht dat ze integraties zullen leveren. Ze zullen dankbaar zijn dat ze niet onder druk gezet worden.
We raden u aan om ten minste zes maanden voordat de integraties moeten werken, een gesprek met uw ontwikkelaars te beginnen. Blijf lezen om te leren hoe u zich kunt voorbereiden op die gesprekken en deze kunt voeren.
Samenwerken met ontwikkelaars
Nadat u ontwikkelaars hebt uitgenodigd voor uw Webex Events Sandbox-team, kan een van uw eerste vragen zijn: „Hoe lang duurt het om integraties te bouwen?” Het antwoord op deze vraag hangt af van veel factoren, zoals met hoeveel ontwikkelaars u samenwerkt, hoeveel tijd ze hebben om aan integraties te werken, hoe complex de integraties zijn, en meer.
Alleen uw ontwikkelaars kunnen u vertellen hoe lang het duurt om een integratie op te zetten, en pas na een paar cruciale stappen:
-
Lees eerst de secties hieronder om te zien wat de API kan doen. Dit zal u helpen begrijpen wat er mogelijk is, zodat u uw behoeften duidelijk kunt communiceren met uw ontwikkelaars.
-
Ontmoet uw ontwikkelaars, deel onze API-documentatie met hen en bespreek wat u wilt. Ze kunnen eenvoudige feedback geven over wat ze wel en niet voor u kunnen doen. Ze kunnen u echter geen specifieke tijdlijnen geven totdat ze vertrouwd zijn met de Webex Events API.
-
Geef uw ontwikkelaars de tijd om vertrouwd te raken met de API. Stel uzelf beschikbaar om conceptuele of praktische vragen te beantwoorden over uw evenementen, gegevens, het Webex Events-platform en al het andere.
Wat de API kan doen
De API heeft twee basisfuncties:
-
Lezen - Verkrijg gegevens van Webex Events zodat u ze kunt bekijken of naar een ander systeem kunt overzetten.
-
Update - Zet gegevens in Webex Events om nieuwe items te maken of gegevens, zoals deelnemers, te synchroniseren vanaf een ander platform. Alles wat iets verandert in het Webex Events-platform is een update.
Teams en organisaties
-
Teams en teamleden aanmaken, bijwerken, lezen en verwijderen
Gebeurtenissen
-
Bijwerken, klonen en lezen. Gebeurtenissen kunnen niet worden aangemaakt of verwijderd met de API.
Deelnemers
-
Creëren, bijwerken, lezen, toewijzen aan sessies, toewijzen aan groepen en verwijderen van sociale accountgegevens (telefoonnummer, contactgegevens voor sociale accounts, enz.). Deelnemers kunnen niet worden verwijderd, maar wel geblokkeerd.
Vragen
-
Aanmaken, bijwerken, lezen en verwijderen
Tip: In de API worden vragen „aangepaste velden” genoemd
Groepen
-
Exclusieve en niet-exclusieve groepen aanmaken, bijwerken, lezen en verwijderen
Sessies
-
Aanmaken, bijwerken, lezen en verwijderen
Locaties
-
Aanmaken, bijwerken, lezen en verwijderen
Tip: In de API worden locaties „regio's” genoemd.
Apps van een merk
-
Lees de namen, statussen van merkapps en de namen van toegewezen gebeurtenissen
App voor evenementen
-
Lees de basisbeginselen, het uiterlijk en de Web App instellingen, plus informatie over opnamen in het Video Center
-
Maak, update, lees en verwijder de volgende functies van de Event App en de bijbehorende items, indien van toepassing:
-
Agenda
-
Sponsoren
-
Luidsprekers
-
Exposanten
-
Livestream
-
Deelnemers
-
Aangepaste lijst
-
Eén item
-
Weblink
-
Weblijst
-
Mijn QR-code
-
Houd er rekening mee dat u alle functies van de Event App die hierboven niet zijn vermeld, handmatig moet toevoegen en configureren.
Tip: In de API worden functies „componenten” genoemd.
Registratie
-
Lees de basisinformatie, het uiterlijk en de instellingen, waaronder de instellingen voor de checkout
-
Tickets, formulieren, vragen en promotiecodes aanmaken, lezen, bijwerken en verwijderen
-
Bestellingen aanmaken, lezen en bijwerken
-
E-mails met de bevestiging van uw bestelling en ticket verzenden
-
Bestellingen per cheque of factuur als betaald markeren
-
Informatie over de koper van de bestelling bijwerken
-
Tickets annuleren en terugbetalen
-
Promotiecodes aanmaken, lezen, bijwerken, verwijderen, onderbreken en hervatten
-
Belastingen aanmaken, lezen, bijwerken en verwijderen
Tip: In de API worden vragen „aangepaste velden” genoemd.
Ter plaatse
-
Basisinformatie en app-informatie op locatie lezen en bijwerken
Leads ophalen en live weergeven
-
Lees of het product actief is of in het Event is gepubliceerd
Dingen om te weten
-
De API kan niet worden gebruikt om een evenement te creëren of om een van de producten in een evenement te activeren, zoals de Event App en Onsite. Voordat ontwikkelaars een evenement kunnen wijzigen met de API, moet u elk product activeren dat u wilt gebruiken en de vereiste basisinformatie voor elk product invullen.
-
Af en toe brengen we nieuwe versies van de API uit met verbeteringen en correcties. We blijven oude versies lang genoeg ondersteunen zodat iedereen de overstap naar de nieuwe versie kan maken. We sturen u e-mailupdates over nieuwe versies, datums waarop de oude versies binnenkort vervallen en officiële afschrijvingen.
-
API-aanvragen worden gemeten en beperkt om misbruik te voorkomen.
-
Communities worden ook ondersteund voor Suite-klanten.
