Este artigo também está disponível em:
O que é API?

O API Rest é uma aplicação de integração que permite o Contele Gestor de Equipes enviar dados para qualquer sistema.

Assim, é possível realizar comandos customizados em conjunto com outro sistema ou, até mesmo, planilhas Excel.

Quais as vantagens de fazer integração via API Rest?

A utilização do API Rest permite trazer diversas funcionalidades ao sistema, aumentando assim a produtividade.

Os dados liberados para integração são os de Locais (Places) e Visitas (Tasks).

Através da nossa API REST, é possível cadastrar, editar ou deletar Visitas e Locais, de forma automática.



Pré-requisitos

O Contele Gestor de Equipes oferece os meios para fazer as integrações dos sistemas, e os pré-requisitos são:

Você vai precisar de um desenvolvedor para fazer a integração;
Possuir documentação técnica dos sistemas que deseja integrar;
As chaves de integração do Contele Gestor de Equipes;
Mínimo de 5 licenças no sistema (saiba mais);

Além da documentação técnica de integração dos dois sistemas, o seu desenvolvedor precisa entender quais são as regras de negócio dessa integração que deseja.

Por exemplo: Queremos cadastrar um novo Local no Contele quando acontecer "Tal Coisa" no sistema "X" que o cliente está utilizando.

Veja o que um desenvolvedor precisa ter para fazer uma integração com o API Rest do Contele Gestor de Equipes:

Conhecimento em integrações com API Rest.
Conhecimento na API do sistema a ser integrado com o Contele.
Conhecimento do sistema Contele Gestor de Equipes.
Conhecimento do sistema a ser integrado.
Fluxo de uso dos dois sistemas.
Regras de negócio.

O Desenvolvedor também precisará conhecer o funcionamento dos dois sistemas, bem como o fluxo de utilização e também as documentações de integração de cada sistema.

Muitos sistemas utilizam o mesmo tipo de integração que o Contele Gestor de Equipes adota. Mas, indicamos que seja verificado a documentação do outro sistema antes de integrar com o Contele Gestor de Equipes.

Documentação técnica do Contele Gestor de Equipes

Consulte a documentação técnica do Contele Gestor de Equipes no link abaixo, para saber com mais detalhes os campos disponíveis em cada recurso do sistema.

Clique aqui para verificar o Readme para integração baseada no padrão Rest.
Clique aqui para verificar a Documentação listada.

Chave de integração

Para a integração via API do Contele Gestor de Equipes com outros sistemas, é necessário duas Chaves de Integração.

Você encontra as chaves na página de integração, indo na sessão de API Rest. (Observação: é necessário usuário de perfil administrador).

Clique no botão que vai gerar as chaves de integração, e copie elas:

Authorization key: Clique no botão de "Clique aqui para gerar sua Chave Zapier".
X-API-KEY: Clique no botão de "Clique aqui para gerar sua Chave de Integração".

Quando for utilizar a Chave Authorization, acrescentar no começo o texto Bearer

Esse conteúdo resolveu sua dúvida ou te ajudou?

Vote abaixo e, se você não encontrou o que procurava, envie uma mensagem no chat ao lado.
Este artigo foi útil?
Cancelar
Obrigado!