Todas as coleções
APIs
Exemplos de API
Cadastrando um Serviço via API
Cadastrando um Serviço via API

Nesse artigo, descubra como cadastrar um serviço no Omie via API

Thais Oldani avatar
Escrito por Thais Oldani
Atualizado há mais de uma semana

Antes que você possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:

💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code)

Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para as suas credenciais 😉

  1. Para criar o serviço, temos que seguir o mínimo de requisitos obrigatórios, sendo eles:

    1. cCodIntServ: Código de Integração do Serviço (Utilizado em serviços criados via API, não é visualizado na tela);

    2. cDescricao: Descrição Resumida do serviço prestado;

    3. cCodigo: Código do Serviço;

  2. Então, vamos criar a seguinte requisição, por meio do método abaixo:

    https://app.omie.com.br/api/v1/servicos/servico/#IncluirCadastroServico

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


    Além das informações obrigatórias, você poderá adicionar informações opcionais, como a descrição completa do serviço, valor unitário, informações sobre impostos, entre outras. Você poderá conferir quais outras informações poderão ser adicionadas na requisição ao clicar aqui:

  3. Vamos, agora, executar a nossa requisição criada:

  4. Observe que ele tornou com sucesso a seguinte mensagem:

    {
      "cCodIntServ": "749308",
      "nCodServ": 5428861336,
      "cCodStatus": "0",
      "cDescStatus": "Serviço cadastrado com sucesso!"
    }

    Essa tag retornada “nCodServ” é muito importante, pois, é com ela que vamos consultar e fazer operações com nosso serviço via API

  5. E aqui está o nosso serviço no sistema, com as informações que preenchemos

    Prontinho! 😊

    📌 Separamos alguns artigos interessantes para você


    ​


    ​

Respondeu à sua pergunta?