Passar para o conteúdo principal
Configurando o Excel

Nesse artigo, descubra como fazer a configuração do Excel para integrar com as API's do Omie

Janaina Soares avatar
Escrito por Janaina Soares
Atualizado há mais de 3 meses

Muitas empresas consultam os dados cadastrados de seus ERPs, para geração de relatórios à sua maneira a parte do sistema.

A Omie disponibiliza APIs abertas para que esses dados possam ser consultados de várias formas, uma delas pode ser a partir do aplicativo Excel Desktop da Microsoft. Olha que legal! 😄

Tópicos do Artigo:


Informações Importantes

  • 1) 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.

  • 2) Antes de começarmos é importante ter alguns dados já prontos para seguirmos com o processo, como App_Key e APP_Secret. Elas são as chaves de acesso do aplicativo que será consultado, e sem elas, não conseguirão seguir com a consulta por API.

Caso não saiba qual o seu APP_KEY e APP_SECRET você pode obtê-los seguindo facilmente o processo abaixo:

  • 3) 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.

    Exemplo - Call: ListarClientes

    {
    "pagina": 1,
    "registros_por_pagina": 50,
    "apenas_importado_api": "N"
    }

    Todas as nossas APIs estão disponíveis no nosso site oficial, para acessar clique no link a seguir: https://developer.omie.com.br/service-list/

  • 4) 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.

  • 5) Temos outros exemplos de query já prontas que podem utilizar na consulta de dados, ou se basear para outras consultas: Exemplos de query no Excel


Configurando o Excel

1) Primeiro passo, abra o Excel e crie uma pasta de trabalho em branco:

2) Acesse a aba "Dados" e clique em "Obter Dados", em seguida inicie o "Editor do Power Query":

3) Logo em seguida, clique na opção “Nova Fonte”, vá em "Outras Fontes", para selecionar a opção "Consulta Nula":

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”:

Ao abrir a pagina do Editor avançado mencione o código query abaixo e clique sobre o botão “Concluído”

Código da query:

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"

5) Após o processamento teremos o retorno da consulta, que seriam os dados de clientes cadastrados no ERP, como, por exemplo:

  • Nome;

  • CNPJ/CPF;

  • Endereço;

  • Código de Integração.

Após checar os dados, você pode fechar o “Editor do Power Query” mantendo as alterações e visualizar a nova planilha no Excel:

Tcharam! Os dados serão apresentados no Excel ✨

image.png


📌 Artigos Relacionados:

Integração, Chave de Acesso, Credenciais, usuário e senha API, App Key, App Secret
Respondeu à sua pergunta?