Den här artikeln har översatts från engelska med maskinöversättning.
Om du har en utvecklare i ditt team som vet hur man använder ett GraphQL API, kan Webex Events API vara din inkörsport till kraftfulla evenemangs- och produktinstallations- och hanteringsautomatiseringar, tredjepartsplattformsintegrationer, kraftfulla datapaneler för flera evenemang 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 på en onlineplattform - i det här fallet Webex Events.
API:s möjligheter kan förenklas till fyra grundläggande koncept:
Skapa något som inte fanns tidigare, som en deltagare, en session eller ett helt evenemang.
Uppdatera allt som API kan användas för att skapa, plus några fler saker. Till exempel kan API:et användas för att skapa en ny deltagare och sedan redigera deltagarens namn, e-post, status, grupper, telefonnummer och sociala konton.
Läs information om allt som API kan användas för att skapa eller redigera, plus vissa saker som det inte kan.
Ta bort allt som API kan användas för att skapa, med vissa undantag.
Ha dessa begrepp i åtanke när du läser avsnittet "Arbeta med utvecklare" i den här artikeln.
Hur man kommer igång
1. Få tillgång till API:t
Om du är en Webex Suite Enterprise Agreement (Suite EA) kund som redan har Webex Events aktiverat får du automatiskt tillgång 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 som dina utvecklare kan använda. När du har tillgång till API:t läggs en ny flik till på sidan "Organisationsinställningar" i Webex Events plattformen. Så här kommer du åt den nya fliken och skapar din första nyckel:
💡 Tänk på att endast organisationsadministratörer kan komma åt API-sidan.
Var som helst på Webex Events -plattformen, klicka på din profilbild i det övre högra hörnet på skärmen och välj sedan Organisationsinställningar från rullgardinsmenyn.
På sidan Organisationsinställningar klickar du på fliken API i menyn till vänster. 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 ska användas till.
I rullgardinsmenyn för API-version är den aktuella versionen redan vald, så klicka bara på Spara . Detta avslöjar API-nyckeln.
Klicka på knappen Kopiera bredvid nyckeln och klistra in nyckeln i ett säkert dokument för att säkerställa att den aldrig försvinner.
⚠️ VARNING! Detta är enda gången den fullständiga API-nyckeln kan nås. När du har stängt modalen kan den fullständiga nyckeln inte läsas igen.
När du har kopierat och sparat nyckeln klickar du på knappen Stäng .
I de flesta fall behöver du bara en API-nyckel. Men 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 få åtkomst till API:t
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 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 att hantera 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. Det betyder 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 sin organisations SSO.
Personer i ditt API-team har inte tillgång till resten av Webex Events plattformen som arrangörer har. 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 riktiga evenemang och appar på Webex Events plattformen, bjud in dem till relevanta team som inte är API.
4. Förbered en händelse
Eftersom API:et inte kan aktivera någon av produkterna i ett evenemang, såsom Event App och Onsite, måste du aktivera varje produkt som du tänker använda i ditt evenemang och fylla i den grundläggande informationen.
Arbeta med utvecklare
Det är viktigt för dig att tydligt kommunicera med dina utvecklare så att de kan bygga det du behöver. Det betyder att du behöver veta vilka delar av Webex Events plattformen som API:et kan komma åt. Fortsätt läsa för att lära dig exakt vad API:et kan komma åt och kontrollera, plus några tips som hjälper dig att "tala samma språk" som din utvecklare.
När du är bekant med de grundläggande funktionerna kan du börja prata med din utvecklare om att bygga verktyg och automatiseringar med API:et.
Lag och organisationer
Skapa, uppdatera, läs och ta bort team och teammedlemmar
evenemang
Skapa, uppdatera, klona och läs. Händelser kan inte raderas.
Deltagare
Skapa, uppdatera, läs, tilldela till sessioner, tilldela till grupper och ta bort information om sociala konton (telefonnummer, handtag för sociala konton, etc). Deltagare kan inte tas bort, även om de kan blockeras.
Frågor
Skapa, uppdatera, läs och ta bort
Tips: I API:t kallas frågor "anpassade fält"
Grupper
Skapa, uppdatera, läs och ta bort både exklusiva och icke-exklusiva grupper
Sessioner
Skapa, uppdatera, läs och ta bort
Platser
Skapa, uppdatera, läs och ta bort
Tips: I API:t kallas platser för "regioner".
Branded Apps
Läs Branded App , statusar och namn på tilldelade händelser
Event App
Läs inställningarna Grunder, Utseende och Web App samt information om Video Center
Skapa, uppdatera, läs och ta bort följande Event App funktioner och deras objekt, där så är tillämpligt:
Dagordning
Sponsorer
Högtalare
Utställare
Direktsändning
Deltagare
Anpassad lista
Enstaka föremål
Webblänk
Webblista
Min QR-kod
💡 Tänk på att du manuellt måste lägga till och konfigurera alla Event App funktioner som inte anges ovan.
Tips: I API:t kallas funktioner för "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äs och uppdatera beställningar
Skicka order- och biljettbekräftelsemail
Markera check- eller fakturaorder som betalda
Uppdatera information om beställning av köpare
Avboka och återbetala biljetter
Skapa, läs, uppdatera, ta bort, pausa och återuppta kampanjkoder
Skapa, läs, uppdatera och ta bort skatter
Tips: I API:t kallas frågor "anpassade fält".
På Onsite
Läs och uppdatera grunderna och information om Onsite App
Lead Retrieval och Live Display
Läs om produkten är aktiv eller publicerad i Eventet
Saker att veta
Vi kommer då och då att släppa nya versioner av API:t 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 gå över till den nya versionen. Vi skickar e-postuppdateringar om nya versioner, kommande utfasningsdatum för gamla versioner och officiella utfasningar.
API-förfrågningar mäts och begränsas för att förhindra missbruk.
Gemenskaper stöds också för Suite-kunder.