Obrigado pelos seus comentários.
Comentários?Se você tem um desenvolvedor em sua equipe que sabe como usar uma API GraphQL, a API Webex Events pode ser sua porta de entrada para poderosas automações de configuração e gerenciamento de eventos e produtos, integrações de plataformas de terceiros, poderosos painéis de dados de vários eventos e muito mais.
O que a API Webex Events pode fazer
Simplificando, uma API é uma interface de programação que os desenvolvedores podem usar para obter dados ou colocá-los em uma plataforma on-line — neste caso, Webex Events.
Os recursos da API podem ser simplificados em quatro conceitos básicos:
-
Crie algo que não existia antes, como um participante, uma sessão ou um evento inteiro.
-
Atualize tudo o que a API possa ser usada para criar, além de mais algumas coisas. Por exemplo, a API pode ser usada para criar um novo participante e, em seguida, editar o nome, e-mail, status, grupos, números de telefone e contas sociais desse participante.
-
Leia informações sobre qualquer coisa que a API possa ser usada para criar ou editar, além de algumas coisas que ela não pode.
-
Exclua qualquer coisa que a API possa ser usada para criar, com algumas exceções.
Lembre-se desses conceitos ao ler a seção “Trabalhando com desenvolvedores” deste artigo.
Como começar
1. Tenha acesso à API
Se você é um cliente do Webex Suite Enterprise Agreement (Suite EA) que já tem o Webex Events ativado, você obtém acesso automaticamente à API Webex Events! Para todos os outros clientes, fale com seu contato do Webex Events ou com nossa equipe de suporte para saber como acessar a API.
2. Crie uma chave de API
Agora você precisa criar uma nova chave de API para seus desenvolvedores usarem. Quando você tem acesso à API, uma nova guia é adicionada à página “Configurações da organização” na plataforma Webex Events. Veja como acessar a nova guia e criar sua primeira chave:
Lembre-se de que somente os administradores da organização podem acessar a página da API.
-
De qualquer lugar na plataforma Webex Events, clique na sua imagem de perfil no canto superior direito da tela e selecione Configurações da organização no menu suspenso.
-
Na página de configurações da organização, clique na guia API no menu à esquerda. Isso leva você ao painel da API, onde você pode revisar o uso da API, exportar registros de uso, gerenciar chaves e acessar nossa documentação da API.
-
Clique em Criar chave.
-
No modal “Criar nova chave”, insira um rótulo para a chave da API que explica para que ela será usada.
-
O menu suspenso da versão da API já terá a versão atual selecionada, então basta clicar em Salvar. Isso revela a chave da API.
-
Clique no botão Copiar ao lado da chave e cole a chave em um documento seguro para garantir que ela nunca seja perdida.
AVISO! Essa é a única vez em que a chave de API completa pode ser acessada. Depois de fechar o modal, a chave completa não poderá ser lida novamente.
-
Depois de copiar e salvar a chave, clique no botão Fechar.
Na maioria dos casos, você só precisa de uma chave de API. No entanto, em situações em que você trabalha com várias equipes, talvez queira criar uma chave para cada equipe. Converse com seus desenvolvedores sobre seus casos de uso específicos para descobrir a melhor solução.
3. Convide desenvolvedores para acessar a API
Quando você cria sua primeira chave de API, uma nova equipe de API é criada automaticamente na plataforma Webex Events. Oferecer aos desenvolvedores acesso para experimentar a API Webex Events é tão simples quanto convidá-los para essa equipe de API. Siga as instruções em nosso artigo sobre como gerenciar equipes, membros e créditos para saber como.
Lembre-se de que o sandbox da API é uma versão separada da plataforma Webex Events feita especialmente para testes. Isso significa que todos os novos membros da equipe do API Sandbox devem criar uma nova conta na plataforma para usar o sandbox, mesmo que já tenham uma conta na plataforma ou façam login com o SSO da organização.
As pessoas da sua equipe de API não têm acesso ao resto da plataforma Webex Events da mesma forma que os organizadores. Em vez disso, os membros da equipe de API têm acesso a um “sandbox” de API onde podem testar o que estão criando sem afetar os dados do mundo real. Se você quiser que os desenvolvedores também tenham acesso a alguns ou a todos os seus eventos e aplicativos reais na plataforma Webex Events, convide-os para equipes relevantes que não são da API.
4. Seja gentil com seus desenvolvedores
Isso é crucial, então demos um passo inteiro. 😉
“Roma não foi construída em um dia”, nem foi uma boa integração de API. Seja um bom amigo para seus desenvolvedores e dê a eles bastante tempo para se familiarizarem com a API Webex Events antes de esperar que eles forneçam integrações. Eles ficarão gratos por não serem pressionados.
No mínimo, recomendamos iniciar conversas com seus desenvolvedores pelo menos seis meses antes de você precisar que as integrações funcionem. Continue lendo para saber como se preparar e ter essas conversas.
Trabalhando com desenvolvedores
Depois de convidar desenvolvedores para sua equipe do Webex Events Sandbox, uma de suas primeiras perguntas pode ser: “Quanto tempo será necessário para criar integrações?” Responder a essa pergunta depende de muitos fatores, incluindo com quantos desenvolvedores você está trabalhando, quanto tempo eles têm para trabalhar nas integrações, quão complexas são as integrações e muito mais.
Somente seus desenvolvedores podem dizer quanto tempo uma integração levará para ser configurada, e somente após algumas etapas cruciais:
-
Primeiro, leia as seções abaixo para saber o que a API pode fazer. Isso ajudará você a entender o que é possível para que você possa comunicar claramente suas necessidades aos desenvolvedores.
-
Reúna-se com seus desenvolvedores, compartilhe nossa documentação de API com eles e discuta o que você quer. Eles poderão dar feedback básico sobre o que podem ou não fazer por você. No entanto, eles não poderão fornecer cronogramas específicos até que estejam familiarizados com a API Webex Events.
-
Dê aos desenvolvedores tempo para se familiarizarem com a API. Esteja disponível para responder perguntas conceituais ou práticas sobre seus eventos, dados, a plataforma Webex Events e qualquer outra coisa.
O que a API pode fazer
A API tem duas funções básicas:
-
Ler - Obtenha dados do Webex Events para que você possa examiná-los ou colocá-los em um sistema diferente.
-
Atualização - Coloque dados no Webex Events para criar novos itens ou sincronizar dados, como participantes, de outra plataforma. Qualquer coisa que mude alguma coisa na plataforma Webex Events é uma atualização.
Equipes e organizações
-
Crie, atualize, leia e exclua equipes e membros da equipe
Eventos
-
Atualize, clone e leia. Os eventos não podem ser criados ou excluídos com a API.
Participantes
-
Crie, atualize, leia, atribua a sessões, atribua a grupos e exclua informações de contas sociais (número de telefone, identificadores de contas sociais etc.). Os participantes não podem ser excluídos, embora possam ser bloqueados.
Perguntas
-
Criar, atualizar, ler e excluir
Dica: na API, as perguntas são chamadas de “campos personalizados”
Grupos
-
Crie, atualize, leia e exclua grupos exclusivos e não exclusivos
Sessões
-
Criar, atualizar, ler e excluir
Localizações
-
Criar, atualizar, ler e excluir
Dica: na API, os locais são chamados de “regiões”.
Aplicativos de marca
-
Leia nomes de aplicativos de marca, status e nomes de eventos atribuídos
Aplicativo de eventos
-
Leia conceitos básicos, aparência e Web App configurações, além de informações sobre gravações do Video Center
-
Crie, atualize, leia e exclua os seguintes recursos do App de Eventos e seus itens, quando aplicável:
-
Agenda
-
Patrocinadores
-
Alto-falantes
-
Expositores
-
Transmissão ao vivo
-
Participantes
-
Lista personalizada
-
Item único
-
Link da Web
-
Lista da Web
-
Meu código QR
-
Lembre-se de que você deve adicionar e configurar manualmente qualquer recurso do aplicativo de eventos não listado acima.
Dica: na API, os recursos são chamados de “componentes”.
Registro
-
Leia informações básicas, aparência e configurações, incluindo configurações de checkout
-
Crie, leia, atualize e exclua ingressos, formulários, perguntas e códigos promocionais
-
Crie, leia e atualize pedidos
-
Envie e-mails de confirmação de pedidos e ingressos
-
Marcar pedidos com cheque ou fatura como pagos
-
Atualizar as informações do comprador do pedido
-
Cancelar e reembolsar ingressos
-
Crie, leia, atualize, exclua, pause e retome códigos promocionais
-
Crie, leia, atualize e exclua impostos
Dica: na API, as perguntas são chamadas de “campos personalizados”.
No local
-
Leia e atualize as informações básicas e do aplicativo no local
Recuperação de leads e exibição ao vivo
-
Leia se o produto está ativo ou publicado no Evento
Coisas para saber
-
A API não pode ser usada para criar um evento ou ativar nenhum dos produtos em um evento, como o aplicativo Event e o Onsite. Antes que os desenvolvedores possam modificar um evento com a API, você deve ativar cada produto que pretende usar e preencher as informações básicas necessárias para cada um.
-
Ocasionalmente, lançaremos novas versões da API com melhorias e correções. Continuaremos oferecendo suporte às versões antigas por tempo suficiente para que todos possam fazer a transição para a nova versão. Enviaremos atualizações por e-mail sobre novas versões, datas de descontinuação da próxima versão antiga e suspensões oficiais.
-
As solicitações de API são medidas e limitadas para evitar abusos.
-
As comunidades também são suportadas pelos clientes do Suite.
