Como acesso a documentação da API?

O que são APIs?
API significa Application Programming Interface (Interface de Programação de Aplicativo), que é um intermediário de software que permite que dois aplicativos se comuniquem. Esta comunicação pode ocorrer entre linguagens de programação totalmente diferentes, de forma ágil e segura, pois criam uma espécie de portal, no qual apenas um conjunto específico de informações (definido pela empresa proprietária da integração) estará disponível e enviado. Em outras palavras, uma API é o mensageiro que entrega sua solicitação ao provedor do qual você está solicitando e, em seguida, entrega a resposta de volta para você. Um exemplo disso seria a integração entre o Facebook e o Uber. Ao se cadastrar, muitas pessoas clicam no botão Login com o Facebook, que costuma estar logado nos smartphones das pessoas. A API puxa as informações de registro do Facebook e as envia para o Uber, sendo incrivelmente conveniente para usuários que não querem perder tempo criando preenchendo outro formulário de registro.

Como acessar a API da InEvent?

Há duas maneiras de acessar a API do InEvent:

  1. Para acessar a API documentada da plataforma InEvent, clique no botão no canto direito inferior chamado API para Desenvolvedores.

  1. Ou pelo nível empresa, clicando em Integrações > Referências API (API Reference). Ao acessar a documentação a partir desta opção, ela será aberta em outra aba.

O acesso à API e sua documentação permite que qualquer sistema externo (como seu próprio site ou CRM) se conecte diretamente com a plataforma InEvent realizando atualizações com segurança e facilidade. Uma das principais vantagens de se conectar à nossa API é a grande flexibilidade que ela oferece.

Como posso executar uma solicitação à API?

Para criar integrações e trocar informações em tempo real via API, basta seguir a documentação apresentada na plataforma. Aqui está um guia passo a passo para isso:

  1. Acesse a API.

  1. Pressione Pesquisar para pesquisar as informações de que você precisa no sistema.

  1. Insira o comando info no qual deseja localizar o documento de integração.

  1. Analisar a estrutura solicitada e continuar com o seu desenvolvimento.

Chamadas de API envolvendo crédito usando recursos, como adicionar participantes e enviar e-mails, usarão créditos do saldo de sua conta. Por favor, verifique este artigo para mais informações.

Guia do Desenvolvedor InEvent

Nossa filosofia é '' Se não houver documentação REST para este módulo, ele não existe ". É por isso que, desde o início do InEvent, cada módulo foi documentado e criamos um Guia do Desenvolvedor para ajudá-lo a se integrar com nossa API.

Você também pode acessar nossos guias a partir da Referência API, clicando em Developer Guides (Guia do Desenvolvedor) no canto superior esquerdo.

Em termos práticos, o que posso fazer usando as integrações de API?

Ao integrar outros sistemas ao InEvent por meio de nossos endpoints API, você será capaz de realizar operações com base na recuperação, adição, exclusão ou substituição de informações de nosso banco de dados, capacitando-se para fazer coisas como:

  • event.person.dismiss: remove um participante do evento
  • event.person.bind: adiciona um participante ao evento
  • event.person.operate: sobrescrever um campo específico no perfil do participante
  • event.tool.edit: edita as informações do evento
  • activity.remove: remove uma atividade de seu evento
Para verificar as perguntas mais frequentes sobre nossa API, consulte este artigo.

Existem centenas de solicitações possíveis, verifique a documentação da API conforme mostrado abaixo ou entre em contato com nossa equipe de suporte para obter mais informações.

Observe que as integrações diretas com nossa API estão disponíveis exclusivamente para clientes Full Plan. No entanto, os clientes com um Advanced Plan ainda podem acessar a API por meio do Zapier. Por favor, verifique este artigo para mais informações.
Se você planeja usar uma plataforma de CRM diferente de Salesforce ou Marketo, recomendamos usar a API InEvent para realizar a integração.

Os Parceiros InEvent podem ajudá-lo com suas integrações!

Se você está procurando alguém para ajudá-lo com as integrações de API de que você precisa, confira o EventMarket, nosso mercado exclusivo com dezenas de parceiros certificados que o ajudará a garantir que tudo corra bem em seu evento.


Este artigo foi útil?