As APIs do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades.
Descubra como incluir Departamentos através da API! 🚀
Tópicos do Artigo:
Informações importantes
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 nossos 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.
Incluindo um Departamento via API
1) Após acessar a Listagem de APIs do Developer Omie, navegue pela página e dê um duplo clique sobre o serviço "Departamentos", para acessar a documentação e listagem de métodos disponíveis para ele:
2) Para cadastrar o novo Departamento, utilize o método "IncluirDepartamento":
3) Após selecionar o método desejado no índice do canto direito (1), assim você será levado a parte da página com informações sobre o mesmo, contendo dados de parâmetros e requisição exemplo (2).
Para realizar um teste rápido com os parâmetros básicos, basta clicar em "Teste agora mesmo" (3):
💡 Entendendo os parâmetros
💡 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.
4) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie.
5) 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/departamentos/(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 IncluirDepartamento.
(4) Conteúdo: Este é o campo onde você configurará sua requisição, inserindo os dados necessários para cadastrar um Departamento.
6) A seguir, demonstramos dois exemplos de requisição e resultados para o cadastro de Departamentos, sendo um para criação de Departamento-pai (1) e outro para criação de Departamento-filho (2). Na imagem abaixo, veja a diferença visual de um Departamento-pai e Departamento-filho, bem como a indicação de seu Departamento principal (Sua Empresa):
ℹ Para expandir a informação, basta clicar na seta em cima da descrição do campo de interesse.
(1) Departamento-pai (Novo Departamento)
(1) Departamento-pai (Novo Departamento)
1) O novo Departamento deve ser incluído dentro do Departamento principal.
Sendo assim, o primeiro passo para a inclusão é realizar a listagem de seus Departamentos, para obter o código dele:
2) Com o código do Departamento principal em mãos, você pode prosseguir com a requisição pelo método "IncluirDepartamento". Preencha o código do Departamento principal na Tag "codigo" e o nome do novo Departamento-pai na "descricao", como no exemplo:
{
"descricao": "Departamento-Pai",
"codigo": "9707148"
}
3) Após enviar a requisição, o resultado será demonstrado em tela, no canto direito.
Caso todos os parâmetros tenham sido corretamente informados, você receberá uma resposta positiva sobre a inclusão.
(1) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos.
(2) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso.
(3) Corpo: é nessa parte que será exibido o retorno da requisição enviada.
4) Com o cadastro realizada, você poderá visualizar o Departamento em seu aplicativo:
(2) Departamento-filho (Subdivisão)
(2) Departamento-filho (Subdivisão)
1) A nova subdivisão será criada dentro de um Departamento-pai.
Sendo assim, o primeiro passo para a inclusão é realizar a listagem de seus Departamentos, para obter o código do Departamento-pai desejado:
2) Com o código do Departamento-pai em mãos, você pode prosseguir com a requisição pelo método "IncluirDepartamento". Preencha o código do Departamento-pai na Tag "codigo" e o nome do novo Departamento-filho na "descricao", como no exemplo:
{
"descricao": "Departamento-filho",
"codigo": "000000013561109"
}
3) Após enviar a requisição, o resultado será demonstrado em tela, no canto direito.
Caso todos os parâmetros tenham sido corretamente informados, você receberá uma resposta positiva sobre a inclusão.
(1) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos.
(2) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso.
(3) Corpo: é nessa parte que será exibido o retorno da requisição enviada.
4) Com o cadastro realizada, você poderá visualizar o Departamento em seu aplicativo:
📚 Artigos Relacionados
