OpenAPITodas as operações em OpenAPI (Postman, Insomnia).

API da Omie

Tudo o que a tela do Omie faz, a sua integração também pode fazer: cadastros, vendas, notas fiscais, finanças, serviços, estoque e CRM.

542operações

Escolha seu caminho

Sem programar · ChatGPT e ClaudeConectar um assistente de IA

Pergunte e opere o Omie conversando.

login do Omie
API + webhookIntegrar o sistema da sua empresa

Loja, BI, planilha ou outro ERP lendo e gravando no Omie.

token da integração
WebhookSaber o que mudou, sem perguntar

O Omie avisa o seu servidor quando algo muda.

reentrega por até 5 dias
OpenAPI 3.0Importar no Postman ou no Insomnia

Todas as operações num arquivo OpenAPI.

download

A jornada de uma integração

  1. 1Autenticar

    Crie uma integração em Meus aplicativos e guarde o token.

    Authorization: Bearer <token da integração>
  2. 2Carregar uma vez

    Traga o que já existe pelas listagens, página a página.

    POST /api/v1/geral/clientes/
    {"call": "ListarClientes",
     "param": [{"pagina": 1}]}
  3. 3Receber as mudanças

    O webhook avisa cada mudança. Responda 2xx em até 7 s.

    POST https://seu-servidor/omie
    → 200 OK, e processe depois
  4. 4Chamar quando precisar

    Use a API para gravar e para buscar o detalhe que o evento apontou.

    POST /api/v1/geral/clientes/
    {"call": "ConsultarCliente", ...}
Não fique repetindo listagens para ver se algo mudou. Gasta a cota, chega atrasado e pode ser bloqueado (425). Use o webhook.

Antes de começar

Empresas com mensalidade precisam ter o pacote de APIs contratado; no plano gratuito ele funciona com limite de uso por dia.

Cada empresa no Omie é um aplicativo, e cada integração vale para um aplicativo.

Autenticação

01IntegraçãoMeus aplicativos · nome e grupo
02Tokenvale 24 h
03Renovarrefresh-token
04ChamadasAuthorization: Bearer
  1. Crie uma integração em Meus aplicativos: nome e grupo de acesso. Ela ganha usuário próprio, e o token e o refresh_token aparecem uma vez.
  2. Chame com Authorization: Bearer <token>.
  3. Renove antes de 24 h: POST https://app.omie.com.br/api/portal/apps/{app_hash}/refresh-token/ com {"token": …, "refresh_token": …}, sem Authorization. Aceita o token já vencido. Volta um par novo: use o novo, descarte o antigo.

Os endereços do portal terminam com barra: sem ela, o POST perde o corpo no redirecionamento.

Token e refresh_token ficam só no servidor da integração: nada de log, URL ou navegador. Revogar a integração corta a renovação na hora (403).

Assistente de IA (ChatGPT, Claude) conecta pelo MCP, com outra autenticação: como conectar. Sistema próprio no MCP, com client ID: como pedir e usar.

A primeira chamada

POST /api/v1/geral/clientes/
curl -s https://app.omie.com.br/api/v1/geral/clientes/ \
  -H "Authorization: Bearer $TOKEN_DO_APLICATIVO" \
  -H 'Content-Type: application/json' \
  -d '{"call": "ListarClientes", "param": [{"pagina": 1, "registros_por_pagina": 50, "apenas_importado_api": "N"}]}'

Resposta em JSON. Também atende SOAP 1.1 no mesmo endereço (WSDL em ?WSDL).

Erros e limites

CódigoO que quer dizer
403Sem permissão para a operação, ou aplicativo sem o pacote de APIs.
406Acesso do aplicativo bloqueado (IP, horário ou MFA).
425A mesma chamada repetida demais em pouco tempo.
429Limite de chamadas simultâneas atingido.
500Erro de negócio ou de validação de parâmetro. A mensagem diz qual.
503Omie ocupado no momento. Tente de novo em instantes, esperando mais a cada tentativa.

Os limites de chamadas estão em Limites de consumo da API do Omie.

Webhooks

O Omie faz um POST no seu servidor a cada evento (pedido incluído, produto alterado). Carga inicial pelas listagens, mudanças pelo webhook, detalhe pela API.

Tópicos, formato do aviso e reentrega

Desenvolva e teste num aplicativo de demonstração (marcado assim em Meus aplicativos). A API grava direto na empresa, sem ambiente de testes à parte. Só aponte a integração para a empresa real depois.