Comienza a usar la API de Apigee

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

La API de Apigee puede usarse para desarrollar y administrar API de manera programática con un conjunto de operaciones RESTful.

Puedes usar la API de Apigee para integrar la administración de proxy de API en el ciclo de vida de desarrollo de software de tu organización (SDLC). Un uso común de la API de Apigee es escribir secuencias de comandos o códigos que implementan proxies de API, o que migran proxies de API de un entorno a otro, como parte de un proceso automatizado más grande que también implementa o migra otras aplicaciones.

Para obtener más información, consulta API de Apigee.

Habilita la API de Apigee

Asegúrate de que habilitaste la API de Apigee. La forma más simple de habilitar una API para tu proyecto es usar la consola de Google Cloud. Para obtener detalles completos, consulta el Paso 3: Habilita las API.

Obtén un token de acceso de OAuth 2.0

La API de Apigee admite OAuth 2.0 para la autenticación de usuario. Con OAuth 2.0, intercambias tus credenciales de Google Cloud por un token de acceso que puedes usar para hacer llamadas seguras a la API de Apigee. Una vez que obtienes un token, no necesitas volver a intercambiar tus credenciales hasta que este venza.

Obtén un token con credenciales de Google Cloud

Para obtener un token con tus credenciales de Google Cloud, sigue estos pasos:

Autoriza a gcloud a que acceda a Cloud Platform con tus credenciales de usuario de Google:
```
gcloud auth login
```

Obtén un token para la cuenta activa actual:

export TOKEN=$(gcloud auth print-access-token)

Cuando llames a una API de Apigee, pasa el token de acceso por el encabezado Autorización. Por ejemplo:
```
curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"
```

Obtén un token con una clave de cuenta de servicio de Google Cloud

A fin de obtener un token con una clave de cuenta de servicio para la autorización, haz lo siguiente:

Genera una clave para tu cuenta de servicio con GCP Console, como se describe en Crea y administra claves de cuentas de servicio.
Se descargará en tu computadora un archivo JSON con las credenciales de tu cuenta de servicio.
Configura la variable de entorno GOOGLE_APPLICATION_CREDENTIALS en la ruta en la que se encuentra la clave de la cuenta de servicio:
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```

Cuando llames a una API de Apigee, usa Google Cloud CLI para agregar un token de acceso al encabezado de autorización. Por ejemplo:

curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"

Configura variables de entorno para las solicitudes a la API de Apigee

Los ejemplos de la API de Apigee y la CLI de gcloud que se proporcionan en toda la documentación usan una o más de las variables de entorno definidas en la siguiente tabla.

Si configuras las variables de entorno antes con valores significativos en tu entorno, puedes copiar y pegar las solicitudes de ejemplo para ejecutarlas en tu propio entorno con modificaciones mínimas con ninguna.

Variable de entorno	Descripción
`$API`	El nombre de tu proxy de API.
`$APIPRODUCT`	Nombre del producto de API.
`$APP`	ID de una app.
`$DEVELOPER_EMAIL`	Dirección de correo electrónico del desarrollador.
`$ENV`	Nombre de tu entorno, como `test` o `prod`.
`$ID`	ID de recurso.
`$KEY`	Clave del consumidor (Consumer Key)
`$NAME`	Nombre de tu recurso.
`$ORG`	Tu organización de Apigee.
`$REV`	Número de revisión del proxy de la API.
`$SHAREDFLOW`	Nombre de tu flujo compartido.
`$TYPE`	Tipo de recurso

Usa curl

En los ejemplos de esta sección, se usa curl para demostrar cómo desarrollar aplicaciones con la API de Apigee. curl es una herramienta de línea de comandos de código abierto para transferir datos con sintaxis de URL, que admite protocolos comunes como HTTP y HTTPS.

En la siguiente tabla, se resumen las opciones de la línea de comandos de curl que se usan en los ejemplos.

Opción	Descripción
`-d '{}' --data @filename --data-binary @filename`	Define el cuerpo de la solicitud, que puedes pasar directamente o mediante la especificación de un nombre de archivo.
`-F file=@filename --form file=@filename`	Define los datos basados en formularios que puedes pasar especificando un nombre de archivo.
`-H --header`	Define el encabezado de una solicitud. Debes pasar la siguiente información en el encabezado de la solicitud: Encabezado `Authorization`: token de OAuth 2.0 para la autenticación de usuario, como se describe en Obtén un token de acceso de OAuth 2.0. Encabezado `Content-Type`: tipo de contenido del cuerpo de la solicitud que se envía cuando se crea o actualiza un recurso (POST, PATCH, PUT) mediante la API.
`-X`	Especifica el tipo de solicitud (GET, POST, etc.).

Por ejemplo:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0.