Premiers pas avec l'API Apigee

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

L'API Apigee peut être utilisée pour développer et gérer de manière automatisée des API avec un ensemble d'opérations RESTful.

Vous pouvez utiliser l'API Apigee pour intégrer la gestion des proxys d'API au cycle de développement logiciel (SDLC) de votre organisation. Une utilisation courante de l'API Apigee consiste à écrire des scripts ou du code qui déploient des proxys d'API ou qui migrent les proxys d'API d'un environnement vers un autre, dans le cadre d'un processus automatisé plus important qui déploie ou migre d'autres applications.

Pour en savoir plus, consultez la page API Apigee.

Activer l'API Apigee

Assurez-vous d'avoir activé l'API Apigee. Le moyen le plus simple d'activer une API pour votre projet consiste à utiliser Google Cloud Console. Pour en savoir plus, consultez la page Étape 3 : Activer les API.

Obtenir un jeton d'accès OAuth 2.0

L'API Apigee est compatible avec OAuth 2.0 pour l'authentification des utilisateurs. OAuth 2.0 vous permet d'échanger vos identifiants Google Cloud contre un jeton d'accès, que vous pouvez ensuite utiliser pour envoyer des appels sécurisés à l'API Apigee. Une fois que vous avez obtenu un jeton, vous n'avez pas besoin d'échanger vos identifiants jusqu'à son expiration.

Obtenir un jeton à l'aide d'identifiants Google Cloud

Pour obtenir un jeton à l'aide de vos identifiants Google Cloud, procédez comme suit :

Autorisez gcloud à accéder à Cloud Platform avec vos identifiants Google :
```
gcloud auth login
```
Obtenez un jeton pour le compte actuellement actif :
```
export TOKEN=$(gcloud auth print-access-token)
```
Lorsque vous appelez une API Apigee, transmettez le jeton d'accès dans l'en-tête Authorization. Exemple :
```
curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"
```

Obtenir un jeton à l'aide d'une clé de compte de service Google Cloud

Pour obtenir un jeton à l'aide d'une clé de compte de service pour l'autorisation :

Générez une clé pour votre compte de service à l'aide de la console GCP, comme décrit dans la section Créer et gérer des clés de comptes de service.
Un fichier JSON contenant les identifiants de votre compte de service est téléchargé sur votre ordinateur.
Définissez la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin d'accès à la clé de compte de service :
```
export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json
```
Lorsque vous appelez une API Apigee, utilisez Google Cloud CLI pour ajouter un jeton d'accès à l'en-tête "Authorization". Exemple :
```
curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"
```

Définir des variables d'environnement pour les requêtes API Apigee

Les exemples d'API Apigee et de CLI gcloud fournis dans la documentation utilisent une ou plusieurs des variables d'environnement définies dans le tableau suivant.

En définissant les variables d'environnement à l'avance sur des valeurs significatives dans votre environnement, vous pouvez copier et coller les exemples de requêtes afin de les exécuter dans votre propre environnement sans les modifier, ou très peu.

Variable d'environnement	Description
`$API`	Nom du proxy de votre API
`$APIPRODUCT`	Nom du produit d'API
`$APP`	ID d'une application
`$DEVELOPER_EMAIL`	Adresse e-mail du développeur
`$ENV`	Nom de votre environnement, tel que `test` ou `prod`
`$ID`	ID de ressource
`$KEY`	Clé client.
`$NAME`	Nom de votre ressource
`$ORG`	Votre organisation Apigee
`$REV`	Numéro de révision de votre proxy d'API
`$SHAREDFLOW`	Nom de votre flux partagé
`$TYPE`	Type de ressource.

Utiliser curl

Les exemples de cette section utilisent curl pour montrer comment développer des applications à l'aide de l'API Apigee. curl est un outil de ligne de commande Open Source permettant de transférer des données avec une syntaxe d'URL, compatible avec des protocoles courants tels que HTTP et HTTPS.

Le tableau suivant récapitule les options de ligne de commande curl utilisées dans les exemples.

Option	Description
`-d '{}' --data @filename --data-binary @filename`	Définit le corps de la requête, que vous pouvez transmettre directement ou en spécifiant un nom de fichier.
`-F file=@filename --form file=@filename`	Définit les données basées sur un formulaire que vous pouvez transmettre en spécifiant un nom de fichier.
`-H --header`	Définit un en-tête de requête. Vous devez transmettre les informations suivantes dans l'en-tête de la requête : En-tête `Authorization` : jeton OAuth 2.0 pour l'authentification de l'utilisateur, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0. En-tête `Content-Type` : type de contenu du corps de la requête envoyé lors de la création ou de la mise à jour d'une ressource (POST, PATCH, PUT) à l'aide de l'API.
`-X`	Spécifie le type de requête (GET, POST, etc.).

Exemple :

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

Où $TOKEN est défini sur votre jeton d'accès OAuth 2.0, comme décrit dans la section Obtenir un jeton d'accès OAuth 2.0.