Cómo buscar y seleccionar APIs de Google

1. Antes de comenzar

En este codelab, se muestra cómo buscar y seleccionar APIs de Google, y ver las métricas de la API.

Requisitos previos

  • Capacidad para navegar por la consola de Google Cloud

Qué aprenderás

Requisitos

2. Accede a las APIs desde la consola de Cloud

  1. En la consola de Cloud, selecciona 5854836f11d5d97b.png Menú de navegación > APIs y servicios > APIs y servicios habilitados.

El menú de navegación en la consola de Cloud que muestra

  1. En el panel de APIs y servicios, haz clic en + HABILITAR APIS Y SERVICIOS para ver las APIs disponibles.

El panel de APIs y servicios que muestra la opción HABILITAR APIS Y SERVICIOS.

En la página APIs y servicios, hay varias formas de buscar APIs. Si conoces el nombre de la API, puedes ingresarlo en el campo Buscar APIs y servicios en la parte superior de la página. También puedes filtrar las APIs por categoría con los filtros que se encuentran al costado de la página.

Una lista de APIs que se obtienen del campo Buscar APIs y servicios

  1. En el menú CATEGORÍA, selecciona Aprendizaje automático para ver solo las APIs de aprendizaje automático.

APIs filtradas por CATEGORY para mostrar solo las APIs de aprendizaje automático.

  1. En las APIs de aprendizaje automático, selecciona API de Cloud Natural Language para ver los detalles de esta API.
  2. Haz clic en HABILITAR para habilitar esta API en el proyecto adecuado.

Panel de la API de Cloud Natural Language que muestra los botones HABILITAR y PROBAR ESTA API.

Cuando habilitas la API, se muestra la página de descripción general de la API. Puedes ver las métricas de tu uso de esta API, que tiene muy poca información porque habilitaste la API recientemente.

La página de descripción general de la API seleccionada que muestra las métricas de la API.

En un codelab futuro, obtendrás más información para crear credenciales, pero, si tienes curiosidad ahora, haz clic en CREAR CREDENCIALES y, luego, responde las preguntas que se presentan.

  1. Haz clic en ADMINISTRAR para volver a la descripción general del paso anterior.

Página de descripción general de la API de Cloud Natural Language

  1. Para probar la API (incluso antes de habilitarla), haz clic en PROBAR ESTA API.

Por lo general, esto te lleva a una página de la documentación de la API. Sin embargo, para algunas APIs, no hay una forma inmediata de probar la API porque tiene muchos métodos diferentes. Ese es el caso de la API de Cloud Natural Language.

Página de referencia de la API de Cloud Natural Language

  1. Selecciona el método analyzeEntitites.

Deberías ver una página web con detalles sobre los métodos de la API y un panel Probar esta API.

Página del método analyzeEntities que muestra los detalles del método y un panel de prueba de la API.

  1. Para probar una consulta de muestra, agrega un objeto document al campo Cuerpo de la solicitud con estos parámetros. Haz clic en los íconos \+ para expandir las opciones de campo.
  2. En el campo content:, ingresa el texto que se analizará.

En este ejemplo, se usa Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'.

  1. En el campo type:, selecciona PLAIN_TEXT.

El cuerpo de la solicitud debería verse de la siguiente manera:

Panel del cuerpo de la solicitud que muestra los parámetros del cuerpo de la solicitud.

Para obtener más información sobre cada parámetro, consulta la documentación.

  1. Desmarca la casilla de verificación Google OAuth 2.0 y, luego, haz clic en Ejecutar para obtener una respuesta con detalles sobre las entidades.

Respuesta 200 con detalles sobre las entidades.

  1. Desmarca la casilla de verificación Clave de API y, luego, haz clic en Ejecutar nuevamente.

Cuando ejecutas la consulta esta vez, obtienes un error como este porque la API requiere credenciales para ejecutarse.

Respuesta 403 para la solicitud a la que le faltan credenciales.

  1. Selecciona la casilla de verificación Google OAuth 2.0 y, luego, haz clic en Ejecutar nuevamente.

OAuth 2.0 proporciona los permisos de la API en tu cuenta y te muestra una advertencia.

Advertencia de OAuth 2.0 que indica que el Explorador de APIs de Google quiere acceder a tu Cuenta de Google.

