Dit artikel is vertaald uit het Engels met behulp van machinevertaling.
Als u een ontwikkelaar in uw team heeft die weet hoe u een GraphQL API moet gebruiken, kan de Webex Events API uw toegangspoort zijn tot krachtige automatiseringen voor het instellen en beheren van evenementen en producten, platformintegraties van derden, krachtige gegevensdashboards voor meerdere gebeurtenissen en meer .
Wat de Webex Events API kan doen
Simpel gezegd is een API een programmeerinterface die ontwikkelaars kunnen gebruiken om gegevens op te halen of gegevens 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.
Update alles wat de API kan maken, plus nog een paar dingen. De API kan bijvoorbeeld worden gebruikt om een nieuwe deelnemer aan te maken en vervolgens de naam, het e-mailadres, de status, groepen, telefoonnummers en sociale accounts van die deelnemer te bewerken.
Lees informatie over alles wat de API kan maken of bewerken, plus enkele dingen die niet mogelijk zijn.
Verwijder alles wat de API kan maken, op enkele uitzonderingen na.
Houd deze concepten in gedachten terwijl u het gedeelte 'Werken met ontwikkelaars' van dit artikel leest.
Hoe u aan de slag kunt gaan
1. Krijg toegang tot de API
Als u een Webex Suite Enterprise Agreement (Suite EA)-klant bent en Webex Events al heeft geactiveerd, krijgt u automatisch toegang tot de Webex Events API! Voor alle andere klanten kunt u contact opnemen met uw Webex Events contactpersoon of ons ondersteuningsteam voor meer informatie over toegang tot de API.
2. Maak een API-sleutel
Nu moet u een nieuwe API-sleutel maken die uw ontwikkelaars kunnen gebruiken. Wanneer u toegang heeft tot de API, wordt er een nieuw tabblad toegevoegd aan de pagina 'Organisatie-instellingen' op het Webex Events platform. Zo krijgt u toegang tot het nieuwe tabblad en maakt u uw eerste sleutel:
💡 Houd er rekening mee dat alleen organisatiebeheerders toegang hebben tot de API-pagina.
Klik overal op het Webex Events platform op uw profielafbeelding in de rechterbovenhoek van het scherm en selecteer vervolgens Organisatie-instellingen in de vervolgkeuzelijst.
Klik op de pagina Organisatie-instellingen op het tabblad API in het linkermenu. Hiermee gaat 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 maken .
Voer in het modale 'Nieuwe sleutel maken' een label in voor de API-sleutel waarin wordt uitgelegd waarvoor deze zal worden gebruikt.
In de vervolgkeuzelijst API-versie is de huidige versie al geselecteerd, dus klik eenvoudig 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 deze nooit verloren gaat.
⚠️ WAARSCHUWING! Dit is de enige keer dat de volledige API-sleutel toegankelijk is. Nadat u de modal heeft 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 heeft u slechts één API-sleutel nodig. In situaties waarin u met meerdere teams werkt, wilt u wellicht voor elk team een sleutel maken. Praat met uw ontwikkelaars over uw specifieke gebruiksscenario's om de beste oplossing te vinden.
3. Nodig ontwikkelaars uit voor toegang tot de API
Wanneer u uw eerste API-sleutel maakt, wordt er automatisch een nieuw API-team gemaakt op 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 u dit doet.
💡 Houd er rekening mee dat de API-sandbox een aparte versie van het Webex Events platform is, speciaal gemaakt om te testen. Dit betekent dat alle nieuwe leden van het API Sandbox-team een nieuw platformaccount moeten maken om de sandbox te gebruiken, zelfs als ze al een platformaccount hebben of inloggen met de SSO van hun organisatie.
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 bouwen zonder dat dit gevolgen heeft voor de gegevens uit de echte wereld. Als u wilt dat ontwikkelaars ook toegang hebben tot sommige of al uw echte gebeurtenissen en apps op het Webex Events platform, nodig ze dan uit voor relevante niet-API-teams.
4. Bereid een evenement voor
Omdat de API geen producten in een evenement kan activeren, zoals de Event App en Onsite, moet u elk product dat u tijdens uw evenement wilt gebruiken, activeren en de vereiste basisgegevens invullen.
Werken met ontwikkelaars
Het is belangrijk dat u duidelijk communiceert met uw ontwikkelaars, zodat zij kunnen bouwen wat u nodig heeft. Dit betekent dat u moet weten tot welke delen van het Webex Events platform de API toegang heeft. Blijf lezen om erachter te komen waartoe de API precies toegang heeft en waartoe de API toegang heeft, plus een paar tips om u te helpen "dezelfde taal te spreken" als uw ontwikkelaar.
Wanneer u bekend bent met de basismogelijkheden, kunt u met uw ontwikkelaar gaan praten over het bouwen van tools en automatiseringen met de API.
Teams en organisaties
Teams en teamleden maken, bijwerken, lezen en verwijderen
Evenementen
Maken, bijwerken, klonen en lezen. Evenementen kunnen niet worden verwijderd.
Deelnemers
Creëer, update, lees, wijs toe aan sessies, wijs toe aan groepen en verwijder sociale accountinformatie (telefoonnummer, sociale accounthandvatten, enz.). Deelnemers kunnen niet worden verwijderd, maar wel worden geblokkeerd.
Vragen
Maken, bijwerken, lezen en verwijderen
Tip: In de API worden vragen "aangepaste velden" genoemd
Groepen
Maak, update, lees en verwijder zowel exclusieve als niet-exclusieve groepen
Sessies
Maken, bijwerken, lezen en verwijderen
Locaties
Maken, bijwerken, lezen en verwijderen
Tip: In de API worden locaties 'regio's' genoemd.
Branded Apps
Lees de namen, statussen van Branded App en de namen van toegewezen gebeurtenissen
Event App
Lees Basisprincipes, Vormgeving en Webapp-instellingen plus informatie over Video Center -opnamen
Maak, update, lees en verwijder de volgende Event App functies en hun items, indien van toepassing:
Agenda
Sponsoren
Luidsprekers
Exposanten
Livestream
Deelnemers
Aangepaste lijst
Enkel item
Web link
Weblijst
Mijn QR-code
💡 Houd er rekening mee dat u alle Event App functies die hierboven niet worden vermeld, handmatig moet toevoegen en configureren.
Tip: In de API worden functies "componenten" genoemd.
Registratie
Lees basis-, uiterlijk- en instellingeninformatie, inclusief afrekeninstellingen
Creëer, lees, update en verwijder tickets, formulieren, vragen en promotiecodes
Orders maken, lezen en bijwerken
Verzend e-mails met order- en ticketbevestiging
Markeer bestellingen op cheques of facturen als betaald
Update de kopergegevens van de bestelling
Tickets annuleren en terugbetalen
Promotiecodes maken, lezen, bijwerken, verwijderen, onderbreken en hervatten
Belastingen maken, lezen, bijwerken en verwijderen
Tip: In de API worden vragen "aangepaste velden" genoemd.
Onsite
Lees en update de Basics- en Onsite App -informatie
Lead Retrieval en Live Display
Lees of het product actief of gepubliceerd is in het Evenement
Dingen om te weten
We brengen af en toe nieuwe versies van de API uit met verbeteringen en oplossingen. We blijven oude versies lang genoeg ondersteunen zodat iedereen de nieuwe versie kan overzetten. We sturen e-mailupdates over nieuwe versies, aanstaande beëindigingsdatums van oude versies en officiële beëindigingen.
API-verzoeken worden gemeten en beperkt om misbruik te voorkomen.
Community's worden ook ondersteund voor Suite-klanten.