Merci pour votre commentaire.
Un commentaire ?Si votre équipe compte un développeur qui sait comment utiliser une API GraphQL, l'API Webex Events pourrait être votre passerelle vers de puissantes automatisations de configuration et de gestion des événements et des produits, des intégrations de plateformes tierces, de puissants tableaux de bord de données multi-événements, etc.
Ce que peut faire l'API Webex Events
En termes simples, une API est une interface de programmation que les développeurs peuvent utiliser pour obtenir des données ou les mettre sur une plateforme en ligne, en l'occurrence Webex Events.
Les fonctionnalités de l'API peuvent être simplifiées selon quatre concepts de base :
-
Créez quelque chose qui n'existait pas auparavant, comme un participant, une session ou tout un événement.
-
Mettez à jour tout ce que l'API peut créer, et bien d'autres choses encore. 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é pour créer ou modifier, et sur d'autres choses qu'elle ne peut pas utiliser.
-
Supprimez tout ce que l'API peut créer, à quelques exceptions près.
Gardez ces concepts à l'esprit en lisant la section « Travailler avec les développeurs » de cet article.
Comment commencer
1. Accédez à l'API
Si vous êtes cliente de l'Webex SuiteEnterprise 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, adressez-vous à votre contact Webex Events ou à notre équipe d'assistance pour en savoir plus sur l'accès à l'API.
2. Créer 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 » de la plateforme Webex Events. Voici comment accéder au nouvel onglet et créer votre première clé :
N'oubliez pas 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 en haut à droite de l'écran, puis sélectionnez Paramètres de l'organisation dans la liste déroulante.
-
Sur la page des paramètres de l'organisation, cliquez sur l'onglet API dans le menu de gauche. Cela vous amène au tableau de bord des API où vous pouvez consulter l'utilisation des API, exporter les journaux d'utilisation, gérer les clés et accéder à notre documentation sur les API.
-
Cliquez sur Créer une clé.
-
Dans le modal « Créer une nouvelle clé », saisissez un libellé pour la clé API qui explique à quoi elle servira.
-
La version actuelle sera déjà sélectionnée dans la liste déroulante des versions de l'API, il suffit donc de cliquer sur Enregistrer. Cela révèle la clé API.
-
Cliquez sur le bouton Copier à côté de la clé et collez-la dans un document sécurisé pour ne jamais la perdre.
ATTENTION ! C'est la seule fois que la clé API complète est accessible. Une fois le modal fermé, la touche 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. Cependant, dans les situations où vous travaillez avec plusieurs équipes, vous pouvez créer une clé pour chaque équipe. Discutez de vos cas d'utilisation spécifiques avec vos développeurs afin de trouver la meilleure solution.
3. Inviter les développeurs à accéder à l'API
Lorsque vous créez votre première clé API, une nouvelle équipe d'API est automatiquement créée sur la plateforme Webex Events. Permettre à vos développeurs d'essayer l'API Webex Events est aussi simple que de les inviter à rejoindre cette équipe d'API. Suivez les instructions de notre article sur la gestion des équipes, des membres et des crédits pour savoir comment.
N'oubliez pas que le sandbox de l'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 sur la plateforme pour utiliser le sandbox, même s'ils ont déjà un compte sur la plateforme ou s'ils 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 sont en train de créer sans affecter les données réelles. Si vous souhaitez que les développeurs aient également accès à certains ou à la totalité de vos événements et applications réels sur la plateforme Webex Events, invitez-les à rejoindre les équipes concernées ne disposant pas d'API.
4. Soyez gentille avec vos développeurs
C'est crucial, nous avons donc franchi une étape importante. 😉
« Rome ne s'est pas construite en un jour », pas plus qu'une bonne intégration d'API. Soyez l'amie de vos développeurs et donnez-leur le temps de se familiariser avec l'API Webex Events avant de s'attendre à ce qu'ils proposent des intégrations. Ils seront reconnaissants de ne pas subir de pression.
Au minimum, nous vous recommandons d'engager la conversation avec vos développeurs au moins six mois avant que les intégrations ne fonctionnent. Continuez à lire pour savoir comment vous préparer et avoir ces conversations.
Travailler avec des développeurs
Après avoir invité des développeurs à rejoindre votre équipe Webex Events Sandbox, l'une de vos premières questions sera peut-être : « Combien de temps faudra-t-il pour créer des intégrations ? » La réponse à cette question dépend de nombreux facteurs, notamment du nombre de développeurs avec lesquels vous travaillez, du temps dont ils disposent pour travailler sur les intégrations, de leur complexité, etc.
Seuls vos développeurs peuvent vous dire combien de temps il faudra pour mettre en place une intégration, et ce uniquement après quelques étapes cruciales :
-
Lisez d'abord les sections ci-dessous pour découvrir ce que peut faire l'API. Cela vous aidera à comprendre ce qui est possible et à communiquer clairement vos besoins à vos développeurs.
-
Rencontrez vos développeurs, partagez-leur la documentation de notre API et discutez de ce que vous voulez. Ils seront en mesure de vous donner des informations de base sur ce qu'ils peuvent et ne peuvent pas faire pour vous. Cependant, ils ne seront pas en mesure de vous donner un calendrier précis tant qu'ils ne seront pas familiarisés avec l'API Webex Events.
-
Donnez à vos développeurs le temps de se familiariser avec l'API. Soyez disponible pour répondre à des questions conceptuelles ou pratiques concernant vos événements, vos données, la plateforme Webex Events et tout le reste.
Ce que peut faire l'API
L'API possède deux fonctions de base :
-
Lire - Obtenez des données auprès de Webex Events afin de pouvoir les examiner ou les intégrer à un autre système.
-
Mise à jour - Insérez des données dans Webex Events pour créer de nouveaux éléments ou synchroniser des données, telles que les participants, depuis une autre plateforme. Tout ce qui change quelque chose sur la plateforme Webex Events est une mise à jour.
Équipes et organisations
-
Créer, mettre à jour, lire et supprimer des équipes et des membres de l'équipe
Événements
-
Mettez à jour, clonez et lisez. Les événements ne peuvent être ni créés ni supprimés à l'aide de l'API.
Participants
-
Créez, mettez à jour, lisez, assignez à des sessions, assignez à des groupes et supprimez les informations des comptes sociaux (numéro de téléphone, pseudonymes de comptes sociaux, etc.). Les participants ne peuvent pas être supprimés, mais ils peuvent être bloqués.
Des questions
-
Créer, mettre à jour, lire et supprimer
Conseil : 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
Lieux
-
Créer, mettre à jour, lire et supprimer
Conseil : Dans l'API, les lieux sont appelés « régions ».
Applications de marque
-
Lisez les noms des applications de marque, les statuts et les noms des événements assignés
Application événementielle
-
Lisez les bases, l'apparence et Web App les paramètres, ainsi que les informations sur les enregistrements du centre vidéo
-
Créez, mettez à jour, lisez et supprimez les fonctionnalités suivantes de l'application Event et leurs objets, le cas échéant :
-
Ordre du jour
-
Sponsors
-
Haut-parleurs
-
Exposants
-
Diffusion en direct
-
Participants
-
Liste personnalisée
-
Article unique
-
Lien Web
-
Liste Web
-
Mon code QR
-
N'oubliez pas que vous devez ajouter et configurer manuellement toutes les fonctionnalités de l'application événementielle qui ne figurent pas dans la liste ci-dessus.
Conseil : Dans l'API, les fonctionnalités sont appelées « composants ».
Inscription
-
Lisez les informations de base, l'apparence et les paramètres, y compris les paramètres de paiement
-
Créer, lire, mettre à jour et supprimer des billets, des formulaires, des questions et des codes promotionnels
-
Créer, lire et mettre à jour des commandes
-
Envoyer des e-mails de confirmation de commande et de billets
-
Marquer les commandes par chèque ou sur facture comme réglées
-
Mettre à jour les informations relatives à l'acheteur
-
Annuler et rembourser des billets
-
Créer, lire, mettre à jour, supprimer, suspendre et reprendre des codes promotionnels
-
Créer, lire, mettre à jour et supprimer des impôts
Conseil : Dans l'API, les questions sont appelées « champs personnalisés ».
Sur place
-
Lisez et mettez à jour les informations de base et de l'application Onsite
Récupération des pistes et affichage en direct
-
Découvrez si le produit est actif ou publié dans The Event
Ce qu'il faut savoir
-
L'API ne peut pas être utilisée pour créer un événement ou activer l'un des produits d'un événement, comme l'application Event et Onsite. Avant que les développeurs puissent modifier un événement à l'aide de l'API, vous devez activer chaque produit que vous souhaitez utiliser et renseigner les informations de base requises pour chacun d'entre eux.
-
Nous publierons de temps en temps de nouvelles versions de l'API avec des améliorations et des correctifs. Nous continuerons à prendre en charge les anciennes versions assez longtemps pour que tout le monde puisse passer à la nouvelle version. Nous enverrons des mises à jour par e-mail concernant les nouvelles versions, les prochaines dates de dépréciation des anciennes versions et les dépréciations officielles.
-
Les demandes d'API sont mesurées et limitées pour éviter les abus.
-
Les communautés sont également prises en charge pour les clients de Suite.
