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 Serviços 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 Serviço via API

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

2) No tópico "Serviços e NFS-e", selecione a opção "Serviços":

3) Para cadastrar Serviços, é preciso utilizar o método IncluirCadastroServico:

4) Após selecionar o método IncluirCadastroServico, 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/servicos/servico/
(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 IncluirCadastroServico.
(4) Conteúdo – Este é o campo onde você configurará sua requisição, inserindo os dados necessários para cadastrar um Serviço.

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

{
   "intIncluir":{
      "cCodIntServ":"CodigoServ/XXXX1"
   },
   "cabecalho":{
      "cDescricao":"Manutenção de Computadores",
      "cCodigo":"PC9506"
   }
}

📣 Importante

Os dados obrigatórios para o cadastro de um serviço na API são os mesmos exigidos no ERP, incluindo: Descrição do serviço e o Código do Serviço.
O parâmetro "cCodIntServ" é utilizado exclusivamente para integrações via API, por isso, ele não será demonstrado no ERP.

O parâmetro "cCodigo" será o código exibido no ERP.

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

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

 {
  "cCodIntServ": "CodigoServ/XXXX1",
  "nCodServ": 3846592864,
  "cCodStatus": "0",
  "cDescStatus": "Serviço cadastrado com sucesso!"
}

9) No Omie ERP, o Serviço estará cadastrado:

Informações Importantes sobre as APIs Omie

Cadastrando um Serviço via API

💡 Entendendo os parâmetros

📣 Importante

📚 Artigos Relacionados