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.

Aqui, vamos te mostrar o passo a passo para cadastrar os seus Clientes e Fornecedores através das nossas APIs.

Preparado para simplificar sua gestão e otimizar seu tempo? Então, vamos lá! 🚀

Informações Importantes sobre as APIs Omie

Antes de iniciar seus testes com a nossa API, é fundamental conhecer alguns processos básicos:

✅ Acessando a documentação: Consulte nossa documentação oficial para entender os endpoints disponíveis e seus respectivos parâmetros.

🔑 Chaves de Integração da API: Saiba como obter e utilizar suas credenciais de acesso para autenticar as requisições.

⚙️ Características e Recomendações: Fique por dentro das melhores práticas para otimizar sua experiência com a API da Omie
🔐 Login no Portal: Para testar suas requisições no Portal do Desenvolvedor é necessário fazer login na plataforma com o mesmo e-mail e senha que você já usa no ERP. Fácil, né? 😉
🧪 Aplicativo Teste: Aprenda a criar um Aplicativo Teste gratuito e descubra, na prática, como utilizar nossas APIs e aproveitar ao máximo os nosso recursos.

💡 Dica Omie: Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor. Além disso, ferramentas como Postman, Insomnia e ThunderClient (extensão do VS Code) também são ótimas opções para realizar testes.

Cadastrando um Cliente ou Fornecedor via API

1) No Portal do Desenvolvedor, acesse a lista de APIs:

2) No tópico "Geral", selecione a opção Clientes, Fornecedores, Transportadoras, etc":

3) Para cadastrar Clientes ou Fornecedores, é preciso utilizar o método IncluirCliente:

4) Após selecionar o método IncluirCliente, você poderá consultar todos os parâmetros disponíveis (1).

Para realizar um teste rápido com os parâmetros básicos, basta clicar em "Teste agora mesmo" (2).

💡 Entendendo os parâmetros

Por aqui, você encontrará uma lista dos parâmetros disponíveis para sua requisição, incluindo:

Nome – Identifica a variável dentro da API.
Tipo de dado – Indica o formato esperado (integer, string, decimal, etc.)
Descrição – Explica a finalidade do parâmetro e como utilizá-lo.

Para obter mais detalhes sobre um parâmetro específico, basta passar o mouse sobre o ícone ➕, e uma explicação detalhada será exibida.

5) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:

6) Após realizar o login, você será direcionado para a tela de testes do Developer, onde poderá configurar e enviar requisições para a API. Veja como cada campo funciona:

(1) Endpoint:O Omie preencherá automaticamente este campo com:

🔗 https://app.omie.com.br/api/v1/geral/clientes/
(2) Aplicativo ou Chave de Acesso: Aqui, você verá uma lista dos aplicativos aos quais seu e-mail tem acesso. Basta selecionar o desejado, e os campos App Key e App Secret serão preenchidos automaticamente.
Caso precise testar um aplicativo que não aparece na lista, selecione "O aplicativo que eu quero não está na lista" e insira manualmente suas credenciais.
(3) Call: O Omie definirá automaticamente o tipo de chamada como IncluirCliente.
(4) Conteúdo – Este é o campo onde você configurará sua requisição, inserindo os dados necessários para cadastrar um Cliente ou Fornecedor.

7) A seguir, demonstramos um exemplo de requisição para cadastro de Clientes ou Fornecedores com dados mínimos:

{    
    "codigo_cliente_integracao": "CodigoAPI/XXXX1",
    "email": "ajuda@omie.com.br",
    "razao_social": "Omiexperience",
    "nome_fantasia": "Omie",
    "cnpj_cpf": "18.511.742/0001-47",
    "telefone1_ddd": "011",
    "telefone1_numero": "0800 942 7592",
    "endereco": "Avenida Jurubatuba",
    "endereco_numero": "460",
    "bairro": "Vila Cordeiro",
    "cidade": "São Paulo (SP)",
    "estado": "SP",
    "tags": {
        "tag": "Cliente"
    }
}

📣 Importante

A cidade pode ser informada pelo código obtido pelo método PesquisarCidades.
É possível diferenciar um cliente de um fornecedor através de tags.

8) Ao executar a requisição com todos os parâmetros corretamente informados, você receberá uma resposta positiva contendo o código do Cliente ou Fornecedor cadastrado.

Esse identificador, retornado na tag “codigo_cliente_omie”, é fundamental, pois serve como referência para consultas e para a realização de operações via API.

9) No Omie ERP, o Cliente ou Fornecedor estará cadastrado:

Informações Importantes sobre as APIs Omie

Cadastrando um Cliente ou Fornecedor via API

💡 Entendendo os parâmetros

📣 Importante

📚 Artigos Relacionados