Se nel suo team c'è uno sviluppatore che sa usare un'API GraphQL, l'API Webex Events potrebbe essere la sua porta di accesso a potenti automazioni di configurazione e gestione di eventi e prodotti, integrazioni di piattaforme di terze parti, potenti dashboard di dati multievento e altro ancora.
Cosa può fare l'API Webex Events
In parole povere, un'API è un'interfaccia di programmazione che gli sviluppatori possono utilizzare per ottenere dati da o inserirli in una piattaforma online, in questo caso, Webex Events.
Le funzionalità dell'API possono essere semplificate in quattro concetti base:
-
Crea qualcosa che prima non esisteva, come un partecipante, una sessione o un intero evento.
-
Aggiorna tutto ciò che l'API può essere utilizzata per creare, più qualche altra cosa. Ad esempio, l'API può essere utilizzata per creare un nuovo partecipante e quindi modificare il nome, l'email, lo stato, i gruppi, i numeri di telefono e gli account social del partecipante.
-
Leggi informazioni su tutto ciò che l'API può essere utilizzata per creare o modificare, oltre ad alcune cose che non può.
-
Elimini tutto ciò che l'API può essere utilizzata per creare, con alcune eccezioni.
Tenga a mente questi concetti mentre legge la sezione «Lavorare con gli sviluppatori» di questo articolo.
Come iniziare
1. Ottenere l'accesso all'API
Se è un cliente Webex Suite Enterprise Agreement (Suite EA) che ha già attivato Webex Events, ottiene automaticamente l'accesso all'API Webex Events! Per tutti gli altri clienti, parli con il suo contatto Webex Events o con il nostro team di supporto per informazioni sull'accesso all'API.
2. Crei una chiave API
Ora deve creare una nuova chiave API da utilizzare per i suoi sviluppatori. Quando ha accesso all'API, viene aggiunta una nuova scheda alla pagina «Impostazioni dell'organizzazione» nella piattaforma Webex Events. Ecco come accedere alla nuova scheda e creare la sua prima chiave:
Tenga presente che solo gli amministratori dell'organizzazione possono accedere alla pagina API.
-
Da qualsiasi punto della piattaforma Webex Events, faccia clic sull'immagine del suo profilo nell'angolo in alto a destra dello schermo, quindi selezioni Impostazioni dell'organizzazione dal menu a discesa.
-
Nella pagina delle impostazioni dell'organizzazione, faccia clic sulla scheda API nel menu a sinistra. Questo La porta alla dashboard dell'API dove può esaminare l'utilizzo dell'API, esportare i log di utilizzo, gestire le chiavi e accedere alla nostra documentazione API.
-
Faccia clic su Crea chiave.
-
Nella modalità «Crea nuova chiave» inserisca un'etichetta per la chiave API che spieghi per cosa verrà utilizzata.
-
Nel menu a discesa della versione dell'API sarà già selezionata la versione corrente, quindi è sufficiente fare clic su Salva. Questo rivela la chiave API.
-
Fai clic sul pulsante Copia accanto alla chiave e incolla la chiave in un documento sicuro per assicurarsi che non vada mai persa.
ATTENZIONE! Questa è l'unica volta in cui è possibile accedere alla chiave API completa. Dopo aver chiuso la modalità, la chiave completa non può essere letta di nuovo.
-
Dopo aver copiato e salvato la chiave, faccia clic sul pulsante Chiudi.
Nella maggior parte dei casi, Le serve solo una chiave API. Tuttavia, in situazioni in cui lavora con più team, potrebbe voler creare una chiave per ogni team. Parli con i suoi sviluppatori dei suoi casi d'uso specifici per trovare la soluzione migliore.
3. Invita gli sviluppatori ad accedere all'API
Quando crea la sua prima chiave API, viene creato automaticamente un nuovo team API nella piattaforma Webex Events. Consentire ai suoi sviluppatori l'accesso per provare l'API Webex Events è semplice come invitarli a far parte di quel team API. Segua le istruzioni del nostro articolo sulla gestione dei team, dei membri e dei crediti per scoprire come.
Tenga presente che la sandbox API è una versione separata della piattaforma Webex Events creata appositamente per i test. Ciò significa che tutti i nuovi membri del team API Sandbox devono creare un nuovo account di piattaforma per utilizzare la sandbox, anche se hanno già un account di piattaforma o accedono con l'SSO della loro organizzazione.
Le persone del suo team API non hanno accesso al resto della piattaforma Webex Events come fanno gli organizzatori. Invece, i membri del team API hanno accesso a una «sandbox» API in cui possono testare ciò che stanno creando senza influire sui dati del mondo reale. Se desidera che gli sviluppatori abbiano accesso anche ad alcuni o tutti i suoi eventi e app reali nella piattaforma Webex Events, li inviti nei team non API pertinenti.
4. Sia gentile con i suoi sviluppatori
Questo è fondamentale, quindi abbiamo fatto un passo avanti. 😉
«Roma non è stata costruita in un giorno» e nemmeno una buona integrazione delle API. Sia un buon amico dei suoi sviluppatori e conceda loro tutto il tempo per aggiornarsi sull'API Webex Events prima di aspettarsi che forniscano integrazioni. Saranno grati di non subire pressioni.
Come minimo, consigliamo di avviare conversazioni con i suoi sviluppatori non meno di sei mesi prima che le integrazioni funzionino. Continui a leggere per imparare a prepararsi e ad avere quelle conversazioni.
Lavorare con gli sviluppatori
Dopo aver invitato gli sviluppatori nel suo team Webex Events Sandbox, una delle sue prime domande potrebbe essere: «Quanto tempo ci vorrà per creare integrazioni?» La risposta a questa domanda dipende da molti fattori, tra cui il numero di sviluppatori con cui lavora, il tempo a disposizione per lavorare sulle integrazioni, la complessità delle integrazioni e altro ancora.
Solo i suoi sviluppatori possono dirle quanto tempo richiederà l'integrazione per la configurazione e solo dopo alcuni passaggi cruciali:
-
Innanzitutto, legga le sezioni seguenti per scoprire cosa può fare l'API. Questo La aiuterà a capire cosa è possibile in modo da poter comunicare chiaramente le sue esigenze ai suoi sviluppatori.
-
Incontra i suoi sviluppatori, condividi con loro la nostra documentazione sulle API e discuti di ciò che desidera. Saranno in grado di fornire un feedback di base su ciò che possono e non possono fare per Lei. Tuttavia, non saranno in grado di fornirle tempistiche specifiche finché non avranno familiarità con l'API Webex Events.
-
Dai ai suoi sviluppatori il tempo di familiarizzare con l'API. Si renda disponibile a rispondere a domande concettuali o pratiche sui suoi eventi, sui suoi dati, sulla piattaforma Webex Events e su qualsiasi altra cosa.
Cosa può fare l'API
L'API ha due funzioni di base:
-
Lettura - Recupera i dati da Webex Events in modo da poterli esaminare o inserirli in un altro sistema.
-
Aggiornamento: inserisce i dati in Webex Events per creare nuovi elementi o sincronizzare i dati, ad esempio i partecipanti, da un'altra piattaforma. Tutto ciò che modifica qualcosa nella piattaforma Webex Events è un aggiornamento.
Team e organizzazioni
-
Creare, aggiornare, leggere ed eliminare team e membri del team
Eventi
-
Aggiorna, clona e legga. Gli eventi non possono essere creati o eliminati con l'API.
Partecipanti
-
Crea, aggiorna, leggi, assegna a sessioni, assegna a gruppi ed elimina le informazioni sugli account social (numero di telefono, handle di account social, ecc.). I partecipanti non possono essere eliminati, ma possono essere bloccati.
Domande
-
Creare, aggiornare, leggere ed eliminare
Suggerimento: nell'API, le domande sono chiamate «campi personalizzati»
Gruppi
-
Creare, aggiornare, leggere ed eliminare gruppi esclusivi e non esclusivi
Sessioni
-
Creare, aggiornare, leggere ed eliminare
Sedi
-
Creare, aggiornare, leggere ed eliminare
Suggerimento: nell'API, le località sono chiamate «regioni».
App di marca
-
Leggi i nomi, gli stati e i nomi degli eventi assegnati alle app con marchio
App per eventi
-
Leggi le nozioni di base, l'aspetto e Web App le impostazioni oltre alle informazioni sulle registrazioni di Video Center
-
Crea, aggiorna, leggi ed elimina le seguenti funzionalità dell'Event App e i relativi elementi, ove applicabile:
-
Agenda
-
Sponsor
-
Altoparlanti
-
Espositori
-
Stream in diretta
-
Partecipanti
-
Elenco personalizzato
-
Articolo singolo
-
Collegamento Web
-
Elenco Web
-
Il mio codice QR
-
Tenga presente che deve aggiungere e configurare manualmente tutte le funzionalità dell'Event App non elencate sopra.
Suggerimento: nell'API, le funzionalità sono chiamate «componenti».
Registrazione
-
Leggi le informazioni di base, sull'aspetto e sulle impostazioni, comprese le impostazioni di pagamento
-
Creare, leggere, aggiornare ed eliminare biglietti, moduli, domande, codici promozionali
-
Creare, leggere e aggiornare gli ordini
-
Invii email di conferma degli ordini e dei biglietti
-
Contrassegna gli ordini con assegno o fattura come pagati
-
Aggiornare le informazioni sull'acquirente dell'ordine
-
Annullare e rimborsare i biglietti
-
Creare, leggere, aggiornare, eliminare, mettere in pausa e riprendere i codici promozionali
-
Creare, leggere, aggiornare ed eliminare le tasse
Suggerimento: nell'API, le domande sono chiamate «campi personalizzati».
In loco
-
Legga e aggiorna le informazioni di base e sull'app Onsite
Recupero dei lead e visualizzazione dal vivo
-
Legga se il prodotto è attivo o pubblicato nell'Evento
Cose da sapere
-
L'API non può essere utilizzata per creare un evento o attivare nessuno dei prodotti di un evento, come l'Event App e Onsite. Prima che gli sviluppatori possano modificare un evento con l'API, deve attivare ogni prodotto che intende utilizzare e inserire le informazioni di base richieste per ognuno di essi.
-
Di tanto in tanto rilasceremo nuove versioni dell'API con miglioramenti e correzioni. Continueremo a supportare le vecchie versioni abbastanza a lungo da consentire a tutti di passare alla nuova versione. Invieremo aggiornamenti via email sulle nuove versioni, sulle prossime date di obsolescenza delle vecchie versioni e sulle deprecature ufficiali.
-
Le richieste API sono misurate e limitate per prevenire abusi.
-
Le community sono supportate anche per i clienti della Suite.