Premiers pas avec l'API REST d' Code Engine

Vous pouvez utiliser l'API IBM Cloud® Code Engine pour créer et gérer vos entités Code Engine.

Configuration de votre environnement d'API

Pour utiliser l'API afin de créer et de gérer des entités Code Engine, configurez votre environnement d'API.

Avant de commencer, téléchargez et installez l'outil jq, qui est un processeur JSON de ligne de commande léger et flexible. Cet outil facilite l'utilisation des réponses JSON que vous recevez de l'API Code Engine.

Définissez des valeurs pour region, api_key et project_name avant d'exécuter les exemples de commandes Curl dans l'API. Par exemple :
```
region=us-south
api_key=YOUR_IBM_CLOUD_API_KEY
project_name=MY_PROJECT_NAME
```
- Pour découvrir la région IBM Cloud à laquelle vous êtes connecté, exécutez la commande ibmcloud region.
- Pour plus d'informations sur les clés API d' IBM Cloud, consultez la section « Gestion des clés API des utilisateurs ».
- Pour plus d'informations sur les projets Code Engine, voir Gestion des projets.

Vérifiez que vous disposez d'un jeton d'accès IBM Cloud® Identity and Access Management (IAM) valide. Pour plus d'informations sur l'API IAM, consultez la section « Créer un jeton d'accès IAM pour un identifiant d'utilisateur ou de service à l'aide d'une clé d'API ».

token=`curl -X POST "https://iam.cloud.ibm.com/identity/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -H "Accept: application/json" \
  -d "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  -d "apikey=${api_key}" \
  | jq .access_token -r`

Utilisez le jeton d'authentification et les variables que vous avez définies à l'étape 1 pour extraire l'ID de votre projet. Dans l'exemple suivant, utilisez curl avec jq pour analyser la réponse de l'API Code Engine et sauvegarder l'ID de projet dans une variable. Par exemple :
```
project_id=`curl -X GET "https://api.${region}.codeengine.cloud.ibm.com/v2/projects" \
   -H "Authorization: ${token}" \
   | jq --arg project_name ${project_name} '.projects[] | select(.name == $project_name) | .id' -r`
```

Utilisation d'une application Code Engine dans l'API

Maintenant que votre environnement d'API Code Engine est configuré, vous êtes prêt à utiliser des entités Code Engine, telles que des applications ou des travaux. Dans le scénario suivant, créons une application, y accédez, puis supprimez-la.

Créez une application. Utilisez les variables précédemment définies et l'ID de projet pour construire une URL et envoyer une demande de création de l'application my-app. Par exemple :

curl -X POST "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json" \
  -d '{ \
    "name": "my-app", \
    "image_reference": "icr.io/codeengine/helloworld" \
  }'

Pour afficher les détails de l'application my-app, envoyez une demande GET. Veillez à référencer le nom de votre application. Notez que la dernière ligne de jq est facultative, bien qu'elle rende la sortie plus lisible.
```
curl -X GET "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps/my-app" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json" \
  | jq .
```

Pour supprimer l'application, envoyez à nouveau la demande, mais cette fois, utilisez la méthode DELETE au lieu de la méthode GET.

curl -X DELETE "https://api.${region}.codeengine.cloud.ibm.com/v2/projects/${project_id}/apps/my-app" \
  -H "Authorization: ${token}" \
  -H "Content-Type: application/json"

(Facultatif) Si vous envoyez une autre demande GET pour extraire des informations sur my-app, vous recevez un message 404 error car la ressource n'existe plus.

Exemple de sortie

{
  "errors": [
    {
      "code": "resource_not_found",
      "message": "Resource not found."
    }
  ],
  "trace": "codeengine-api-34dc0040429941de8c9e02f0f1200af1",
  "status_code": 404
}

Etapes suivantes

Maintenant que vous avez configuré votre environnement et effectué les premières étapes avec une application Code Engine avec l'API, êtes-vous prêt à explorer davantage l'API Code Engine ?

Pour plus d'informations et des exemples de SDK Code Engine dans plusieurs langues, voir la documentation d'APICode Engine.

Pour commencer à utiliser les composants Code Engine avec l'API, voir

IBM Cloud® Code Engine est conçu de telle sorte que vous n'ayez pas besoin d'interagir avec la technologie sous-jacente sur laquelle il s'appuie. Toutefois, si vous disposez déjà d'outils basés sur Kubernetes ou Knative, vous pouvez toujours les utiliser avec Code Engine. Code Engine prend en charge les API Knative et Kubernetes ainsi que leurs commandes CLI. Pour plus d'informations, voir Utilisation de Kubernetes avec Code Engine et Utilisation de Knative avec Code Engine.