Cet article a été traduit de l'anglais à l'aide de la traduction automatique.
Si vous avez un développeur dans votre équipe qui sait utiliser une API GraphQL, l'API Webex Events pourrait être votre passerelle vers de puissantes automatisations de configuration et de gestion d'événements et de produits, des intégrations de plateformes tierces, de puissants tableaux de bord de données multi-événements, et bien plus encore. .
Ce que l'API Webex Events peut faire
En termes simples, une API est une interface de programmation que les développeurs peuvent utiliser pour obtenir ou placer des données sur une plateforme en ligne – dans ce cas, Webex Events.
Les capacités de l'API peuvent être simplifiées en quatre concepts de base :
Créez quelque chose qui n'existait pas auparavant, comme un participant, une session ou un événement entier.
Mettez à jour tout ce que l'API peut être utilisée pour créer, ainsi que quelques autres éléments. Par exemple, l'API peut être utilisée pour créer un nouveau participant, puis modifier son nom, son adresse e-mail, son statut, ses groupes, ses numéros de téléphone et ses comptes sociaux.
Lisez des informations sur tout ce que l'API peut être utilisée pour créer ou modifier, ainsi que sur certaines choses qu'elle ne peut pas.
Supprimez tout ce que l'API peut être utilisée pour créer, à quelques exceptions près.
Gardez ces concepts à l'esprit lorsque vous lisez la section « Travailler avec les développeurs » de cet article.
Comment commencer
1. Accédez à l'API
Si vous êtes un client Webex Suite Enterprise Agreement (Suite EA) et que Webex Events est déjà activé, vous avez automatiquement accès à l'API Webex Events ! Pour tous les autres clients, parlez à votre contact Webex Events ou à notre équipe d’assistance pour en savoir plus sur l’accès à l’API.
2. Créez une clé API
Vous devez maintenant créer une nouvelle clé API que vos développeurs pourront utiliser. Lorsque vous avez accès à l'API, un nouvel onglet est ajouté à la page « Paramètres de l'organisation » dans la plateforme Webex Events . Voici comment accéder au nouvel onglet et créer votre première clé :
💡 Gardez à l'esprit que seuls les administrateurs de l'organisation peuvent accéder à la page API.
Depuis n’importe où sur la plateforme Webex Events , cliquez sur votre image de profil dans le coin supérieur droit de l’écran, puis sélectionnez Paramètres de l’organisation dans la liste déroulante.
Sur la page Paramètres de l'organisation, cliquez sur l'onglet API dans le menu de gauche. Cela vous amène au tableau de bord de l'API où vous pouvez consulter l'utilisation de l'API, exporter les journaux d'utilisation, gérer les clés et accéder à notre documentation API.
Cliquez sur Créer une clé .
Dans le modal « Créer une nouvelle clé », saisissez une étiquette pour la clé API qui explique à quoi elle sera utilisée.
La liste déroulante de la version de l'API aura déjà la version actuelle sélectionnée, alors cliquez simplement sur Enregistrer . Cela révèle la clé API.
Cliquez sur le bouton Copier à côté de la clé et collez la clé dans un document sécurisé pour vous assurer qu'elle ne sera jamais perdue.
⚠️ATTENTION ! C'est la seule fois où la clé API complète est accessible. Après avoir fermé le modal, la clé complète ne peut plus être lue.
Après avoir copié et enregistré la clé, cliquez sur le bouton Fermer .
Dans la plupart des cas, vous n’avez besoin que d’une seule clé API. Toutefois, dans les situations où vous travaillez avec plusieurs équipes, vous souhaiterez peut-être créer une clé pour chaque équipe. Discutez avec vos développeurs de vos cas d'utilisation spécifiques pour trouver la meilleure solution.
3. Invitez les développeurs à accéder à l'API
Lorsque vous créez votre première clé API, une nouvelle équipe API est automatiquement créée dans la plateforme Webex Events . Donner à vos développeurs l’accès pour essayer l’API Webex Events est aussi simple que de les inviter dans cette équipe API. Suivez les instructions de notre article sur la gestion des équipes, des membres et des crédits pour savoir comment procéder.
💡 Gardez à l'esprit que le bac à sable API est une version distincte de la plateforme Webex Events spécialement conçue pour les tests. Cela signifie que tous les nouveaux membres de l'équipe API Sandbox doivent créer un nouveau compte de plateforme pour utiliser le bac à sable, même s'ils disposent déjà d'un compte de plateforme ou se connectent avec le SSO de leur organisation.
Les membres de votre équipe API n’ont pas accès au reste de la plateforme Webex Events comme le font les organisateurs. Au lieu de cela, les membres de l'équipe API ont accès à un « bac à sable » API où ils peuvent tester ce qu'ils construisent sans affecter les données du monde réel. Si vous souhaitez que les développeurs aient également accès à tout ou partie de vos événements et applications réels sur la plateforme Webex Events , invitez-les dans les équipes non API concernées.
4. Préparez un événement
Étant donné que l'API ne peut activer aucun des produits d'un événement, tels que l' Event App et Onsite, vous devez activer chaque produit que vous avez l'intention d'utiliser dans votre événement, en remplissant les informations de base requises.
Travailler avec les développeurs
Il est important que vous communiquiez clairement avec vos développeurs afin qu'ils puissent créer ce dont vous avez besoin. Cela signifie que vous devez savoir à quelles parties de la plateforme Webex Events l’API peut accéder. Continuez à lire pour savoir exactement à quoi l'API peut accéder et contrôler, ainsi que quelques conseils pour vous aider à « parler le même langage » que votre développeur.
Lorsque vous êtes familiarisé avec les fonctionnalités de base, vous pouvez commencer à discuter avec votre développeur de la création d'outils et d'automatisations avec l'API.
Équipes et organisations
Créer, mettre à jour, lire et supprimer des équipes et des membres de l'équipe
Événements
Créez, mettez à jour, clonez et lisez. Les événements ne peuvent pas être supprimés.
Participants
Créez, mettez à jour, lisez, attribuez à des sessions, attribuez à des groupes et supprimez les informations de compte social (numéro de téléphone, identifiants de compte social, etc.). Les participants ne peuvent pas être supprimés, mais ils peuvent être bloqués.
Des questions
Créer, mettre à jour, lire et supprimer
Astuce : Dans l'API, les questions sont appelées "champs personnalisés".
Groupes
Créer, mettre à jour, lire et supprimer des groupes exclusifs et non exclusifs
Séances
Créer, mettre à jour, lire et supprimer
Emplacements
Créer, mettre à jour, lire et supprimer
Astuce : Dans l'API, les emplacements sont appelés « régions ».
Branded Apps
Lire les noms, les statuts et les noms des Branded App ainsi que les noms des événements attribués
Event App
Lisez les paramètres de base, d'apparence et de l'application Web, ainsi que les informations sur les enregistrements du Video Center .
Créez, mettez à jour, lisez et supprimez les fonctionnalités suivantes de Event App et leurs éléments, le cas échéant :
Ordre du jour
Commanditaires
Haut-parleurs
Exposants
Direct
Participants
Liste customisée
Un seul article
Lien Web
Liste Web
Mon QRCode
💡 Gardez à l'esprit que vous devez ajouter et configurer manuellement toutes les fonctionnalités de Event App non répertoriées ci-dessus.
Astuce : Dans l'API, les fonctionnalités sont appelées « composants ».
Inscription
Lire les informations de base, d'apparence et de paramètres, y compris les paramètres de paiement
Créer, lire, mettre à jour et supprimer des tickets, formulaires, questions, codes promotionnels
Créer, lire et mettre à jour les commandes
Envoyer des e-mails de confirmation de commande et de billet
Marquer les commandes par chèque ou par facture comme payées
Mettre à jour les informations de l'acheteur de la commande
Annuler et rembourser les billets
Créer, lire, mettre à jour, supprimer, suspendre et reprendre les codes promotionnels
Créer, lire, mettre à jour et supprimer des taxes
Astuce : Dans l'API, les questions sont appelées « champs personnalisés ».
Sur Onsite
Lire et mettre à jour les informations de base et sur Onsite App
Lead Retrieval et Live Display
Lire si le produit est actif ou publié dans l'événement
Choses à savoir
Nous publierons occasionnellement de nouvelles versions de l'API avec des améliorations et des correctifs. Nous continuerons à prendre en charge les anciennes versions suffisamment longtemps pour que tout le monde puisse passer à la nouvelle version. Nous vous enverrons des mises à jour par e-mail sur les nouvelles versions, les dates de dépréciation des anciennes versions et les dépréciations officielles.
Les requêtes API sont mesurées et limitées pour éviter les abus.
Les communautés sont également prises en charge pour les clients Suite.