Tack för din feedback.
Har du feedback?Om du har en utvecklare i ditt team som vet hur man använder ett GraphQL-API kan Webex Events API vara din gateway till kraftfulla händelses- och produktkonfigurations- och hanteringsautomatiseringar, plattformsintegrationer från tredje part, kraftfulla instrumentpaneler för data för flera händelser och mer.
Vad Webex Events API kan göra
Enkelt uttryckt är ett API ett programmeringsgränssnitt som utvecklare kan använda för att hämta data från eller lägga in data i en onlineplattform - i det här fallet Webex Events.
API:s funktioner kan förenklas till fyra grundläggande begrepp:
-
Skapa något som inte fanns tidigare, till exempel en deltagare, en session eller en hel händelse.
-
Uppdat era allt som API kan användas för att skapa, plus några fler saker. API:et kan till exempel användas för att skapa en ny deltagare och sedan redigera deltagarens namn, e-postadress, status, grupper, telefonnummer och sociala konton.
-
Läs information om allt som API kan användas för att skapa eller redigera, plus några saker som det inte kan.
-
Ta bort allt API kan användas för att skapa, med några undantag.
Tänk på dessa begrepp när du läser avsnittet ”Arbeta med utvecklare” i den här artikeln.
Så här kommer du igång
1. Få tillgång till API
Om du är en Webex Suite Enterprise Agreement (Suite EA) kund som redan har Webex Events aktiverat får du automatiskt åtkomst till Webex Events API! För alla andra kunder, prata med din Webex Events-kontakt eller vårt supportteam för att lära dig mer om åtkomst till API:et.
2. Skapa en API-nyckel
Nu måste du skapa en ny API-nyckel för dina utvecklare att använda. När du har tillgång till API:et läggs en ny flik till på sidan ”Organisationsinställningar” i Webex Events-plattformen. Så här öppnar du den nya fliken och skapar din första nyckel:
Tänk på att endast organisationsadministratörer kan komma åt API-sidan.
-
Från var som helst i Webex Events-plattformen klickar du på din profilbild längst upp till höger på skärmen och väljer sedan Organisationsinställningar i listrutan.
-
Klicka på fliken API i menyn till vänster på sidan Organinställningar. Detta tar dig till API-instrumentpanelen där du kan granska API-användning, exportera användningsloggar, hantera nycklar och komma åt vår API-dokumentation.
-
Klicka på Skapa nyckel.
-
I modalen ”Skapa ny nyckel” anger du en etikett för API-nyckeln som förklarar vad den kommer att användas till.
-
Den aktuella versionen är redan markerad i rullgardinsmenyn för API- versionen, så klicka bara på Spara. Detta avslöjar API-nyckeln.
-
Klicka på knappen Kop iera bredvid nyckeln och klistra in nyckeln i ett säkert dokument för att säkerställa att det aldrig går förlorat.
VARNING! Detta är den enda gången den fullständiga API-nyckeln kan nås. När du har stängt modalen kan hela tangenten inte läsas igen.
-
När du har kopierat och sparat nyckeln klickar du på Stäng knapp.
I de flesta fall behöver du bara en API-nyckel. I situationer där du arbetar med flera team kanske du vill skapa en nyckel för varje team. Prata med dina utvecklare om dina specifika användningsfall för att ta reda på den bästa lösningen.
3. Bjud in utvecklare att komma åt API:et
När du skapar din första API-nyckel skapas automatiskt ett nytt API-team i Webex Events-plattformen. Att ge dina utvecklare tillgång till att prova Webex Events API är lika enkelt som att bjuda in dem till det API-teamet. Följ instruktionerna i vår artikel om hantering av team, medlemmar och krediter för att lära dig hur.
Tänk på att API-sandlådan är en separat version av Webex Events-plattformen gjord speciellt för testning. Detta innebär att alla nya medlemmar i API Sandbox-teamet måste skapa ett nytt plattformskonto för att använda sandlådan, även om de redan har ett plattformskonto eller loggar in med organisationens SSO.
Personer i ditt API-team har inte tillgång till resten av Webex Events-plattformen på samma sätt som arrangörerna gör. Istället har API-teammedlemmar tillgång till en API ”sandlåda” där de kan testa vad de bygger utan att påverka verkliga data. Om du vill att utvecklare också ska ha tillgång till några eller alla dina verkliga händelser och appar i Webex Events-plattformen, bjud in dem till relevanta icke-API-team.
4. Var snäll mot dina utvecklare
Detta är avgörande, så vi tog det ett helt steg. 😉
”Rom byggdes inte på en dag”, och inte heller en bra API-integration. Var en god vän till dina utvecklare och ge dem gott om tid att komma igång med Webex Events API innan du förväntar dig att de ska leverera integrationer. De kommer att vara tacksamma för att inte bli pressade.
Vi rekommenderar att du börjar konversationer med dina utvecklare minst sex månader innan du behöver integrationer som fungerar. Fortsätt läsa för att lära dig hur du förbereder dig för och har dessa samtal.
Arbeta med utvecklare
När du har bjudit in utvecklare till ditt Webex Events Sandbox-team kan en av dina första frågor vara: ”Hur lång tid tar det att bygga integrationer?” Att svara på den här frågan beror på många faktorer, inklusive hur många utvecklare du arbetar med, hur mycket tid de har att arbeta med integrationer, hur komplexa integrationerna är och mer.
Det är bara dina utvecklare som kan berätta hur lång tid det tar att konfigurera en integration, och först efter några viktiga steg:
-
Läs först avsnitten nedan för att lära dig vad API kan göra. Detta hjälper dig att förstå vad som är möjligt så att du tydligt kan kommunicera dina behov med dina utvecklare.
-
Träffa dina utvecklare, dela vår API-dokumentation med dem och diskutera vad du vill ha. De kommer att kunna ge grundläggande feedback om vad de kan och inte kan göra för dig. De kommer dock inte att kunna ge dig specifika tidslinjer förrän de är bekanta med Webex Events API.
-
Ge dina utvecklare tid att bekanta sig med API:et. Gör dig tillgänglig för att svara på konceptuella eller praktiska frågor om dina händelser, data, Webex Events-plattformen och allt annat.
Vad API kan göra
API:et har två grundläggande funktioner:
-
Läs - Hämta data från Webex Events så att du kan undersöka det eller dra det till ett annat system.
-
Uppdatering - Lägg data i Webex Events för att skapa nya objekt eller synkronisera data, till exempel deltagare, från en annan plattform. Allt som ändrar något i Webex Events-plattformen är en uppdatering.
Team och organisationer
-
Skapa, uppdatera, läsa och ta bort team och teammedlemmar
Händelser
-
Uppdatera, klona och läs. Händelser kan inte skapas eller raderas med API:et.
Deltagare
-
Skapa, uppdatera, läsa, tilldela sessioner, tilldela till grupper och ta bort sociala kontoinformation (telefonnummer, sociala kontohandtag osv.). Deltagare kan inte raderas, men de kan blockeras.
Frågor
-
Skapa, uppdatera, läsa och ta bort
Tips: I API kallas frågor ”anpassade fält”
Grupper
-
Skapa, uppdatera, läsa och ta bort både exklusiva och icke-exklusiva grupper
Sessioner
-
Skapa, uppdatera, läsa och ta bort
Platser
-
Skapa, uppdatera, läsa och ta bort
Tips: I API:et kallas platser för ”regioner”.
Varumärkesappar
-
Läs märkesappnamn, status och namn på tilldelade händelser
Evenemangsapp
-
Läs information om grunder, utseende och Web App inställningar samt information om inspelningar i Video Center
-
Skapa, uppdatera, läsa och ta bort följande Event App-funktioner och deras objekt, i förekommande fall:
-
Agenda
-
Sponsorer
-
Högtalare
-
Utställare
-
Direktsändning
-
Deltagare
-
Anpassad lista
-
Enstaka objekt
-
Webblänk
-
Webblista
-
Min QR-kod
-
Tänk på att du måste lägga till och konfigurera alla Event App-funktioner som inte listas ovan manuellt.
Tips: I API kallas funktioner ”komponenter”.
Registrering
-
Läs information om grunder, utseende och inställningar, inklusive kassainställningar
-
Skapa, läs, uppdatera och ta bort biljetter, formulär, frågor, kampanjkoder
-
Skapa, läsa och uppdatera beställningar
-
Skicka e-post med beställnings- och biljettbekräftelse
-
Markera check- eller fakturaorder som betalda
-
Uppdatera information om beställningsköpare
-
Avboka och återbetala biljetter
-
Skapa, läs, uppdatera, ta bort, pausa och återuppta kampanjkoder
-
Skapa, läsa, uppdatera och ta bort skatter
Tips: I API kallas frågor ”anpassade fält”.
På plats
-
Läs och uppdatera Basics och Onsite-appinformation
Lead Hämtning och Live Display
-
Läs om produkten är aktiv eller publicerad i Evenemanget
Saker att veta
-
API:et kan inte användas för att skapa en händelse eller aktivera någon av produkterna i ett evenemang, till exempel Event App och Onsite. Innan utvecklare kan ändra en händelse med API måste du aktivera varje produkt du tänker använda och fylla i den grundläggande nödvändig information för var och en.
-
Vi släpper ibland nya versioner av API:et med förbättringar och korrigeringar. Vi kommer att fortsätta att stödja gamla versioner tillräckligt länge för att alla ska kunna övergå till den nya versionen. Vi skickar e-postuppdateringar om nya versioner, kommande avvecklingsdatum för gamla versioner, och officiella avvecklingar.
-
API-förfrågningar mäts och begränsas för att förhindra missbruk.
-
Gemenskaper stöds också för Suite-kunder.