Si permites el acceso, obtendrás la misma respuesta que con las claves de API. Si usas la API en una app y necesitas otorgar acceso a personas con conocimiento de sus credenciales, debes usar OAuth 2.0. Si es suficiente para que la app acceda a la API para el usuario, puedes usar claves de API en su lugar.

3. Visualiza las métricas de tu API con el Explorador de métricas

Puedes ver el historial de llamadas de cualquier API individual desde la página Descripción general de la API, como se muestra en el paso 6 de Accede a las APIs desde la consola de Cloud. Sin embargo, para ver más métricas de todo el uso de la API, usa el Explorador de métricas.

  1. En la sección Operaciones del f6b6844bf5688982.png Menú de navegación, haz clic en Monitoring > Explorador de métricas.

La sección Operaciones del menú de navegación muestra las opciones Monitoring y Metrics explorer seleccionadas.

  1. En el menú Tipo de recurso, selecciona API consumida como el tipo de métrica. (Si no lo ves, desmarca la casilla de verificación Solo mostrar activos).

ca850c4295ef4ec9.png

  1. En el menú Métrica, selecciona una de las métricas individuales para las APIs, como Recuento de solicitudes, para ver cuántas APIs se llamaron en el período determinado.

El Explorador de métricas muestra las métricas de APIs consumidas para el recuento de solicitudes.

  1. Para personalizar aún más el resultado, configura un agregador y ajusta el período. El Explorador de métricas muestra las métricas de APIs consumidas para el recuento de solicitudes con un agregador y un período especificados.

4. Usa OAuth 2.0 Playground para probar las APIs

También puedes usar OAuth 2.0 Playground para probar las APIs de Google. Con OAuth 2.0 Playground, puedes seleccionar una API, autorizarla y, luego, enviar solicitudes y ver las respuestas en la ventana de la consola de OAuth 2.0 Playground.

  1. Abre el OAuth 2.0 Playground.

OAuth 2.0 Playground que muestra una lista de las APIs que puedes probar.

  1. Haz clic en API de Cloud Natural Language > https://www.googleapis.com/auth/cloud-language > https://www.googleapis.com/auth/cloud-platform > Autorizar APIs.

OAuth 2.0 Playground que muestra las APIs de Cloud Natural Language seleccionadas.

  1. Si es necesario, accede a tu Cuenta de Google y, luego, haz clic en Permitir para obtener un código de autorización.
  2. Haz clic en Intercambiar código de autorización para tokens.

Panel Exchange authorization code for tokens, desde el que puedes hacer clic en Exchange authorization code for tokens.

Ahora puedes realizar una solicitud a la API.

  1. Haz clic en Enumera operaciones posibles para examinar todas las llamadas a la API posibles.

Anteriormente, abriste la página de información del documento analyzeEntities de la API de Natural Language, por lo que puedes ver que la URL de la solicitud HTTP es la siguiente:

https://language.googleapis.com/v1beta2/documents:analyzeEntities

Es una solicitud POST.

Panel Configure request to API, desde el que puedes seleccionar el método HTTP, registrar el URI de la solicitud, ingresar el cuerpo de la solicitud y enviarla.

  1. Ingresa la información del URI de la solicitud y agrega un cuerpo de la solicitud.

Puedes usar el mismo cuerpo que usaste en el Explorador de API.

Panel del cuerpo de la solicitud.

  1. Haz clic en Cerrar > Enviar la solicitud.

Deberías obtener resultados similares a los de esta imagen:

Panel de solicitud y respuesta de OAuth 2.0 después de publicar la solicitud.

No dudes en experimentar con otras APIs en OAuth 2.0 Playground.

5. Limpia

No es recomendable tener una clave de API sin restricciones para los proyectos. Si alguien obtiene acceso a ella, esa persona puede usarla sin necesidad de autenticación.

Para borrar esta clave de API, haz lo siguiente:

  1. Haz clic en f6b6844bf5688982.png Menú de navegación > APIs y servicios > Credenciales.
  2. En Claves de API, selecciona la clave que deseas borrar y, luego, haz clic en 247adf2e1d1eae4b.png.
  3. Del mismo modo, en lugar de preocuparte por que tu clave privada de cuenta de servicio no esté protegida, en Cuentas de servicio, selecciona la cuenta de servicio que deseas borrar y, luego, haz clic en 247adf2e1d1eae4b.png.

6. Felicitaciones

¡Felicitaciones! Aprendiste a buscar y seleccionar APIs de Google, y a ver sus métricas.