Cómo mostrar el Explorador de API y ejecutar un método

En la mayoría de las páginas de documentación, se puede ver un Explorador de API condensado en el lado derecho de la pantalla. Si el Explorador de API no es visible, haz clic en Probar para mostrar la versión condensada del Explorador de API.

Si la opción Try it! no aparece en el lado derecho de la página de documentación de referencia, el Explorador de API no admite el método. Por ejemplo, el Explorador de API no es compatible con las API que requieren cuentas de servicio, por lo que no aparece en las páginas de documentación de esas API.

Cómo mostrar la versión expandida del Explorador de API

La versión expandida del Explorador de API contiene cURL, HTTP y, posiblemente, otras muestras de código. Para mostrar la versión expandida del Explorador de API, haz clic en el ícono de pantalla completa .

Ejecuta un método

El Explorador de API te permite ingresar parámetros obligatorios y opcionales, y, si corresponde, un cuerpo de solicitud para los métodos de API. Para muchos métodos REST, como los métodos de listas, solo debes completar uno o dos campos antes de poder ejecutar el método. Por ejemplo, el método books.volumes.list de la API de Libros solo requiere un parámetro de búsqueda (q) para enumerar libros. Para probar el método books.volumes.list, haz lo siguiente:

  1. Ve a books.volumes.list.
  2. Si no se muestra el Explorador de API, haz clic en Probar.
  3. En el campo q, escribe Juegos del Hambre (sin comillas ni caracteres especiales).
  4. Desplácese hacia abajo y haga clic en Ejecutar.
  5. (Opcional) Una pantalla de acceso de Google te pide que selecciones una Cuenta de Google.
  6. (Opcional) Un cuadro de diálogo de autorización de Google te preguntará si estás de acuerdo con administrar tus libros. Haga clic en Permitir. Los resultados aparecen debajo del botón Ejecutar.

Si en el Explorador de API se muestra un resultado de 200, significa que el método fue exitoso.

Soluciona problemas del Explorador de API

Recibiste un error 401 o 403

Si recibes un error 401 o 403 cuando ejecutas un método con el Explorador de API, es probable que se deba a un problema con uno de los siguientes problemas:

  • Estás usando un tipo de autorización incorrecto (clave de API en lugar de OAuth 2.0). Intente cambiar el tipo de autorización.
  • Estás usando OAuth 2.0, pero con un alcance demasiado limitado. Intenta usar un alcance más amplio.

No aparece el cuadro de diálogo de autorización

El Explorador de API usa una ventana emergente para otorgar acceso a tus datos privados. Si tu navegador bloquea las ventanas emergentes, no aparecerá, y no podrás otorgar acceso.

Si haces clic en Permitir en el diálogo de autorización y no sucede nada, intenta cambiar la configuración de ventana emergente de tu navegador para habilitar las ventanas emergentes.