Para ter acesso à lista de API's disponíveis, clique no botão “Lista de API’s” ou acesse o link:
As API's estão agrupadas por módulos, como segue:
Se acessarmos, por exemplo, a API de Clientes, será possível, consultar todos os métodos e a documentação dos campos disponíveis
📌 Boa parte das APIs dispõe de um método para listar os registros cadastrados |
Para começar, podemos testar o método ListarClientes, clicando no índice como segue:
Na própria documentação, você encontra uma forma de testar a API sem que haja necessidade de realizar nenhuma implementação
Basta clicar no botão “Teste agora mesmo”:
Ao clicar no botão “Teste agora mesmo” a ferramenta de teste é exibida e já está pronta para que você experimente
Basta clicar no botão “Executar”
Nesse momento, você não precisa se preocupar com o APP_KEY e o APP_SECRET que já estão informados na tela. Eles se referem a um aplicativo de testes da Omie e você pode utilizar para consultar e verificar os resultados da requisição
Se preferir, você pode substituir essas informações pela APP_KEY e APP_SECRET do aplicativo que você acabou de criar: |
Você também irá notar que pode trocar o método da requisição alterando o valor do campo OMIE_CALL. Caso você altere o método é importante verificar também o conteúdo da requisição, que varia de acordo com a requisição!
O resultado da requisição será algo semelhante ao que podemos observar abaixo:
Caso você tenha alguma dúvida sobre a API ou se o teste que você está realizando não está retornando o que você esperada, você pode compartilhar a requisição para nos enviar. Para isso, cliente em “Compartilhar esse exemplo”:
 Ao clicar, você verá o link do compartilhamento desse exemplo:
 Nos encaminhe esse link que teremos acesso ao mesmo teste que você está realizando (ajuda@omie.com.br) |
Observe também que 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 (nPagina) e a quantidade de registros por página (nRegPorPagina):
O resultado sempre indicará qual foi a página resgatada (nPagina), o total de páginas disponíveis (nTotPaginas), o número de registros retornados (nRegistros) e o total de registros encontrados na pesquisa (nTotRegistros)
Para você testar a documentação com exemplos práticos do dia a dia, separamos alguns para te ajudar:
📌 Separamos também alguns artigos que podem te ajudar bastante:
