A API é uma extensão de forma adicional no plano, ela deve ser contratada no menu Meus Serviços (clique aqui para conferir o passo a passo de como contratar)
Com a API, seu time de desenvolvimento (T.I) consegue integrar informações e automatizar os processos de sua empresa, com a API sua empresa pode:
- Extrair dados para elaborar relatórios personalizados;
- Sincronização dos dados da empresa gerados pelo sistema em painéis (dashboards) em serviços de análise de dados, como o PowerBI, por exemplo
- Integração do sistema com outros softwares para automação de tarefas como criação de cadastros, alteração de equipes, lançamento de férias, demissões, relatórios, etc.
Além disso é possível ter acesso as WebHooks que usado para enviar notificações ou eventos em tempo real.
O uso e configurações da API deve ser feito por uma pessoa que possua conhecimento técnico em API e Webhooks.
Nosso time de suporte poderá auxiliar quanto a dúvidas do sistema e da extensão, mas a configuração e uso é realizada por nosso cliente.
A principal diferença é que um webhook funciona automaticamente, enquanto a API precisa de uma solicitação para que a integração seja executada.
Além disso a webhook funciona por uma requisição HTTP do emissor para uma URL especificada pelo receptor.
Nossa API é do tipo RESTful e sua documentação está disponível no Postman (CLIQUE AQUI).
O Postman é uma plataforma abrangente que simplifica o ciclo de desenvolvimento, teste e aprimoramento de APIs
Configurações iniciais para API
Para realizar integração com a API, seu desenvolvedor precisa da chave TOKEN que dará acesso as informações da conta, siga o passo a passo abaixo para fornecer esse dado.
Passo 1: no menu à esquerda, selecione a opção Configurações.
Passo 2: na seção Extensões, clique em Configuração extensões contratadas.
Passo 3: encontre a seção de API e Webhooks e clique em Configurações.
Passo 4: Você pode optar por compartilhar:
Token Público: dá a acesso a todas as informações da conta)
Gerar token para um usuário: selecione o nome do usuário e o token compartilhado dará acesso apenas as informações que estão liberadas para esse cadastro de acordo com o filtro de Segurança dele.
Configurações iniciais do Webhook
Passo 1: no menu à esquerda, selecione a opção Configurações.
Passo 2: na seção Extensões, clique em Configuração extensões contratadas.
Passo 3: encontre a seção de API e Webhooks e clique em Configurações.
Passo 5: selecione a opção Webhooks no topo da tela e inclua a URL dos eventos que devem ser sinalizados para o nosso sistema.
Em caso de dúvidas, fale com o técnico ou desenvolvedor responsável na sua empresa.
Tem dúvidas e é gestor ou administrador do sistema? Estamos à disposição pelo chat na área logada, de segunda a sexta, das 09h às 18h.