Spring videre til hovedindholdet
Alle samlingerIntegrationer og partnerskaber
Kom godt i gang med Webex Events API
Kom godt i gang med Webex Events API

Hvad API'en gør, og hvordan man kommer i gang

Daniel Murphey avatar
Skrevet af Daniel Murphey
Opdateret over en uge siden

Denne artikel blev oversat fra engelsk ved hjælp af maskinoversættelse.

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 platformintegrationer, kraftfulde multi-event data dashboards og mere .

Hvad Webex Events API kan gøre

Enkelt sagt er en API en programmeringsgrænseflade, som udviklere kan bruge til at hente data fra eller lægge data ind på en online platform - i dette tilfælde Webex Events.

API'ens muligheder kan forenkles til fire grundlæggende begreber:

  • Opret noget, der ikke eksisterede før, som en deltager, en session eller en hel begivenhed.

  • Opdater alt, hvad API'en kan bruges til at oprette, plus et par ting mere. For eksempel kan API'en bruges til at oprette en ny deltager og derefter redigere denne deltagers navn, e-mail, status, grupper, telefonnumre og sociale konti.

  • Læs information om alt, hvad API'et kan bruges til at oprette eller redigere, plus nogle ting, det ikke kan.

  • Slet alt, hvad API'en kan bruges til at oprette, med nogle undtagelser.

Hold disse begreber i tankerne, mens du læser afsnittet 'Arbejd med udviklere' i denne artikel.

Sådan kommer du i gang

1. Få adgang til API'et

Hvis du er en Webex Suite Enterprise Agreement (Suite EA)-kunde, som allerede har Webex Events aktiveret, får du automatisk adgang til Webex Events API! For alle andre kunder, tal med din Webex Events kontakt eller vores supportteam for at lære 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 'Organisationsindstillinger' i Webex Events platformen. Sådan får du adgang til den nye fane og opretter din første nøgle:

💡 Husk, kun organisationsadministratorer kan få adgang til API-siden.

  1. Hvor som helst på Webex Events platformen, klik på dit profilbillede i øverste højre hjørne af skærmen, og vælg derefter Organisationsindstillinger fra rullemenuen.

  2. På siden med organisationsindstillinger skal du klikke på fanen API i menuen til venstre. 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.

  3. Klik på Opret nøgle .

  4. Indtast en etiket for API-nøglen i 'Opret ny nøgle'-modal, der forklarer, hvad den skal bruges til.

  5. API-versionens rullemenu vil allerede have den aktuelle version valgt, så klik blot på Gem . Dette afslører API-nøglen.

  6. Klik på knappen Kopier ved siden af ​​nøglen, og indsæt nøglen i et sikkert dokument for at sikre, at den aldrig går tabt.

    ⚠️ ADVARSEL! Dette er den eneste gang, den fulde API-nøgle kan tilgås. Når du har lukket modalen, kan den fulde nøgle ikke læses igen.

  7. Når du har kopieret og gemt nøglen, skal du klikke på knappen Luk .

I de fleste tilfælde har du kun brug for én API-nøgle. Men i situationer, hvor du arbejder med flere teams, vil du måske oprette en nøgle til hvert team. Tal med dine udviklere om dine specifikke use cases 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 i Webex Events platformen. At give dine udviklere adgang til at prøve Webex Events API er lige så enkelt som at invitere dem til det API-team. Følg instruktionerne i vores artikel om administration 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. Det betyder, at alle nye medlemmer af API Sandbox-teamet skal oprette en ny platformskonto for at bruge sandboxen, selvom de allerede har en platformskonto eller logger på med deres organisations SSO.

Folk på dit API-team har ikke adgang til resten af ​​Webex Events platformen, som arrangører har. I stedet har API-teammedlemmer adgang til en API "sandbox", 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 af eller alle dine rigtige begivenheder og apps i Webex Events platformen, skal du invitere dem til relevante ikke-API-teams.

4. Forbered en begivenhed

Fordi API'en ikke kan aktivere nogen af ​​produkterne i en begivenhed, såsom Event App og Onsite, skal du aktivere hvert produkt, du har til hensigt at bruge i dit arrangement, ved at udfylde de grundlæggende nødvendige oplysninger.

Arbejder med udviklere

Det er vigtigt for dig at kommunikere tydeligt med dine udviklere, så de kan bygge det, du har brug for. Det betyder, at du skal vide, hvilke dele af Webex Events -platformen API'en kan få adgang til. Fortsæt med at læse for at lære præcis, hvad API'en kan få adgang til og kontrollere, plus et par tips til at hjælpe dig med at "tale samme sprog" som din udvikler.

Når du er fortrolig med de grundlæggende funktioner, kan du begynde at tale med din udvikler om at bygge værktøjer og automatiseringer med API'en.

Teams og organisationer

  • Opret, opdater, læs og slet teams og teammedlemmer

Begivenheder

  • Opret, opdater, klon og læs. Begivenheder kan ikke slettes.

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 "tilpassede felter"

Grupper

  • Opret, opdater, læs og slet både eksklusive og ikke-eksklusive grupper

Sessioner

  • Opret, opdater, læs og slet

Placeringer

  • Opret, opdater, læs og slet

Tip: I API'en kaldes placeringer "regioner".

Branded Apps

  • Læs Branded App navne, statusser og navnene på tildelte begivenheder

Event App

  • Læs Basics, Udseende og Web App-indstillinger plus oplysninger om Video Center

  • Opret, opdater, læs og slet følgende Event App funktioner og deres elementer, hvor det er relevant:

    • Dagsorden

    • Sponsorer

    • Højttalere

    • Udstillere

    • Live stream

    • Deltagere

    • Brugerdefineret liste

    • Enkelt vare

    • Weblink

    • Webliste

    • Min QR-kode

💡 Husk, du skal manuelt tilføje og konfigurere Event App funktioner, der ikke er angivet ovenfor.

Tip: I API'en kaldes funktioner "komponenter".

Registrering

  • Læs oplysninger om grundlæggende, udseende og indstillinger, inklusive betalingsindstillinger

  • Opret, læs, opdater og slet billetter, formularer, spørgsmål, kampagnekoder

  • Opret, læs og opdater ordrer

  • Send ordre- og billetbekræftelsesmails

  • 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

  • Opret, læs, opdater og slet skatter

Tip: I API'et kaldes spørgsmål "tilpassede felter".

På Onsite

  • Læs og opdater Basics og Onsite App -oplysninger

Lead Retrieval og Live Display

  • Læs om produktet er aktivt eller offentliggjort i Eventet

Ting at vide

  • Vi vil lejlighedsvis frigive nye versioner af API'et med forbedringer og rettelser. Vi vil fortsætte med at understøtte gamle versioner længe nok til, at alle kan skifte til den nye version. Vi sender e-mailopdateringer om nye versioner, kommende udfasningsdatoer for gamle versioner og officielle udfasninger.

  • API-anmodninger måles og begrænses for at forhindre misbrug.

  • Fællesskaber understøttes også for Suite-kunder.

Besvarede dette dit spørgsmål?