A API da EKO foi desenvolvida para automatizar processos empresariais com leitura inteligente de documentos, extração estruturada de dados e integração direta com sistemas corporativos. Com ela, sua operação reduz digitação manual, elimina retrabalho e acelera fluxos entre documentos, cadastros e módulos operacionais.
A API da EKO centraliza integrações voltadas à leitura de documentos, estruturação de dados e envio automatizado para os sistemas da operação. O objetivo é transformar arquivos como PDF, imagem e Excel em informações prontas para processamento, reduzindo etapas manuais e aumentando a confiabilidade dos fluxos.
Atualmente, a API já atende processos relacionados a armazém, cadastros, financeiro e transporte, permitindo vinculações automáticas dentro dos respectivos módulos operacionais.
A API da EKO automatiza a leitura de documentos e integra diretamente com os sistemas operacionais, eliminando digitação manual e aumentando a eficiência dos processos.
Processa arquivos PDF, imagem ou Excel e transforma automaticamente em requisições HTTP estruturadas para integração com o WMS.
Extrai os dados da etiqueta e realiza a vinculação automática ao WMS.
Leitura automática com preenchimento direto no sistema.
Captura e estruturação dos dados automaticamente.
Extração de dados de documentos digitais.
Extração de valor, vencimento e linha digitável.
Associação automática com o sistema.
Vinculação automática ao processo correto no TMS.
Todas as integrações utilizam como base o endereço principal da API abaixo:
https://www.portal.eko.eco.br/api
Nas próximas etapas, esta página pode ser expandida com autenticação, documentação de endpoints, exemplos de request/response, webhooks, padrões de retorno e códigos de erro.
Nesta seção, você encontra a documentação detalhada dos principais métodos da API da EKO. Clique em cada item para visualizar autenticação, estrutura de envio e observações de uso.
Todos os endpoints da API exigem autenticação via token. O token deve ser obtido no endpoint /autorizathion e enviado no header de cada requisição.
Authorization: Bearer SEU_TOKEN
Content-Type: application/jsonResponsável por autenticar o cliente na API e retornar um token temporário para uso nas demais requisições.
{
"username": "seu_usuario",
"password": "sua_senha"
}{
"success": true,
"token": "SEU_TOKEN",
"expires_in": 1800
}Processa arquivos PDF, imagem ou Excel e converte os dados do pedido em uma estrutura pronta para integração com o WMS.
Authorization: Bearer SEU_TOKEN{
"modulo": "pedido",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"numero_pedido": "string",
"data_pedido": "string",
"cliente_nome": "string",
"cliente_documento": "string",
"fornecedor_nome": "string",
"fornecedor_documento": "string",
"total_pedido": "number",
"total_pedido_num": "number",
"moeda": "string",
"itens": [
{
"codigo": "string",
"descricao": "string",
"quantidade": "number",
"quantidade_num": "number",
"unidade": "string",
"valor_unitario": "number",
"valor_unitario_num": "number",
"valor_total": "number",
"valor_total_num": "number"
}
],
"company_id": "number",
"company_cnpj": "string",
"meta": {
"company_id": "number",
"company_cnpj": "string"
}
}Campos podem variar conforme o documento enviado. A lista de itens pode conter múltiplos registros.
Esta API realiza a leitura do arquivo da etiqueta e extrai o máximo de informações possíveis para que a vinculação ao pedido do seu WMS ou ERP seja feita corretamente, com mais precisão operacional e menos intervenção manual.
Authorization: Bearer SEU_TOKEN{
"modulo": "etiqueta",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"formatoRetorno": "pdf",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"Registro": "string",
"Ordem": "string",
"ReferenciaPedido": "string",
"Pedido": "string",
"Nota": "string",
"TipoEtiqueta": "string",
"NomeArquivo": "string",
"Cliente": "string",
"Etiqueta": "string (base64)"
}O campo formatoRetorno define o formato esperado para o conteúdo retornado da etiqueta. Os valores aceitos são pdf ou zpl.
A API realiza a leitura do arquivo enviado, identifica o máximo de dados possíveis e organiza o retorno para facilitar a vinculação correta da etiqueta ao pedido correspondente no seu WMS ou ERP.
Esta API realiza a leitura automática da CNH e organiza os dados extraídos em uma estrutura pronta para integração, facilitando o cadastro da pessoa no seu sistema com mais velocidade, padronização e menor intervenção manual.
Authorization: Bearer SEU_TOKEN{
"modulo": "cnh",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"Lista": {
"Pessoa": [
{
"Tipo": "number",
"Telefone": "string",
"Email": "string",
"Celular": "string",
"Observacao": "string",
"ApelidoNomeFantasia": "string",
"NomeRazaoSocial": "string",
"CPFCNPJ": "string",
"IndicadorIE": "number",
"InscricaoEstadual": "string",
"CategoriaRNTRC": "string",
"Juridica": {
"InscricaoINSS": "string",
"InscricaoEstadual": "string",
"InscricaoEstadualSubstituto": "string",
"InscricaoMunicipal": "string",
"InscricaoSUFRAMA": "string",
"Fax": "string",
"CNAE": "number",
"SituacaoPessoaJuridica": "number",
"TipoEmpresa": "number",
"PorteEmpresa": "number",
"RegimeTributarioFederal": "number"
},
"Enderecos": {
"Endereco": [
{
"Tipo": "string",
"DataAlteracao": "string",
"Motivo": "string",
"Cep": "string",
"Pais": "string",
"Estado": "string",
"Municipio": "string",
"Bairro": "string",
"Logradouro": "string",
"TipoLogradouro": "string",
"Numero": "string",
"Complemento": "string",
"Latitude": "string",
"Longitude": "string",
"SemNumero": "string"
}
]
}
}
]
},
"arquivo": {
"nome": "string",
"arquivo": "string"
}
}A API interpreta o documento enviado e estrutura os dados cadastrais da pessoa para facilitar a integração com o sistema.
Esta API realiza a leitura automática do cartão CNPJ e estrutura os dados extraídos em formato de cadastro, permitindo integrar informações empresariais e endereços no seu ERP ou sistema operacional com mais precisão.
Authorization: Bearer SEU_TOKEN{
"modulo": "cnpj",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"Lista": {
"Pessoa": [
{
"Tipo": "number",
"Telefone": "string",
"Email": "string",
"Celular": "string",
"Observacao": "string",
"ApelidoNomeFantasia": "string",
"NomeRazaoSocial": "string",
"CPFCNPJ": "string",
"IndicadorIE": "number",
"InscricaoEstadual": "string",
"CategoriaRNTRC": "string",
"Juridica": {
"InscricaoINSS": "string",
"InscricaoEstadual": "string",
"InscricaoEstadualSubstituto": "string",
"InscricaoMunicipal": "string",
"InscricaoSUFRAMA": "string",
"Fax": "string",
"CNAE": "number",
"SituacaoPessoaJuridica": "number",
"TipoEmpresa": "number",
"PorteEmpresa": "number",
"RegimeTributarioFederal": "number"
},
"Enderecos": {
"Endereco": [
{
"Tipo": "string",
"DataAlteracao": "string",
"Motivo": "string",
"Cep": "string",
"Pais": "string",
"Estado": "string",
"Municipio": "string",
"Bairro": "string",
"Logradouro": "string",
"TipoLogradouro": "string",
"Numero": "string",
"Complemento": "string",
"Latitude": "string",
"Longitude": "string",
"SemNumero": "string"
}
]
}
}
]
},
"arquivo": {
"nome": "string",
"arquivo": "string"
}
}A API lê o cartão CNPJ e retorna os principais dados empresariais, cadastrais e de endereço em estrutura pronta para integração.
Esta API realiza a leitura automática de documentos veiculares, como CRLV-e, organizando as informações em uma estrutura pronta para cadastro do veículo no sistema, com dados técnicos, documentais e do proprietário.
Authorization: Bearer SEU_TOKEN{
"modulo": "veiculo",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"tipo_documento": "string",
"veiculo": {
"placa": "string",
"renavam": "string",
"chassi": "string",
"uf": "string",
"municipio": "string",
"marca_modelo": "string",
"ano_modelo": "number",
"ano_fabricacao": "number",
"cor": "string",
"combustivel": "string",
"categoria": "string",
"especie_tipo": "string",
"numero_crv": "string",
"codigoCLA": "string",
"proprietario_nome": "string",
"proprietario_documento": "string",
"data_emissao": "string",
"observacoes": "string",
"marca": "string",
"modelo": "string",
"tipoacoplamento": "string",
"tiporodado": "string",
"tipotracao": "string",
"eixo": "number",
"capacidade": "number",
"pesobruto": "number"
},
"origem": "string",
"arquivo": {
"nome": "string",
"base64": "string"
},
"processado_em": "string"
}A API interpreta o documento veicular enviado e devolve os principais dados estruturados para cadastro e integração no sistema.
Extrai automaticamente dados financeiros como valor, vencimento e linha digitável.
{
"modulo": "boleto",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"Fornecedor": "string",
"CNPJCPF": "string",
"ValorTotal": "number",
"DataVencimento": "string",
"Documento": "string",
"Parcela": "string",
"Banco": "string",
"Historico": "string",
"qrcode": "string",
"codigoBarras": "string",
"linhadigitavel": "string",
"arquivoBase64": "string (base64)"
}A API realiza a leitura completa do boleto e pode ser utilizada para automação financeira. É possível também realizar a conciliação automática com títulos em aberto do cliente, porém para esta funcionalidade é necessário análise e configuração junto à equipe EKo.
Faz a associação automática entre os documentos identificados e a compensação correspondente dentro do sistema, permitindo automatizar o processo financeiro com base nos dados extraídos dos comprovantes.
Authorization: Bearer SEU_TOKEN{
"modulo": "compensacao",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"modulo": "string",
"status": "string",
"mensagem": "string",
"arquivo": {
"nome": "string",
"tipo": "string"
},
"resumo": {
"quantidade_documentos": "number",
"valor_total": "number"
},
"pagamentos": [
{
"numero_documento": "string",
"data_pagamento": "string",
"fatura_fornecedor": "string",
"numero_interno": "string",
"valor_pago": "number",
"moeda": "string"
}
],
"processado_em": "string (datetime)"
}A API realiza a leitura completa do arquivo enviado e identifica automaticamente múltiplos documentos dentro do mesmo arquivo, retornando uma lista estruturada para processamento.
A associação com a compensação depende da identificação correta de campos como número do documento, valor e data, podendo exigir padronização dos documentos enviados.
Para cenários mais avançados, como conciliação automática com títulos em aberto, regras específicas de vinculação podem ser configuradas junto à equipe EKo.
Arquivos com múltiplas páginas ou múltiplos comprovantes são suportados e processados em lote, retornando todos os registros identificados no mesmo payload.
Esta API realiza a leitura automática de RICs e comprovantes, extraindo as informações do documento e vinculando automaticamente ao processo correspondente dentro do TMS, garantindo rastreabilidade e organização documental na operação de transporte.
Authorization: Bearer SEU_TOKEN{
"modulo": "ric_comprovante",
"company_cnpj": "00000000000000",
"upload_id": "abc123",
"arquivo": {
"nome": "arquivo.pdf",
"mime": "application/pdf",
"base64": "BASE64_AQUI"
}
}{
"arquivo": "string",
"conteiner": "string",
"pedido": "string",
"tipoArquivo": "string",
"anexo": "string (base64)"
}A API interpreta o documento enviado, identifica automaticamente o processo relacionado (como pedido ou contêiner) e retorna o arquivo estruturado pronto para vinculação no sistema TMS, incluindo o anexo em base64.
O campo tipo no retorno, é a documentação se o arquivo é uma RIC ou Comprovante.