Tak for din feedback.
Har du feedback?Hvis du har en udvikler på dit team, der ved, hvordan man bruger en GraphQL-API, kan Webex Events API være din gateway til kraftfulde hændelses- og produktopsætnings- og administrationsautomatiseringer, tredjeparts platformsintegrationer, kraftfulde multi-hændelsesdatadashboards og mere.
Hvad Webex Events API kan gøre
Kort sagt er en API en programmeringsgrænseflade, som udviklere kan bruge til at hente data fra eller lægge data ind i en online platform - i dette tilfælde Webex Events.
API's muligheder kan forenkles til fire grundlæggende begreber:
-
Opret noget, der ikke eksisterede før, f.eks. en deltager, en session eller en hel begivenhed.
-
Opdater alt, hvad API'en kan bruges til at oprette, plus et par flere ting. API'en kan f.eks. bruges til at oprette en ny deltager og derefter redigere deltagerens navn, e-mail, status, grupper, telefonnumre og sociale konti.
-
Læs oplysninger om alt, hvad API'en kan bruges til at oprette eller redigere, plus nogle ting, den ikke kan.
-
Slet alt, som API'en kan bruges til at oprette, med nogle undtagelser.
Husk disse begreber, mens du læser afsnittet „Arbejde med udviklere“ i denne artikel.
Sådan kommer du i gang
1. Få adgang til API'en
Hvis du er en Webex Suite Enterprise Agreement (Suite EA) kunde, der allerede har Webex Events aktiveret, får du automatisk adgang til Webex Events API! For alle andre kunder skal du tale med din Webex Events-kontakt eller vores supportteam for at få mere at vide om adgang til API'en.
2. Opret en API-nøgle
Nu skal du oprette en ny API-nøgle, som dine udviklere kan bruge. Når du har adgang til API'en, tilføjes en ny fane til siden 'Orgindstillinger 'i Webex Events-platformen. Sådan får du adgang til den nye fane og opretter din første nøgle:
Husk, at kun organisationsadministratorer kan få adgang til API-siden.
-
Fra hvor som helst i Webex Events-platformen skal du klikke på dit profilbillede i øverste højre hjørne af skærmen og derefter vælge Organisationsindstillinger på rullemenuen.
-
Klik på fanen API i menuen til venstre på siden Orgindstillinger. Dette fører dig til API-dashboardet, hvor du kan gennemgå API-brug, eksportere brugslogfiler, administrere nøgler og få adgang til vores API-dokumentation.
-
Klik på Opret nøgle.
-
I modalet 'Opret ny nøgle' skal du indtaste en etiket til API-nøglen, der forklarer, hvad den vil blive brugt til.
-
Rullemenuen API-version har allerede valgt den aktuelle version, så klik blot på Gem. Dette afslører API-nøglen.
-
Klik på knappen Kop ier ud for nøglen, og indsæt nøglen i et sikkert dokument for at sikre, at det aldrig går tabt.
ADVARSEL! Dette er den eneste gang, den fulde API-nøgle kan tilgås. Når du har lukket modalet, kan den fulde nøgle ikke læses igen.
-
Når du har kopieret og gemt nøglen, skal du klikke på knappen L uk.
I de fleste tilfælde behøver du kun en API-nøgle. Men i situationer, hvor du arbejder med flere teams, kan det være en god idé at oprette en nøgle for hvert team. Tal med dine udviklere om dine specifikke brugssager for at finde ud af den bedste løsning.
3. Inviter udviklere til at få adgang til API'en
Når du opretter din første API-nøgle, oprettes der automatisk et nyt API-team på Webex Events-platformen. At give dine udviklere adgang til at prøve Webex Events API er så simpelt som at invitere dem til det API-team. Følg instruktionerne i vores artikel om styring af teams, medlemmer og kreditter for at lære hvordan.
Husk, API-sandkassen er en separat version af Webex Events-platformen lavet specielt til test. Dette betyder, at alle nye medlemmer af API Sandbox-teamet skal oprette en ny platformkonto for at bruge sandkassen, selvom de allerede har en platformkonto eller logger ind med deres organisations SSO.
Personer på dit API-team har ikke adgang til resten af Webex Events-platformen, som arrangørerne gør. I stedet har API-teammedlemmer adgang til en API „sandkasse“, hvor de kan teste, hvad de bygger uden at påvirke data fra den virkelige verden. Hvis du ønsker, at udviklere også skal have adgang til nogle eller alle dine virkelige begivenheder og apps på Webex Events-platformen, skal du invitere dem til relevante ikke-API-teams.
4. Vær venlig over for dine udviklere
Dette er afgørende, så vi tog det et helt skridt. 😉
„Rom blev ikke bygget på en dag“, og det var heller ikke en god API-integration. Vær en god ven for dine udviklere, og giv dem masser af tid til at komme i gang med Webex Events API, før du forventer, at de leverer integrationer. De vil være taknemmelige for ikke at blive presset.
Som minimum anbefaler vi, at du starter samtaler med dine udviklere mindst seks måneder, før du har brug for integrationer, der fungerer. Fortsæt med at læse for at lære, hvordan du forbereder dig på og fører disse samtaler.
Arbejde med udviklere
Når du har inviteret udviklere til dit Webex Events Sandbox-team, kan et af dine første spørgsmål være: „Hvor lang tid tager det at bygge integrationer?“ Besvarelsen af dette spørgsmål afhænger af mange faktorer, herunder hvor mange udviklere du arbejder med, hvor meget tid de har til at arbejde på integrationer, hvor komplekse integrationerne er og meget mere.
Kun dine udviklere kan fortælle dig, hvor lang tid det tager at oprette en integration, og først efter et par vigtige trin:
-
Læs først afsnittene nedenfor for at lære, hvad API'en kan gøre. Dette vil hjælpe dig med at forstå, hvad der er muligt, så du tydeligt kan kommunikere dine behov med dine udviklere.
-
Mød dine udviklere, del vores API-dokumentation med dem, og diskuter, hvad du ønsker. De vil være i stand til at give grundlæggende feedback om, hvad de kan og ikke kan gøre for dig. De vil dog ikke være i stand til at give dig specifikke tidslinjer, før de er fortrolige med Webex Events API.
-
Giv dine udviklere tid til at gøre sig bekendt med API'en. Gør dig tilgængelig for at besvare konceptuelle eller praktiske spørgsmål om dine begivenheder, data, Webex Events-platformen og alt andet.
Hvad API'en kan gøre
API'en har to grundlæggende funktioner:
-
Læs - Hent data fra Webex Events, så du kan undersøge dem eller trække dem ind i et andet system.
-
Opdatering - Sæt data i Webex Events for at oprette nye elementer eller synkronisere data, såsom deltagere, fra en anden platform. Alt, der ændrer noget i Webex Events-platformen, er en opdatering.
Teams og organisationer
-
Opret, opdater, læs og slet teams og teammedlemmer
Begivenheder
-
Opdater, klon og læs. Begivenheder kan ikke oprettes eller slettes med API'en.
Deltagere
-
Opret, opdater, læs, tildel til sessioner, tildel til grupper og slet sociale kontooplysninger (telefonnummer, sociale kontohåndtag osv.). Deltagere kan ikke slettes, selvom de kan blokeres.
Spørgsmål
-
Opret, opdater, læs og slet
Tip: I API'en kaldes spørgsmål „brugerdefinerede felter“
Grupper
-
Opret, opdater, læs og slet både eksklusive og ikke-eksklusive grupper
Sessioner
-
Opret, opdater, læs og slet
Lokaliteter
-
Opret, opdater, læs og slet
Tip: I API'en kaldes placeringer „regioner“.
Mærkede apps
-
Læs navne på brandede apps, statusser og navne på tildelte begivenheder
Begivenhedsapp
-
Læs Grundlæggende oplysninger, Udseende og Web App indstillinger samt oplysninger om Videocenteroptagelser
-
Opret, opdater, læs og slet følgende Event App-funktioner og deres elementer, hvor det er relevant:
-
Dagsorden
-
Sponsorer
-
Højttalere
-
Udstillere
-
Livestream
-
Deltagere
-
Brugerdefineret liste
-
Enkelt element
-
Weblink
-
Webliste
-
Min QR-kode
-
Husk, at du manuelt skal tilføje og konfigurere alle Event App-funktioner, der ikke er angivet ovenfor.
Tip: I API'en kaldes funktioner „komponenter“.
Registrering
-
Læs oplysninger om Grundlæggende oplysninger, Udseende og Indstillinger, herunder betalingsindstillinger
-
Opret, læs, opdater og slet billetter, formularer, spørgsmål, kampagnekoder
-
Opret, læs og opdater ordrer
-
Send ordre- og billetbekræftelses-e-mails
-
Marker check- eller fakturaordrer som betalte
-
Opdater ordrekøberoplysninger
-
Annuller og refunder billetter
-
Opret, læs, opdater, slet, sæt på pause og genoptag kampagnekoder
-
Oprette, læse, opdatere og slette skatter
Tip: I API'en kaldes spørgsmål „brugerdefinerede felter“.
På stedet
-
Læs og opdater Basic-oplysninger og Onsite-app-oplysninger
Lead Hentning og Live Display
-
Læs om produktet er aktivt eller offentliggjort i begivenheden
Ting at vide
-
API'en kan ikke bruges til at oprette en begivenhed eller aktivere nogen af produkterne i en begivenhed, f.eks. Event App og Onsite. Før udviklere kan ændre en begivenhed med API'en, skal du aktivere hvert produkt, du har til hensigt at bruge, og udfylde de grundlæggende nødvendige oplysninger for hvert enkelt.
-
Vi frigiver lejlighedsvis nye versioner af API'en med forbedringer og rettelser. Vi vil fortsætte med at understøtte gamle versioner længe nok til, at alle kan skifte den nye version. Vi sender opdateringer via e-mail om nye versioner, kommende forældelsesdatoer for gamle versioner, og officielle forældelser.
-
API-anmodninger måles og begrænses for at forhindre misbrug.
-
Communities understøttes også for Suite-kunder.
