Esta página se ha traducido con Cloud Translation API.

Primeros pasos para 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 se puede usar para desarrollar y gestionar APIs de forma programática con un conjunto de operaciones RESTful.

Puedes usar la API de Apigee para integrar la gestión de proxies de API en el ciclo de vida de desarrollo de software (SDLC) de tu organización. Un uso habitual de la API de Apigee es escribir secuencias de comandos o código que implementen proxies de API o que migren proxies de API de un entorno a otro como parte de un proceso automatizado más amplio que también implemente o migre otras aplicaciones.

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

Habilitar la API de Apigee

Asegúrate de que has habilitado la API de Apigee. La forma más sencilla de habilitar una API en tu proyecto es usar la Google Cloud consola. Para obtener todos los detalles, consulta el paso 1: Habilita las APIs.

Obtener un token de acceso OAuth 2.0

La API de Apigee admite OAuth 2.0 para la autenticación de usuarios. Con OAuth 2.0, puedes intercambiar 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 obtengas un token, no tendrás que volver a intercambiar tus credenciales hasta que caduque.

Obtener un token con las credenciales de Google Cloud

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

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

Obtener un token de la cuenta activa:

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

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

Obtener un token con una clave de cuenta de servicio de Google Cloud

Para obtener un token mediante una clave de cuenta de servicio para la autorización, sigue estos pasos:

Genera una clave para tu cuenta de servicio mediante la consola, Google Cloud como se describe en el artículo Crear y gestionar claves de cuentas de servicio.
Se descargará en tu ordenador un archivo JSON que contiene las credenciales de tu cuenta de servicio.
Define la variable de entorno GOOGLE_APPLICATION_CREDENTIALS con la ruta a la ubicación de la clave de cuenta de servicio:
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```

Cuando llames a una API de Apigee, usa la CLI de Google Cloud para añadir un token de acceso al encabezado Authorization. Por ejemplo:

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

Definir variables de entorno para solicitudes a la API de Apigee

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

Si asignas valores significativos a las variables de entorno de tu entorno, podrás copiar y pegar las solicitudes de ejemplo para ejecutarlas en tu propio entorno con modificaciones mínimas o sin modificaciones.

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

Usar CURL

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

En la siguiente tabla se resumen las opciones de la línea de comandos 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 enviar directamente o especificando un nombre de archivo.
`-F file=@filename --form file=@filename`	Define los datos basados en formularios que puedes transferir especificando un nombre de archivo.
`-H --header`	Define un encabezado de solicitud. Debe proporcionar la siguiente información en el encabezado de la solicitud: Encabezado `Authorization`: token de OAuth 2.0 para la autenticación de usuarios, tal como se describe en Obtener un token de acceso OAuth 2.0. Encabezado `Content-Type`: tipo de contenido del cuerpo de la solicitud que se envía al crear o actualizar un recurso (POST, PATCH o 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"

$TOKEN se corresponde con tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0.