O que é API?

A API Rest é uma aplicação de integração que permite ao 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.

Vantagens da Integração via API Rest

A utilização da API Rest permite trazer diversas funcionalidades ao sistema, aumentando assim a produtividade. Os dados liberados para integração são:

Locais (Places)
Visitas (Tasks)

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

Assista ao vídeo

Pré-requisitos

Para realizar a integração dos sistemas através do Contele Gestor de Equipes, os pré-requisitos são:

Você 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.
Ter um mínimo de 5 licenças no sistema.

Além disso, o seu desenvolvedor precisa compreender as regras de negócio da integração que deseja realizar. Por exemplo: cadastrar um novo Local no Contele quando determinado evento ocorrer no sistema "X" que o cliente está utilizando.

O que o Desenvolvedor Precisa?

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.

É importante que o desenvolvedor também entenda o funcionamento dos dois sistemas, bem como o fluxo de utilização e as documentações de integração de cada um.

Muitos sistemas utilizam o mesmo tipo de integração que o Contele Gestor de Equipes adota. No entanto, é recomendado verificar a documentação do outro sistema antes de realizar a integração.

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

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

Chave de Integração

Para integrar via API do Contele Gestor de Equipes com outros sistemas, são necessárias duas Chaves de Integração. Você pode encontrá-las na página de integração, na seção de API Rest. (Observação: é necessário um usuário com perfil de administrador).

Como Gerar as Chaves de Integração:

Authorization key: Clique no botão "Clique aqui para gerar sua Chave Zapier".
X-API-KEY: Clique no botão "Clique aqui para gerar sua Chave de Integração".
Webhook da documentação da API: Vá em Configurações > Sua empresa, e desça a tela até Configurações da API.

Quando for utilizar a Chave Authorization, adicione o prefixo Bearer no começo.