Documentação da API


Métodos disponíveis


{{ grupo }}

Documentação a API e-Kontroll

Aqui temos a documentação sobre nossas API's. Se você possui alguma dúvida, não hesite em nos contatar por e-mail para suporte@e-kontroll.com.br.

Nós oferecemos API's que podem ser consumidas utilizando JSON.


Para começar, você precisará ativar a API e obter a Chave de autenticação de seu escritório. Você pode obtê-la neste link: https://app.e-kontroll.com.br/eapi/ativacao

No campo “API KEY”

Será necessário informar a URL de resposta das requisições da API.



Consumo da API

Nós oferecemos API's que podem ser consumidas utilizando JSON.

Método de Consulta: POST

Endereço de Consulta: https://app.e-kontroll.com.br/api/v1/metodo/*

Envio dos parâmetros como www-form-urlencoded

* deve ser informado o nome do método.



Segmentação da API

Nossa API foi segmentada em níveis de informações, que são:

  1. Lista da Empresas do Escritório
  2. Volumetria (Informações de quantidade de dados que o cliente possui) ex: Quantidade de Funcionários, Admissões, Demissões, Notas Fiscais, Lançamentos Contábeis, Horas trabalhadas, etc.
  3. Operacional (Informações da operação do cliente) Ex: Balancete, Plano de Contas, Faturamento, Verbas e Descontos da Folha, etc.

Além desta segmentação, também foram separadas por departamento. Ex: Fiscal, Pessoal, Contabilidade, Administrativo, etc.



Métodos de Consulta

Para consulta do método 1, é necessário que o escritório autorize e crie a API_Key_Empresas para ter acesso a lista de empresas do escritório.

Para consulta dos métodos 2 e 3, é necessário a criação e ativação da API_KEY_Cliente que é individual por cliente e após sua ativação, é necessário informar qual método de consulta esta API_KEY terá acesso.



Keys da API:

“api_key” – Chave para autenticação do escritório.

“api_key_empresa” – Chave para acesso a lista dos clientes do escritório contábil.

“api_key_cliente” – Chave para acesso aos dados do cliente do escritório contábil.