Komme i gang med Webex Events API

Hvis du har en utvikler i teamet ditt som vet hvordan du bruker en GraphQL API, kan Webex Events API være inngangsporten din til kraftige hendelses- og produktoppsett- og administrasjonsautomatiseringer, tredjeparts plattformintegrasjoner, kraftige dashbord for flere hendelser og mer.

Hva Webex Events API kan gjøre

Enkelt sagt, et API er et programmeringsgrensesnitt som utviklere kan bruke til å hente data fra eller legge data inn i en online plattform - i dette tilfellet, Webex Events.

APIs evner kan forenkles til fire grunnleggende konsepter:

Lag noe som ikke eksisterte før, for eksempel en deltaker, en økt eller en hel begivenhet.
Oppdater alt API-en kan brukes til å lage, pluss noen få ting til. API kan for eksempel brukes til å opprette en ny deltaker, og deretter redigere deltakerens navn, e-post, status, grupper, telefonnumre og sosiale kontoer.
Les informasjon om alt API-en kan brukes til å lage eller redigere, pluss noen ting det ikke kan.
Slett alt API-en kan brukes til å lage, med noen unntak.

Husk disse konseptene mens du leser delen «Arbeide med utviklere» i denne artikkelen.

Hvordan komme i gang

1. Få tilgang til API

Hvis du er en Webex Suite Enterprise Agreement (Suite EA) -kunde som allerede har Webex Events aktivert, får du automatisk tilgang til Webex Events API! For alle andre kunder, snakk med Webex Events-kontakten din eller supportteamet vårt for å lære om hvordan du får tilgang til API-en.

2. Opprett en API-nøkkel

Nå må du opprette en ny API-nøkkel som utviklerne dine kan bruke. Når du har tilgang til API-en, legges en ny fane til på siden «Organisasjonsinnstillinger» i Webex Events-plattformen. Slik får du tilgang til den nye fanen og oppretter din første nøkkel:

Husk at bare organisasjonsadministratorer har tilgang til API-siden.

Fra hvor som helst i Webex Events-plattformen klikker du på profilbildet ditt øverst til høyre på skjermen, og velger deretter Organisasjonsinnstillinger fra rullegardinmenyen.
Klikk på AP I- fanen i menyen til venstre på siden for organisasjonsinnstillinger. Dette tar deg til API-dashbordet der du kan se gjennom API-bruk, eksportere brukslogger, administrere nøkler, og få tilgang til API-dokumentasjonen vår.
Klikk på Opprett nøkkel.
I modalen 'Opprett ny nøkkel' skriver du inn en etikett for API-nøkkelen som forklarer hva den skal brukes til.
Nedtrekksmenyen for API-versjon vil allerede ha den gjeldende versjonen valgt, så bare klikk Lagre. Dette avslører API-nøkkelen.
Klikk på Kopier -knappen ved siden av nøkkelen og lim inn nøkkelen i et sikkert dokument for å sikre at den aldri går tapt.

ADVARSEL! Dette er den eneste gangen du kan få tilgang til hele API-nøkkelen. Etter at du har lukket modalen, kan ikke hele nøkkelen leses igjen.

Etter at du har kopiert og lagret nøkkelen, klikker du på Lukk- knappen.

I de fleste tilfeller trenger du bare en API-nøkkel. Men i situasjoner der du jobber med flere team, kan det være lurt å opprette en nøkkel for hvert team. Snakk med utviklerne dine om dine spesifikke brukstilfeller for å finne ut den beste løsningen.

3. Inviter utviklere til å få tilgang til API

Når du oppretter din første API-nøkkel, opprettes et nytt API-team automatisk i Webex Events-plattformen. Å gi utviklerne tilgang til å prøve Webex Events API er like enkelt som å invitere dem til det API-teamet. Følg instruksjonene i artikkelen vår om å administrere team, medlemmer og studiepoeng for å lære hvordan.

Husk at API-sandkassen er en egen versjon av Webex Events-plattformen laget spesielt for testing. Dette betyr at alle nye medlemmer av API Sandbox-teamet må opprette en ny plattformkonto for å bruke sandkassen, selv om de allerede har en plattformkonto eller logger på med organisasjonens SSO.

Personer i API-teamet ditt har ikke tilgang til resten av Webex Events-plattformen slik arrangørene gjør. I stedet har API-teammedlemmer tilgang til en API «sandkasse» der de kan teste det de bygger uten å påvirke data fra den virkelige verden. Hvis du vil at utviklere også skal ha tilgang til noen eller alle dine virkelige hendelser og apper i Webex Events-plattformen, kan du invitere dem til relevante ikke-API-team.

4. Vær snill mot utviklerne

Dette er avgjørende, så vi tok det til et helt skritt. 😉

«Roma ble ikke bygget på en dag», og heller ikke en god API-integrasjon. Vær en god venn for utviklerne dine og gi dem god tid til å komme i gang med Webex Events API før du forventer at de skal levere integrasjoner. De vil være takknemlige for ikke å bli presset.

