Introdução à API REST do Code Engine

É possível usar a API do IBM Cloud® Code Engine para criar e gerenciar suas entidades do Code Engine.

Configurando um ambiente de API

Para trabalhar com a API para criar e gerenciar entidades do Code Engine, configure seu ambiente de API.

Antes de iniciar, faça o download e instale a jq ferramenta, que é um processador JSON da linha de comandos leve e flexível Essa ferramenta facilita o trabalho com respostas JSON que você recebe da API Code Engine.

Configure os valores para region, api_key e project_name antes de executar os comandos Curl de exemplo na API Por exemplo,
```
region=us-south
api_key=YOUR_IBM_CLOUD_API_KEY
project_name=MY_PROJECT_NAME
```
- Para descobrir a região do IBM Cloud na qual você efetuou login, execute o comando ibmcloud region.
- Para obter mais informações sobre as chaves de API do IBM Cloud, consulte “Gerenciamento de chaves de API do usuário ”.
- Para obter mais informações sobre projetos Code Engine, consulte Gerenciando projetos.

Verifique se você tem um token de acesso IBM Cloud® Identity and Access Management (IAM) válido. Para obter mais informações sobre a API do IAM, consulte “Criar um token de acesso do IAM para um usuário ou ID de serviço usando uma chave de 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`

Use o token de autenticação e as variáveis definidas na etapa 1 para recuperar o ID do projeto de seu projeto. No exemplo a seguir, use curl com jq para analisar a resposta da API Code Engine e salvar o ID do projeto em uma variável. Por exemplo,
```
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`
```

Trabalhando com um aplicativo Code Engine na API

Agora que seu ambiente de API do Code Engine está configurado, você está pronto para trabalhar com as entidades Code Engine, como aplicativos ou tarefas, No cenário a seguir, vamos criar um aplicativo, acessá-lo e, em seguida, excluir o aplicativo.

Crie um app. Use as variáveis configuradas anteriormente e o ID do projeto para construir uma URL e enviar uma solicitação para criar o aplicativo my-app.. Por exemplo,

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

Para exibir detalhes sobre o aplicativo my-app, envie uma solicitação de GET Certifique-se de referenciar o nome de seu app Observe que a última linha do jq é opcional, embora ela torne a saída mais legível.
```
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 .
```

Para excluir o aplicativo, envie a solicitação novamente, mas desta vez, use o método DELETE em vez do método 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"

(Opcional) Se você enviar outra solicitação GET para recuperar informações sobre o my-app, receberá um 404 error porque o recurso não existe mais.

Saída de exemplo

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

Próximas etapas

Agora que você configurou seu ambiente e realizou as primeiras etapas com um aplicativo Code Engine com a API, está pronto para explorar ainda mais a API Code Engine ?

Para obter mais informações e exemplos para SDKs do Code Engine em vários idiomas, consulte a Code Engine documentação da API.

Para começar a trabalhar com os componentes do Code Engine com a API, consulte

O IBM Cloud® Code Engine foi projetado para que não seja necessário interagir com a tecnologia subjacente em que ele foi construído. No entanto, se você já possui ferramentas baseadas no Kubernetes ou no Knative, ainda é possível utilizá-las com o Code Engine. O Code Engine oferece suporte às APIs do Knative e do Kubernetes, bem como aos respectivos comandos da CLI. Para obter mais informações, consulte Usando Kubernetes com Code Engine e Usando Knative com Code Engine.