Guida introduttiva all'API REST di Code Engine

È possibile utilizzare l'API IBM Cloud® Code Engine per creare e gestire le entità Code Engine.

Configurazione dell'ambiente API

Per utilizzare l'API per creare e gestire entità Code Engine, configura il tuo ambiente API.

Prima di iniziare, scarica e installa lo strumento jq, che è un processore JSON della riga di comando flessibile e leggero. Questo strumento semplifica l'utilizzo delle risposte JSON che ricevi dall'API Code Engine.

Imposta i valori per region, api_key e project_name prima di eseguire i comandi Curl di esempio nell'API. Ad esempio,
```
region=us-south
api_key=YOUR_IBM_CLOUD_API_KEY
project_name=MY_PROJECT_NAME
```
- Per rilevare la regione IBM Cloud a cui hai eseguito l'accesso, esegui il comando ibmcloud region.
- Per ulteriori informazioni sulle chiavi API IBM Cloud, consulta Gestione delle chiavi API dell'utente.
- Per ulteriori informazioni sui progetti Code Engine, vedi Gestione dei progetti.

Controlla di disporre di un token di accesso IAM ( IBM Cloud® Identity and Access Management ) valido. Per ulteriori informazioni sull'API IAM, vedi Crea un token di accesso IAM per un utente o un ID servizio utilizzando una chiave 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`

Utilizzare il token di autenticazione e le variabili definite nel passo 1 per recuperare l'ID del progetto. Nel seguente esempio, utilizza curl con jq per analizzare la risposta API Code Engine e salvare l'ID progetto in una variabile. Ad esempio,
```
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`
```

Utilizzo di una applicazione Code Engine nell'API

Ora che il tuo ambiente API Code Engine è configurato, sei pronto a lavorare con le entità Code Engine, come applicazioni o lavori. Nel seguente scenario, creiamo un'applicazione, vi accediamo ed eliminiamo l'applicazione.

Crea un'applicazione. Utilizzare le variabili precedentemente impostate e l'ID progetto per creare un URL e inviare una richiesta per la creazione dell'applicazione my-app. Ad esempio,

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" \
  }'

Per visualizzare i dettagli sull'applicazione my-app, inviare una richiesta GET. Assicurati di fare riferimento al nome dell'applicazione. Si noti che l'ultima riga di jq è facoltativa, anche se rende l'output più leggibile.
```
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 .
```

Per eliminare l'applicazione, inviare nuovamente la richiesta, ma questa volta utilizzare il metodo DELETE invece del metodo 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"

(Facoltativo) Se invii un'altra richiesta GET per richiamare le informazioni su my-app, ricevi un 404 error perché la risorsa non esiste più.

Output di esempio

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

Passi successivi

Ora che hai configurato il tuo ambiente e hai eseguito i primi passi con un'applicazione Code Engine con l'API, sei pronto a esplorare ulteriormente l'API Code Engine ?

Per ulteriori informazioni ed esempi per gli SDK Code Engine in diverse lingue, consulta la documentazione APICode Engine.

Per iniziare a utilizzare i componenti Code Engine con l'API, vedi

IBM Cloud® Code Engine è progettato in modo da non dover interagire con la tecnologia sottostante su cui si basa. Tuttavia, se disponi di strumenti esistenti basati su Kubernetes o Knative, puoi ancora utilizzarli con Code Engine. Code Engine supporta le API Knative e Kubernetes e i relativi comandi CLI. Per ulteriori informazioni, vedi Utilizzo di Kubernetes con Code Engine e Utilizzo di Knative con Code Engine.