Características e Recomendações das APIs do Omie

Nossas APIs foram desenvolvidas no protocolo de comunicação SOAP e toda solicitação deve ser realizada pelo método POST.

As APIs do Omie foram desenvolvidas para oferecer flexibilidade e eficiência na integração de sistemas e automatização de processos, permitindo que você conecte suas soluções diretamente ao Omie.

ℹ Para expandir a informação, basta clicar na seta em cima da descrição do campo de interesse.

Documentação da API Omie

No nosso Portal Developer, você encontra toda a documentação das APIs do Omie, organizada por módulos e funcionalidades do sistema:

Portal do Desenvolvedor

Para o envio de requisições a partir da página de Testes de APIs, é necessário realizar o login na plataforma, com o mesmo e-mail e senha que utiliza para se conectar ao ERP.

Protocolos aceitos na API Omie

Nós oferecemos APIs que podem ser consumidas utilizando SOAP ou JSON.

SOAP

Para realizar um consumo pelo protocolo de comunicação SOAP, você precisará indicar / verificar as seguintes informações:

Content-Type: text/xml;charset=UTF-8

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsdl="http://app.omie.com.br/api/v1/geral/clientes/?WSDL" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">

<soapenv:Header>
    <app_key>999999999999</app_key>
    <app_secret>a1b2c3d4e5a1b2c3d4e5a1b2c3d4e5a1b2c3d4e5</app_secret>
  </soapenv:Header>

 <soapenv:Body>
      ... (Body da requisição em formato XML)
   </soapenv:Body>
</soapenv:Envelope>

JSON

Para realizar um consumo pelo protocolo de comunicação JSON, você precisará indicar / verificar as seguintes informações:

Content-type: application/json
{
   "app_key": "9999999999", 
   "app_secret": "a1b2c3d4e5a1b2c3d4e5a1b2c3d4e5a1b2c3d4e5",
    "call": "ListarClientes",
    "param": [
       {
          ... (Body da requisição em formato JSON)
       }
    ]
}

Rate Limit da API Omie

Explore os limites de consumo da API do Omie, abordando as regras de Rate Limit e outras diretrizes para um uso eficiente e seguro dos recursos:

Limites de Consumo da API do Omie

Demais Protocolos

RESTFUL

Atualmente, o Omie não oferece suporte ao consumo via protocolo RESTFUL.

No entanto, estamos desenvolvendo o suporte ao protocolo REST, com documentação completa em Swagger para facilitar a integração e tornar o desenvolvimento ainda mais intuitivo e acessível para você.

GET

Atualmente, o Omie não oferece suporte ao consumo via protocolo GET.

Requisições do tipo GET não são totalmente seguras, pois podem expor dados sensíveis, tornando sua aplicação vulnerável a ataques ou mesmo ao sequestro de informações.

Caso você realize uma consulta via GET, haverá o seguinte retorno:

Requisição:

https://app.omie.com.br/api/v1/servicos/os/?JSON={"call":"ListarOS","app_key":" 38333295000","app_secret":" 4cea520a0e2a2ecdc267b75d3424a0ed","param":[{"pagina":1,"registros_por_pagina":50,"apenas_importado_api":"N"}]}

Resposta:

{"status":"400","message":"Consumo indevido [GET]. Consulte nosso time de suporte através do chat disponível em nosso site."}

Solução: altere o método de consumo para POST e envie os dados no BODY da sua requisição

Correção de erros na API

CORS policy 1

Erro: Access-Control-Allow-Origin

Este erro pode acontecer quando há uma tentativa de realizar o consumo diretamente pelo navegador, o que expõe as credenciais do usuário.

A solução é criar uma API e consumi-la a partir do server.

Access to XMLHttpRequest at ‘https://app.omie.com.br/api/v1/geral/clientes/’ from origin ‘https://www.seusite.com.br’ has been blocked by CORS policy: Response to preflight request doesn’t pass access control check: No ‘Access-Control-Allow-Origin’ header is present on the requested resource

CORS policy 2

Erro: Access-Control-Allow-Origin

Este erro pode acontecer quando há uma tentativa de realizar o consumo pelo localhost, o que não é permitido.

A solução é alterar o local de origem para um IP público e tentar novamente

Access to fetch at 'https://app.omie.com.br/api/v1/geral/clientes/' from origin 'https://localhost:8082/' has been blocked by CORS policy: Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource

C#

Valores não são enviados para o Omie:

📚 Artigos Relacionados

Coleção de Artigos: APIs