Gracias por sus comentarios.
¿Comentarios?Si tiene un desarrollador en su equipo que sabe cómo usar una API GraphQL, la API de Webex Events podría ser su puerta de entrada a potentes automatizaciones de administración y configuración de eventos y productos, integraciones de plataformas de terceros, potentes paneles de datos multievento y más.
Qué puede hacer la API de Webex Events
En pocas palabras, una API es una interfaz de programación que los desarrolladores pueden usar para obtener datos de o poner datos en una plataforma en línea, en este caso, Webex Events.
Las capacidades de la API se pueden simplificar a cuatro conceptos básicos:
-
Cree algo que no existía antes, como un asistente, una sesión o un evento completo.
-
Actualice cualquier cosa que la API pueda ser utilizada para crear, además de algunas cosas más. Por ejemplo, la API se puede usar para crear un nuevo asistente y luego editar el nombre, correo electrónico, estado, grupos, números de teléfono y cuentas sociales de ese asistente.
-
Lea información sobre cualquier cosa que la API pueda ser utilizada para crear o editar, además de algunas cosas que no puede.
-
Elimine cualquier cosa que la API pueda ser utilizada para crear, con algunas excepciones.
Tenga en cuenta estos conceptos mientras lee la sección “Trabajar con desarrolladores” de este artículo.
Cómo empezar
1. Obtenga acceso a la API
Si es un cliente de Webex Suite Enterprise Agreement (Suite EA) que ya tiene Webex Events activado, ¡automáticamente obtiene acceso a la API de Webex Events! Para todos los demás clientes, hable con su contacto de Webex Events o con nuestro equipo de soporte para obtener información sobre cómo acceder a la API.
2. Crear una clave API
Ahora necesita crear una nueva clave API para que sus desarrolladores la usen. Cuando tiene acceso a la API, se agrega una nueva pestaña a la página “Configuración de la organización” en la plataforma Webex Events. A continuación, le indicamos cómo acceder a la nueva pestaña y crear su primera clave:
Tenga en cuenta que solo los administradores de la organización pueden acceder a la página API.
-
Desde cualquier lugar de la plataforma Webex Events, haga clic en su imagen de perfil en la esquina superior derecha de la pantalla y, a continuación, seleccione Configuración de la organización en el menú desplegable.
-
En la página Configuración de la organización, haga clic en la pestaña API en el menú de la izquierda. Esto lo lleva al panel de API donde puede revisar el uso de API, exportar registros de uso, administrar claves y acceder a nuestra documentación de API.
-
Haga clic en Crear clave.
-
En el modal “Crear nueva clave”, introduzca una etiqueta para la clave API que explique para qué se utilizará.
-
La versión desplegable de la API ya tendrá la versión actual seleccionada, así que simplemente haga clic en Guardar. Esto revela la clave API.
-
Haga clic en el botón Copiar junto a la clave y pegue la clave en un documento seguro para asegurarse de que nunca se pierda.
¡ADVERTENCIA! Esta es la única vez que se puede acceder a la clave API completa. Después de cerrar el modal, la clave completa no se puede leer de nuevo.
-
Después de haber copiado y guardado la clave, haga clic en el botón Cerrar.
En la mayoría de los casos, solo necesita una clave API. Sin embargo, en situaciones en las que está trabajando con varios equipos, es posible que desee crear una clave para cada equipo. Hable con sus desarrolladores sobre sus casos de uso específicos para encontrar la mejor solución.
3. Invitar a los desarrolladores a acceder a la API
Cuando crea su primera clave API, se crea automáticamente un nuevo equipo de API en la plataforma Webex Events. Dar a sus desarrolladores acceso para probar la API de Webex Events es tan simple como invitarlos a ese equipo de API. Siga las instrucciones de nuestro artículo sobre la gestión de equipos, miembros y créditos para aprender cómo.
Tenga en cuenta que el sandbox de API es una versión separada de la plataforma Webex Events hecha especialmente para pruebas. Esto significa que todos los nuevos miembros del equipo de API Sandbox deben crear una nueva cuenta de plataforma para usar el sandbox, incluso si ya tienen una cuenta de plataforma o inician sesión con el SSO de su organización.
Las personas de su equipo de API no tienen acceso al resto de la plataforma Webex Events como lo hacen los organizadores. En cambio, los miembros del equipo de API tienen acceso a un “sandbox” de API donde pueden probar lo que están construyendo sin afectar los datos del mundo real. Si desea que los desarrolladores también tengan acceso a algunos o todos sus eventos y aplicaciones reales en la plataforma Webex Events, invítelos a equipos relevantes que no sean API.
4. Sea amable con sus desarrolladores
Esto es crucial, así que hicimos todo un paso. 😉
“Roma no se construyó en un día”, y tampoco una buena integración de API. Sea un buen amigo de sus desarrolladores y déles tiempo suficiente para ponerse al día con la API de Webex Events antes de esperar que entreguen integraciones. Estarán agradecidos de no ser presionados.
Como mínimo, recomendamos iniciar conversaciones con sus desarrolladores no menos de seis meses antes de que necesite que las integraciones funcionen. Siga leyendo para aprender cómo prepararse y tener esas conversaciones.
Trabajando con desarrolladores
Después de haber invitado a desarrolladores a su equipo de Webex Events Sandbox, una de sus primeras preguntas puede ser: “¿Cuánto tiempo llevará construir integraciones?” Responder a esta pregunta depende de muchos factores, incluyendo cuántos desarrolladores está trabajando, cuánto tiempo tienen para trabajar en integraciones, qué tan complejas son las integraciones y más.
Solo sus desarrolladores pueden decirle cuánto tiempo llevará la configuración de una integración, y solo después de algunos pasos cruciales:
-
Primero, lea las secciones siguientes para saber qué puede hacer la API. Esto le ayudará a entender lo que es posible para que pueda comunicar claramente sus necesidades con sus desarrolladores.
-
Reúnete con sus desarrolladores, comparta nuestra documentación de API con ellos y discuta lo que quiere. Ellos serán capaces de dar retroalimentación básica sobre lo que pueden y no pueden hacer por usted. Sin embargo, no podrán darle plazos específicos hasta que estén familiarizados con la API de Webex Events.
-
Dé tiempo a sus desarrolladores para que se familiaricen con la API. Esté disponible para responder preguntas conceptuales o prácticas sobre sus eventos, datos, la plataforma Webex Events y cualquier otra cosa.
Qué puede hacer la API
La API tiene dos funciones básicas:
-
Leer: obtenga datos de Webex Events para que pueda examinarlos o introducirlos en un sistema diferente.
-
Actualización: coloque datos en Webex Events para crear nuevos elementos o sincronizar datos, como los asistentes, desde otra plataforma. Cualquier cosa que cambie algo en la plataforma Webex Events es una actualización.
Equipos y organizaciones
-
Crear, actualizar, leer y eliminar equipos y miembros del equipo
Eventos
-
Actualice, clone y lea. Los eventos no se pueden crear ni eliminar con la API.
Asistentes
-
Cree, actualice, lea, asigne a sesiones, asigne a grupos y elimine información de cuentas sociales (número de teléfono, identificadores de cuentas sociales, etc.). Los asistentes no pueden ser eliminados, aunque pueden ser bloqueados.
Preguntas
-
Crear, actualizar, leer y eliminar
Consejo: En la API, las preguntas se llaman “campos personalizados”
Grupos
-
Crear, actualizar, leer y eliminar grupos exclusivos y no exclusivos
Sesiones
-
Crear, actualizar, leer y eliminar
Ubicaciones
-
Crear, actualizar, leer y eliminar
Consejo: En la API, las ubicaciones se llaman “regiones”.
Aplicaciones de marca
-
Lea los nombres de las aplicaciones de marca, los estados y los nombres de los eventos asignados
Aplicación Evento
-
Lea los conceptos básicos, la apariencia y la Web App configuración, además de la información de las grabaciones del centro de video
-
Cree, actualice, lea y elimine las siguientes funciones de Event App y sus elementos, cuando corresponda:
-
Orden del día
-
Patrocinadores
-
Altavoces
-
Expositores
-
Transmisión en vivo
-
Asistentes
-
Lista personalizada
-
Un solo artículo
-
Enlace Web
-
Lista Web
-
Mi código QR
-
Tenga en cuenta que debe agregar y configurar manualmente cualquier función de Event App no enumerada anteriormente.
Consejo: En la API, las características se denominan “componentes”.
Registro
-
Lea información básica, apariencia y configuración, incluida la configuración de pago
-
Cree, lea, actualice y elimine boletos, formularios, preguntas, códigos promocionales
-
Crear, leer y actualizar pedidos
-
Enviar correos electrónicos de confirmación de pedidos y boletos
-
Marque los pedidos de cheques o facturas como pagados
-
Actualizar la información del comprador del pedido
-
Cancelar y reembolsar boletos
-
Crear, leer, actualizar, eliminar, pausar y reanudar códigos promocionales
-
Crear, leer, actualizar y eliminar impuestos
Consejo: En la API, las preguntas se llaman “campos personalizados”.
En el sitio
-
Lea y actualice los conceptos básicos y la información de la aplicación in situ
Recuperación de Lead y Exhibición en Vivo
-
Lea si el producto está activo o publicado en el evento
Cosas que debe saber
-
La API no se puede usar para crear un evento o activar ninguno de los productos de un evento, como la aplicación del evento y en el sitio. Antes de que los desarrolladores puedan modificar un evento con la API, debe activar cada producto que desee usar y completar la información básica requerida para cada uno.
-
Ocasionalmente lanzaremos nuevas versiones de la API con mejoras y correcciones. Seguiremos soportando versiones antiguas el tiempo suficiente para que todos puedan hacer la transición a la nueva versión. Enviaremos actualizaciones por correo electrónico sobre nuevas versiones, próximas fechas de desactualización de versiones antiguas y desdaciones oficiales.
-
Las solicitudes de API se miden y se limitan para evitar abusos.
-
Las comunidades también son compatibles con los clientes de Suite.
