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 Google Sheets!
O Google Sheets é 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 Postman 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.
Configurando o Google Sheets e enviando a requisição
1) Acesse o link de acesso do Google Sheets para dar início a configuração:
2) Clique na opção “Fazer login”:
3) Após o login, crie uma planilha em branco:
4) Para consumir APIs no Google Sheets, você precisará utilizar uma ferramenta “API Connector” que ficará disponível no menu “Extensões” (ou "Add-ons" na versão em inglês):
💡 Caso você não possua a ferramenta API Connector
💡 Caso você não possua a ferramenta API Connector
1) Caso você não possua essa ferramenta, para instalar acesse o menu "Extensões" (1), passe o mouse pela opção "Complementos" (2) e clique em “Instalar complementos" (3):
2) Procure por “API Connector” (1) e selecione a ferramenta (2):
3) Clique sobre a opção “Instalar”:
4) É necessário permitir a instalação, para isso clique sobre a opção “Continuar”
5) Nas próxima telas, selecione a conta Google onde o “API Connector” será instalado e prossiga:
6) Para permitir a instalação, clique sobre a opção “Continuar”:
7) Leia os termos para integração e, ao final, clique em "Confirmar":
5) Para criar uma conexão, clique sobre a opção “Create” e inicie a configuração do request definindo o o campo "Method"como “POST”
Defina também a URL da API e o "Headers":
💡 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:
6) Agora defina o body do request e observe que nesse passo você pode usar o APP_KEY e APP_SECRET do seu aplicativo:
7) Após definir o body, é necessário definir o nome da planilha (1) onde os dados serão armazenados e a partir de qual célula deseja inserir os dados. Para usar a planilha em branco que criamos, clique sobre o botão “Set current” (2):
8) Por fim, defina um nome para o request (1), salve as configurações (2) e clique sobre o botão “Run” (3):
9) Em instantes, será apresentado o resultado da requisição:
📚 Artigos Relacionados
