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 Power BI!

O Power BI é 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 Power BI para enviar requisições para o Omie! 🚀

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 Power BI:
- Os dados de configuração e códigos passados por aqui são exemplos, pois não prestamos suporte às funcionalidades do Power BI. O tratamento dos dados obtidos deve ser feito pelo desenvolvedor responsável pela integração.

Instalando o Power BI

1) Acesse o link de Download do Power BI para dar início a instalação:

Download Power BI

2) Ao ser redirecionado ao site e escolher a opção para baixar, especifique o arquivo de instalação de 32 bits ou 64 bits a ser baixado (1) e clique em "Avançar" (2):

3) O Download será iniciado automaticamente, após baixar o arquivo do Power BI. Instale o aplicativo e siga os próximos tópicos.

Configurando o Power BI

1) Após instalar o Power BI, abra o aplicativo e crie um relatório em branco:

2) Clique sobre a opção "Transformar dados", disponível no cabeçalho:

3) Na tela de Editor do Power Query, clique na opção “Nova Fonte” (1) e selecione "Consulta Nula" (2):

4) Após criar a consulta, ela será exibida como "Consulta1". Para definir o código referente a ela, dê um clique com o botão direito na "Consulta1" (1) e use a opção "Editor Avançado" (2):

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:

https://app.omie.com.br/api/v1/geral/clientes/#ListarClientes

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 Aplicar", localizada no cabeçalho, mantendo as alterações e visualizar a nova planilha no Power BI:

💡 Confira também como realizar a paginação no Power BI.