I det minste anbefaler vi at du starter samtaler med utviklerne dine minst seks måneder før du trenger integrasjoner som fungerer. Fortsett å lese for å lære hvordan du forbereder deg på og har disse samtalene.

Arbeide med utviklere

Etter at du har invitert utviklere til Webex Events Sandbox-teamet ditt, kan et av de første spørsmålene dine være: «Hvor lang tid tar det å bygge integrasjoner?» Å svare på dette spørsmålet avhenger av mange faktorer, inkludert hvor mange utviklere du jobber med, hvor mye tid de har til å jobbe med integrasjoner, hvor komplekse integrasjonene er, og mer.

Bare utviklerne dine kan fortelle deg hvor lang tid det vil ta å sette opp en integrasjon, og bare etter noen få viktige trinn:

Les først seksjonene nedenfor for å lære hva API kan gjøre. Dette vil hjelpe deg å forstå hva som er mulig, slik at du tydelig kan kommunisere dine behov med utviklerne dine.
Møt utviklerne dine, del API-dokumentasjonen vår med dem, og diskuter hva du ønsker. De vil kunne gi grunnleggende tilbakemelding på hva de kan og ikke kan gjøre for deg. De vil imidlertid ikke kunne gi deg spesifikke tidslinjer før de er kjent med Webex Events API.
Gi utviklerne tid til å gjøre seg kjent med API-en. Gjør deg tilgjengelig for å svare på konseptuelle eller praktiske spørsmål om hendelsene dine, data, Webex Events-plattformen og alt annet.

Hva API kan gjøre

API har to grunnleggende funksjoner:

Les - Få data fra Webex Events slik at du kan undersøke dem eller trekke dem inn i et annet system.
Oppdater - Sett data i Webex Events for å opprette nye elementer eller synkronisere data, for eksempel deltakere, fra en annen plattform. Alt som endrer noe i Webex Events-plattformen er en oppdatering.

Lag og organisasjoner

Opprette, oppdatere, lese og slette team og teammedlemmer

Hendelser

Oppdater, klone og les. Hendelser kan ikke opprettes eller slettes med API.

Deltakere

Opprett, oppdater, les, tilordne til økter, tilordne til grupper og slett sosial kontoinformasjon (telefonnummer, sosiale kontohåndtak osv.). Deltakere kan ikke slettes, selv om de kan blokkeres.

Spørsmål

Opprette, oppdatere, lese og slette

Tips: I API-en kalles spørsmål «egendefinerte felt»

Grupper

Opprett, oppdater, les og slett både eksklusive og ikke-eksklusive grupper

Økter

Opprette, oppdatere, lese og slette

Steder

Opprette, oppdatere, lese og slette

Tips: I API-en kalles lokasjoner «regioner».

Merkevareapper

Les navn på merkede apper, statuser og navn på tildelte hendelser

Arrangement-app

Les grunnleggende informasjon, utseende og Web App innstillinger samt informasjon om Video Center Recordings
Opprett, oppdater, les og slett følgende Event App-funksjoner og deres elementer, der det er aktuelt:
- Dagsorden
- Sponsorer
- Høyttalere
- Utstillere
- Direkte strømming
- Deltakere
- Egendefinert liste
- Enkelt element
- Nettlenke
- Nettliste
- Min QR-kode

Husk at du må legge til og konfigurere alle Event App-funksjoner som ikke er oppført ovenfor manuelt.

Tips: I API-en kalles funksjoner «komponenter».

Registrering

Les informasjon om grunnleggende informasjon, utseende og innstillinger, inkludert innstillinger for kassen
Opprett, les, oppdater og slett billetter, skjemaer, spørsmål, kampanjekoder
Opprette, lese og oppdatere bestillinger
Send e-post med bestilling og billettbekreftelse
Merk sjekk- eller fakturabestillinger som betalt
Oppdater informasjon om bestillingskjøper
Avbestille og refundere billetter
Opprett, les, oppdater, slett, pause og gjenoppta kampanjekoder
Opprette, lese, oppdatere og slette skatter

Tips: I API-en kalles spørsmål «egendefinerte felt».

På stedet

Les og oppdater Grunnleggende informasjon og informasjon om Onsite-appen

Lead Innhenting og Live Display

Les om produktet er aktivt eller publisert i arrangementet

Ting å vite

API-en kan ikke brukes til å opprette en hendelse eller aktivere noen av produktene i en hendelse, for eksempel Event App og Onsite. Før utviklere kan endre en hendelse med API-en, må du aktivere hvert produkt du har tenkt å bruke og fylle ut den grunnleggende nødvendige informasjonen for hvert enkelt.
Vi vil av og til gi ut nye versjoner av API med forbedringer og reparasjoner. Vi vil fortsette å støtte gamle versjoner lenge nok til at alle kan overføre den nye versjonen. Vi sender e-postoppdateringer om nye versjoner, kommende utfasningsdatoer for gammel versjon, og offisielle utfasninger.
API-forespørsler måles og begrenses for å forhindre misbruk.
Samfunn støttes også for Suite-kunder.

Cisco AI Assistant

Takk for tilbakemeldingen.