Este artigo foi traduzido do inglês usando tradução automática.
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 ou colocar dados em uma plataforma online — 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 pode 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 tudo o que a API pode ser usada para criar ou editar, além de algumas coisas que ela não pode.
Exclua tudo o 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. Obtenha 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 do 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 API
Agora você precisa criar uma nova chave de API para seus desenvolvedores usarem. Quando você tiver acesso à API, uma nova guia será adicionada à página 'Configurações da organização' na plataforma Webex Events . Veja como acessar a nova aba e criar sua primeira chave:
💡 Lembre-se de que apenas administradores da organização podem acessar a página da API.
De qualquer lugar na plataforma Webex Events , clique na imagem do seu perfil no canto superior direito da tela e selecione Configurações da organização no menu suspenso.
Na página Configurações da organização, clique na guia API no menu esquerdo. 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 API que explique 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 em um documento seguro para garantir que ela nunca seja perdida.
⚠️ AVISO! Esta é a única vez que a chave 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 diversas equipes, talvez você 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 os desenvolvedores para acessar a API
Ao criar sua primeira chave de API, uma nova equipe de API é criada automaticamente na plataforma Webex Events . Conceder aos seus 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 gerenciamento de 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 de plataforma para usar o sandbox, mesmo que já tenham uma conta de plataforma ou façam login com o SSO da sua organização.
As pessoas da sua equipe de API não têm acesso ao restante da plataforma Webex Events como os organizadores. Em vez disso, os membros da equipe de API têm acesso a uma "sandbox" de API onde podem testar o que estão construindo sem afetar os dados do mundo real. Se você deseja que os desenvolvedores também tenham acesso a alguns ou todos os seus eventos e aplicativos reais na plataforma Webex Events , convide-os para equipes relevantes não relacionadas à API.
4. Prepare um evento
Como a API não pode ativar nenhum dos produtos de um Evento, como o Event App e o Onsite, você deverá ativar cada produto que pretende utilizar em seu Evento, preenchendo as informações básicas necessárias.
Trabalhando com desenvolvedores
É importante que você se comunique claramente com seus desenvolvedores para que eles possam construir o que você precisa. Isso significa que você precisa saber quais partes da plataforma Webex Events a API pode acessar. Continue lendo para saber exatamente o que a API pode acessar e controlar, além de algumas dicas para ajudá-lo a “falar a mesma língua” que seu desenvolvedor.
Quando estiver familiarizado com os recursos básicos, você poderá começar a conversar com seu desenvolvedor sobre a criação de ferramentas e automações com a API.
Equipes e organizações
Criar, atualizar, ler e excluir equipes e membros da equipe
Eventos
Crie, atualize, clone e leia. Os eventos não podem ser excluídos.
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.
Questões
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”.
Branded Apps
Leia nomes de Branded App , status e nomes de eventos atribuídos
Event App
Leia as configurações básicas, de aparência e do aplicativo da Web, além de informações sobre gravações do Video Center
Crie, atualize, leia e exclua os seguintes recursos do Event App e seus itens, quando aplicável:
Agenda
Patrocinadores
caixas de som
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 quaisquer recursos do Event App não listados acima.
Dica: Na API, os recursos são chamados de “componentes”.
Cadastro
Leia informações básicas, aparência e configurações, incluindo configurações de checkout
Crie, leia, atualize e exclua tickets, formulários, perguntas, códigos promocionais
Criar, ler e atualizar pedidos
Enviar e-mails de confirmação de pedidos e ingressos
Marcar pedidos de cheque ou fatura como pagos
Atualizar informações do comprador do pedido
Cancelar e reembolsar passagens
Crie, leia, atualize, exclua, pause e retome códigos promocionais
Criar, ler, atualizar e excluir impostos
Dica: Na API, as perguntas são chamadas de “campos personalizados”.
No Onsite
Ler e atualizar informações básicas e do Onsite App
Lead Retrieval e Live Display
Leia se o produto está ativo ou publicado no Evento
Coisas para saber
Ocasionalmente, lançaremos novas versões da API com melhorias e correções. Continuaremos a oferecer suporte a 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, futuras datas de descontinuação de versões antigas e descontinuações oficiais.
As solicitações de API são medidas e limitadas para evitar abusos.
As comunidades também são suportadas para clientes do Suite.