As APIs do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades. Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor, mas também há ótimas opções para realizar testes, como o Excel!
O Excel é uma ferramenta colaborativa para desenvolvimento, envio e documentação de APIs. Ele permite enviar requisições, analisar respostas, automatizar testes e criar ambientes para simular diferentes cenários.
Descubra como utilizar o Excel para enviar requisições para o Omie! 🚀
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.
Particularidades para Excel:
Os dados de configuração e códigos passados por aqui são exemplos, pois não prestamos suporte às funcionalidades do Excel. O tratamento dos dados obtidos deve ser feito pelo desenvolvedor responsável pela integração.
O corpo inicial da query é utilizado como base em nossas consultas por API de forma padrão, apenas ajustamos os dados conforme a sintaxe do Excel. Ou seja, vocês podem utilizar qualquer uma das nossas APIs, para a consulta no Excel Desktop da Microsoft, mencionando o corpo de Exemplo que temos na documentação, e apenas ajustar a sintaxe.
O código da query já vai com instruções de expandir as colunas de forma automática, não sendo necessário o processo de expansão manual no Excel.
Configurando o Excel
1) Acesse o Excel instalado em sua máquina ou o Excel Web e crie uma pasta de trabalho em branco:
2) Acesse a aba "Dados" (1) e clique em "Obter Dados" (1), em seguida inicie o Editor do Power Query a partir da opção "Iniciar Editor do Power Query..." (3):
3) Na tela de Editor, clique na opção “Nova Fonte” (1) e vá em "Outras Fontes" (2) para selecionar a opção "Consulta Nula" (3):
4) Após criar a consulta, ela será exibida como "Consulta1". Para definir o código referente a ela, seleciona a "Consulta1" e use a opção "Editor Avançado":
5) Ao abrir a pagina do Editor Avançado, mencione o código query abaixo e clique sobre o botão "Concluído":
💡 Dica
Você pode consultar pelo nosso site Developer todas URLs/Endpoints e todas as informações para suas requisições.
Neste exemplo, vamos utilizar o método voltado a listagem de Clientes e Fornecedores:
let
body = "{
""call"":""ListarClientes"",
""app_key"":""XXXXXXXXXXX"",
""app_secret"":""XXXXXXXXXXXXXXXXXX"",
""param"":[
{
""pagina"": 1,
""registros_por_pagina"": 20,
""apenas_importado_api"": ""N""
}
]
}",
Data=Json.Document(Web.Contents(
"https://app.omie.com.br/api/v1/geral/clientes/", [
Headers=[#"Content-Type"="application/json"],
Content=Text.ToBinary(body)
])),
#"Convertido para Tabela" = Record.ToTable(Data),
#"Linhas Filtradas" = Table.SelectRows(#"Convertido para Tabela", each ([Name] = "clientes_cadastro")),
#"Colunas Removidas" = Table.RemoveColumns(#"Linhas Filtradas",{"Name"}),
#"Value Expandido" = Table.ExpandListColumn(#"Colunas Removidas", "Value"),
#"Value Expandido1" = Table.ExpandRecordColumn(#"Value Expandido", "Value", {"bairro", "bloquear_faturamento", "cep", "cidade", "cidade_ibge", "cnpj_cpf", "codigo_cliente_integracao", "codigo_cliente_omie", "codigo_pais", "complemento", "dadosBancarios", "email", "endereco", "enderecoEntrega", "endereco_numero", "estado", "exterior", "inativo", "info", "inscricao_estadual", "inscricao_municipal", "nome_fantasia", "optante_simples_nacional", "pessoa_fisica", "produtor_rural", "razao_social", "recomendacoes", "tags", "bloquear_exclusao", "telefone1_ddd", "telefone1_numero"}, {"bairro", "bloquear_faturamento", "cep", "cidade", "cidade_ibge", "cnpj_cpf", "codigo_cliente_integracao", "codigo_cliente_omie", "codigo_pais", "complemento", "dadosBancarios", "email", "endereco", "enderecoEntrega", "endereco_numero", "estado", "exterior", "inativo", "info", "inscricao_estadual", "inscricao_municipal", "nome_fantasia", "optante_simples_nacional", "pessoa_fisica", "produtor_rural", "razao_social", "recomendacoes", "tags", "bloquear_exclusao", "telefone1_ddd", "telefone1_numero"}),
#"dadosBancarios Expandido" = Table.ExpandRecordColumn(#"Value Expandido1", "dadosBancarios", {"agencia", "codigo_banco", "conta_corrente", "doc_titular", "nome_titular", "transf_padrao"}, {"agencia", "codigo_banco", "conta_corrente", "doc_titular", "nome_titular", "transf_padrao"}),
#"info Expandido" = Table.ExpandRecordColumn(#"dadosBancarios Expandido", "info", {"cImpAPI", "dAlt", "dInc", "hAlt", "hInc", "uAlt", "uInc"}, {"cImpAPI", "dAlt", "dInc", "hAlt", "hInc", "uAlt", "uInc"}),
#"recomendacoes Expandido" = Table.ExpandRecordColumn(#"info Expandido", "recomendacoes", {"codigo_transportadora", "codigo_vendedor", "email_fatura", "gerar_boletos"}, {"codigo_transportadora", "codigo_vendedor", "email_fatura", "gerar_boletos"}),
#"tags Expandido" = Table.ExpandListColumn(#"recomendacoes Expandido", "tags"),
#"tags Expandido1" = Table.ExpandRecordColumn(#"tags Expandido", "tags", {"tag"}, {"tag"})
in #"tags Expandido1"
6) Em instantes, será apresentado o resultado da requisição. Após checar os dados, você pode fechar o “Editor do Power Query”, a partir da opção "Fechar e Carregar", localizada no cabeçalho, mantendo as alterações e visualizar a nova planilha no Excel:
7) E pronto! Os dados serão apresentados no Excel ✨
📚 Artigos Relacionados:
