O Omie disponibiliza uma série de APIs para integração, bem como uma página de testes, para envio das requisições.
Descubra abaixo como acessar a documentação e testar as APIs!
Tópicos do Artigo:
Informações importantes
Antes de iniciar seus testes com a nossa API, é fundamental conhecer alguns processos básicos:
🔑 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.
Dicas de uso
Seleção de Aplicativo: Na tela de Testes de APIs, a seleção de Aplicativos demonstra Apps ativos e vinculados ao seu usuário. Caso deseje realizar a transmissão da requisição para um Aplicativo não listado, utilize a opção "O aplicativo que eu quero não está na lista" e preencha as credenciais do Aplicativo desejado.
Dúvidas sobre API: Caso você tenha alguma dúvida sobre a API ou, caso o teste que você está realizando não retorne o resultado esperado, você pode compartilhar a requisição com o Suporte Omie. Para isso, clique em “Compartilhar esse exemplo”, deste modo será criado um link de compartilhamento, que deve ser transmitido ao Suporte:
Resultados de listagem: Para métodos voltados a listagem, a pesquisa realizada nos cadastros do Omie é paginada, ou seja: você resgata uma determinada quantidade de registros para cada solicitação.
A cada solicitação você deve informar o número da página que quer resgatar e a quantidade de registros por página. O resultado sempre indicará qual foi a página resgatada, o total de páginas disponíveis, o número de registros retornados e o total de registros encontrados na pesquisa:
Acessando a documentação e testando as APIs
1) A Documentação de APIs disponíveis é centralizada no Portal do Desenvolvedor (Developer Omie). Sendo assim, é necessário acessá-lo:
2) Na tela inicial do Developer, clique no botão "Lista das API's":
3) Será apresentada a listagem das APIs, agrupadas por módulos/serviços.
Dê um duplo clique sobre o tipo de serviço desejado por você, para acessar a documentação e listagem de métodos disponíveis para ele:
Abaixo demonstraremos o acesso à listagem de métodos de Clientes, Fornecedores, Transportadoras, etc, mas o processo poderá ser seguido por qualquer um dos módulos/serviços listados.
4) No cabeçalho da página, você terá acesso ao Endpoint da página (1), podendo configurar a URL para uso em JSON, PHP SOAP ou WSDL (2). Para facilitar a navegação dentre os métodos do serviço, localize o método desejado no índice do canto direito da tela e clique sobre ele (3):
5) Após selecionar o método desejado na listagem, você será levado a parte da página com informações sobre o mesmo, contendo dados de parâmetros e requisição exemplo.
Na própria documentação, você encontra uma forma de testar a API, a partir da opção "Teste agora mesmo":
6) Ao clicar no botão “Teste agora mesmo” a ferramenta de teste é exibida, já pronta para que você experimente o método selecionado. Antes de enviar a requisição, lembre-se de selecionar o Aplicativo a partir de onde deseja enviar a requisição (1) e, se necessário, ajustar o conteúdo da requisição conforme a sua necessidade e padrões permitidos pela documentação do método (2).
Após as parametrizações, clique em "Executar" (3):
💡 É necessário realizar o login na plataforma para utilizar a página de Testes de APIs.
7) Após enviar a requisição, o resultado será demonstrado em tela, no canto direito:
(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.
Confira uma série de exemplos práticos do dia a dia:
📚 Artigos Relacionados:
