Este artículo fue traducido del inglés mediante traducción automática.
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 poderosas automatizaciones de administración y configuración de eventos y productos, integraciones de plataformas de terceros, potentes paneles de datos de múltiples eventos 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 utilizar para obtener o colocar 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 todo lo que la API pueda crear, además de algunas cosas más. Por ejemplo, la API se puede utilizar para crear un nuevo asistente y luego editar el nombre, el correo electrónico, el estado, los grupos, los números de teléfono y las cuentas sociales de ese asistente.
Lea información sobre cualquier cosa que la API pueda crear o editar, además de algunas cosas que no puede.
Elimine todo lo que la API pueda crear, con algunas excepciones.
Tenga en cuenta estos conceptos al leer la sección "Trabajar con desarrolladores" de este artículo.
Cómo empezar
1. Obtenga acceso a la API
Si es cliente del Acuerdo empresarial de Webex Suite (Suite EA) y ya tiene activado Webex Events , obtendrá acceso automáticamente 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. Cree una clave API
Ahora necesita crear una nueva clave API para que la utilicen sus desarrolladores. 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 luego seleccione Configuración de la organización en el menú desplegable.
En la página de configuración de la organización, haga clic en la pestaña API en el menú de la izquierda. Esto lo llevará 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 modo 'Crear nueva clave', ingrese una etiqueta para la clave API que explique para qué se utilizará.
El menú desplegable de versión de API ya tendrá seleccionada la versión actual, así que simplemente haga clic en Guardar . Esto revela la clave API.
Haga clic en el botón Copiar junto a la clave y péguela 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 volver a leer.
Después de haber copiado y guardado la clave, haga clic en el botón Cerrar .
En la mayoría de los casos, solo necesitas una clave API. Sin embargo, en situaciones en las que trabaja 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. Invita a los desarrolladores a acceder a la API.
Cuando crea su primera clave API, se crea automáticamente un nuevo equipo API en la plataforma Webex Events . Dar acceso a sus desarrolladores para que prueben la API de Webex Events es tan simple como invitarlos a ese equipo de API. Siga las instrucciones de nuestro artículo sobre cómo administrar equipos, miembros y créditos para aprender cómo hacerlo.
💡 Tenga en cuenta que el entorno de pruebas de API es una versión independiente de la plataforma Webex Events creada especialmente para pruebas. Esto significa que todos los nuevos miembros del equipo de API Sandbox deben crear una nueva cuenta de plataforma para usar 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 tienen los organizadores. En cambio, los miembros del equipo de API tienen acceso a una "zona de pruebas" de API donde pueden probar lo que están creando 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. Prepara un evento
Debido a que la API no puede activar ninguno de los productos en un Evento, como la Event App y Onsite, debes activar cada producto que deseas utilizar en tu Evento, completando la información básica requerida.
Trabajando con desarrolladores
Es importante que te comuniques claramente con tus desarrolladores para que puedan crear lo que necesitas. Esto significa que necesita saber a qué partes de la plataforma Webex Events puede acceder la API. Continúe leyendo para saber exactamente a qué puede acceder y controlar la API, además de algunos consejos que le ayudarán a "hablar el mismo idioma" que su desarrollador.
Cuando esté familiarizado con las capacidades básicas, puede comenzar a hablar con su desarrollador sobre la creación de herramientas y automatizaciones con la API.
Equipos y organizaciones
Crear, actualizar, leer y eliminar equipos y miembros del equipo
Eventos
Crea, actualiza, clona y lee. Los eventos no se pueden eliminar.
Asistentes
Cree, actualice, lea, asigne sesiones, asigne grupos y elimine información de cuentas sociales (número de teléfono, identificadores de cuentas sociales, etc.). Los asistentes no se pueden eliminar, aunque sí se pueden bloquear.
Preguntas
Crear, actualizar, leer y eliminar
Consejo: en la API, las preguntas se denominan "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 denominan "regiones".
Branded Apps
Leer los nombres, estados y nombres de los eventos asignados de las Branded App
Event App
Lea los conceptos básicos, la apariencia y la configuración de la aplicación web, además de información sobre grabaciones del Video Center.
Cree, actualice, lea y elimine las siguientes funciones de la Event App y sus elementos, cuando corresponda:
Agenda
Patrocinadores
Altavoces
Expositores
Transmisión en vivo
Asistentes
Lista personalizada
Objeto unico
Enlace web
Lista web
Mi código QR
💡 Tenga en cuenta que debe agregar y configurar manualmente cualquier función de la Event App que no esté mencionada anteriormente.
Consejo: en la API, las funciones se denominan "componentes".
Registro
Leer información básica, de apariencia y de configuración, incluida la configuración de pago
Cree, lea, actualice y elimine boletos, formularios, preguntas y códigos promocionales
Crear, leer y actualizar pedidos
Enviar correos electrónicos de confirmación de pedidos y entradas
Marcar pedidos de cheques o facturas como pagados
Actualizar la información del comprador del pedido
Cancelar y reembolsar billetes
Crear, leer, actualizar, eliminar, pausar y reanudar códigos promocionales
Crear, leer, actualizar y eliminar impuestos
Consejo: en la API, las preguntas se denominan "campos personalizados".
En el Onsite
Leer y actualizar la información básica y de la Onsite App
Lead Retrieval y Live Display
Leer si el producto está activo o publicado en el Evento
Cosas que saber
Ocasionalmente lanzaremos nuevas versiones de la API con mejoras y correcciones. Continuaremos admitiendo versiones antiguas el tiempo suficiente para que todos puedan realizar la transición a la nueva versión. Enviaremos actualizaciones por correo electrónico sobre nuevas versiones, próximas fechas de desuso de versiones antiguas y desuso oficiales.
Las solicitudes de API se miden y limitan para evitar abusos.
Las comunidades también son compatibles con los clientes de Suite.