Questo articolo è stato tradotto dall'inglese utilizzando la traduzione automatica.
Se nel tuo team è presente uno sviluppatore che sa come utilizzare un'API GraphQL, l'API Webex Events potrebbe essere il tuo gateway per potenti automazioni di configurazione e gestione di eventi e prodotti, integrazioni di piattaforme di terze parti, potenti dashboard di dati multi-evento 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 o inserirli in una piattaforma online, in questo caso Webex Events.
Le funzionalità dell'API possono essere semplificate in quattro concetti di base:
Crea qualcosa che prima non esisteva, come un partecipante, una sessione o un intero evento.
Aggiorna tutto ciò che l'API può creare, oltre ad alcune altre cose. Ad esempio, l'API può essere utilizzata per creare un nuovo partecipante e quindi modificare il nome, l'e-mail, lo stato, i gruppi, i numeri di telefono e gli account social del partecipante.
Leggi le informazioni su tutto ciò che l'API può creare o modificare, oltre ad alcune cose che non può essere utilizzata.
Elimina tutto ciò che l'API può creare, con alcune eccezioni.
Tieni a mente questi concetti mentre leggi la sezione "Lavorare con gli sviluppatori" di questo articolo.
Come iniziare
1. Ottieni l'accesso all'API
Se sei un cliente Webex Suite Enterprise Agreement (Suite EA) che ha già attivato Webex Events , ottieni automaticamente l'accesso all'API Webex Events ! Per tutti gli altri clienti, parlare con il contatto Webex Events o con il nostro team di supporto per informazioni sull'accesso all'API.
2. Crea una chiave API
Ora devi creare una nuova chiave API che i tuoi sviluppatori possano utilizzare. Quando si ha accesso all'API, viene aggiunta una nuova scheda alla pagina "Impostazioni organizzazione" nella piattaforma Webex Events . Ecco come accedere alla nuova scheda e creare la tua prima chiave:
💡 Tieni presente che solo gli amministratori dell'organizzazione possono accedere alla pagina API.
Da qualsiasi punto della piattaforma Webex Events , fare clic sull'immagine del profilo nell'angolo in alto a destra dello schermo, quindi selezionare Impostazioni organizzazione dal menu a discesa.
Nella pagina Impostazioni organizzazione, fai clic sulla scheda API nel menu a sinistra. Verrai indirizzato al dashboard dell'API dove potrai esaminare l'utilizzo dell'API, esportare i registri di utilizzo, gestire le chiavi e accedere alla nostra documentazione API.
Fare clic su Crea chiave .
Nella modalità "Crea nuova chiave" inserisci un'etichetta per la chiave API che spiega per cosa verrà utilizzata.
Nel menu a discesa della versione API sarà già selezionata la versione corrente, quindi fai semplicemente clic su Salva . Questo rivela la chiave API.
Fai clic sul pulsante Copia accanto alla chiave e incolla la chiave in un documento protetto per assicurarti che non venga mai persa.
⚠️ ATTENZIONE! Questo è l'unico momento in cui è possibile accedere alla chiave API completa. Dopo aver chiuso la finestra modale, non è possibile leggere nuovamente la chiave completa.
Dopo aver copiato e salvato la chiave, fare clic sul pulsante Chiudi .
Nella maggior parte dei casi, è necessaria una sola chiave API. Tuttavia, nelle situazioni in cui lavori con più team, potresti voler creare una chiave per ogni team. Parla con i tuoi sviluppatori dei tuoi casi d'uso specifici per trovare la soluzione migliore.
3. Invita gli sviluppatori ad accedere all'API
Quando si crea la prima chiave API, un nuovo team API viene creato automaticamente nella piattaforma Webex Events . Concedere ai tuoi sviluppatori l'accesso per provare l'API Webex Events è semplice come invitarli a quel team API. Segui le istruzioni nel nostro articolo sulla gestione di team, membri e crediti per scoprire come.
💡 Tieni presente che la sandbox API è una versione separata della piattaforma Webex Events realizzata appositamente per i test. Ciò significa che tutti i nuovi membri del team API Sandbox devono creare un nuovo account di piattaforma per utilizzare Sandbox, anche se dispongono già di un account di piattaforma o accedono con l'SSO della propria organizzazione.
Le persone del 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 costruendo senza influire sui dati del mondo reale. Se si desidera che gli sviluppatori abbiano accesso anche ad alcuni o a tutti gli eventi e le app reali nella piattaforma Webex Events , invitarli ai team non API pertinenti.
4. Preparare un evento
Poiché l'API non può attivare nessuno dei prodotti in un Evento, come l' Event App e Onsite, devi attivare ciascun prodotto che intendi utilizzare nel tuo Evento, compilando le informazioni di base richieste.
Lavorare con gli sviluppatori
È importante che tu comunichi chiaramente con i tuoi sviluppatori in modo che possano creare ciò di cui hai bisogno. Ciò significa che è necessario sapere a quali parti della piattaforma Webex Events può accedere l'API. Continua a leggere per scoprire esattamente a cosa può accedere e controllare l'API, oltre ad alcuni suggerimenti per aiutarti a "parlare la stessa lingua" del tuo sviluppatore.
Una volta acquisita familiarità con le funzionalità di base, puoi iniziare a parlare con il tuo sviluppatore della creazione di strumenti e automazioni con l'API.
Squadre e organizzazioni
Crea, aggiorna, leggi ed elimina team e membri del team
Eventi
Crea, aggiorna, clona e leggi. Gli eventi non possono essere eliminati.
Partecipanti
Crea, aggiorna, leggi, assegna a sessioni, assegna a gruppi ed elimina le informazioni dell'account social (numero di telefono, handle dell'account social, ecc.). I partecipanti non possono essere eliminati, ma possono essere bloccati.
Domande
Crea, aggiorna, leggi ed elimina
Suggerimento: nell'API, le domande sono chiamate "campi personalizzati"
Gruppi
Crea, aggiorna, leggi ed elimina gruppi esclusivi e non esclusivi
Sessioni
Crea, aggiorna, leggi ed elimina
Posizioni
Crea, aggiorna, leggi ed elimina
Suggerimento: nell'API, le località sono chiamate "regioni".
Branded Apps
Leggi i nomi, gli stati e i nomi Branded App e i nomi degli eventi assegnati
Event App
Leggi le impostazioni di base, aspetto e app Web oltre alle informazioni sulle registrazioni Video Center
Crea, aggiorna, leggi ed elimina le seguenti funzionalità Event App e i relativi elementi, ove applicabile:
ordine del giorno
Sponsor
Altoparlanti
Espositori
Trasmissione in diretta
Partecipanti
Elenco personalizzato
Articolo singolo
Collegamento web
Elenco Web
Il mio codice QR
💡 Tieni presente che devi aggiungere e configurare manualmente tutte le funzionalità Event App non elencate sopra.
Suggerimento: nell'API, le funzionalità sono chiamate "componenti".
Registrazione
Leggi le informazioni di base, l'aspetto e le impostazioni, comprese le impostazioni di pagamento
Crea, leggi, aggiorna ed elimina biglietti, moduli, domande, codici promozionali
Crea, leggi e aggiorna gli ordini
Invia email di conferma dell'ordine e del biglietto
Contrassegna gli ordini con assegno o fattura come pagati
Aggiorna le informazioni sull'acquirente dell'ordine
Annulla e rimborsa i biglietti
Crea, leggi, aggiorna, elimina, metti in pausa e riprendi i codici promozionali
Crea, leggi, aggiorna ed elimina le tasse
Suggerimento: nell'API, le domande sono chiamate "campi personalizzati".
Onsite
Leggere e aggiornare le informazioni di base e Onsite App
Lead Retrieval e Live Display
Leggi se il prodotto è attivo o pubblicato nell'Evento
Cose da sapere
Occasionalmente pubblicheremo 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 deprecazione delle vecchie versioni e sulle deprecazioni ufficiali.
Le richieste API sono misurate e limitate per prevenire abusi.
Sono supportate anche le community per i clienti Suite.