Na maioria das páginas de documentação, um APIs Explorer condensado fica visível no lado direito da tela. Se o APIs Explorer não estiver visível, clique em Teste agora! para mostrar a versão condensada.
Se a opção Teste agora! não aparecer no lado direito de uma página de documentação de referência, o método não será compatível com o API Explorer. Por exemplo, o APIs Explorer não é compatível com APIs que exigem contas de serviço. Por isso, ele não aparece nas páginas de documentação dessas APIs.
Mostrar a versão expandida do APIs Explorer
A versão expandida do APIs Explorer contém cURL, HTTP e possivelmente outras amostras de código. Para mostrar a versão expandida do APIs Explorer, clique em Tela cheia .
Executar um método
Com o APIs Explorer, é possível inserir parâmetros obrigatórios e opcionais e, se aplicável, um corpo de solicitação para métodos de API. Para muitos métodos REST, como os de lista, basta preencher um ou dois campos antes de executar o método. Por exemplo, o método
books.volumes.list
da API Books só exige um parâmetro de consulta (q) para listar livros. Para testar o método
books.volumes.list:
- Acesse
books.volumes.list. - Se o APIs Explorer não aparecer, clique em Testar.
- No campo
q, digite Jogos Vorazes (sem aspas ou caracteres especiais). - Role a tela para baixo e clique em Executar.
- (opcional) Uma tela de login do Google pede que você selecione uma Conta do Google.
- (Opcional) Uma caixa de diálogo de autorização do Google pergunta se você concorda em "Gerenciar seus livros". Clique em Permitir. Os resultados aparecem abaixo do botão "Executar".
Se o APIs Explorer mostrar um resultado de 200, o método foi bem-sucedido.
Resolver problemas do APIs Explorer
Você recebeu um erro 401 ou 403
Se você estiver recebendo um erro 401 ou 403 ao executar um método usando o APIs Explorer, provavelmente isso se deve a um problema com um dos seguintes itens:
- Você está usando o tipo de autorização errado (chave de API em vez de OAuth 2.0). Tente mudar o tipo de autorização.
- Você está usando o OAuth 2.0, mas com um escopo muito limitado. Tente usar um escopo mais amplo.
A caixa de diálogo de autorização não aparece
O APIs Explorer usa um pop-up para conceder acesso aos seus dados particulares. Se o navegador bloquear pop-ups, essa janela não vai aparecer e você não poderá conceder acesso.
Se você clicar em Permitir na caixa de diálogo de autorização e nada acontecer, tente mudar as configurações de pop-up do navegador para ativar os pop-ups.