Gerando uma chave API e um token portador para autenticação

Para trabalhar com dados e ativos em seu projeto de forma programática, você deve se autenticar para comprovar que está autorizado a acessar os recursos do watsonx.

Procedimento

Para a maioria dos métodos da API, você deve incluir um token de portador do Gerenciamento de Identidade e Acesso (IAM) como seu token de acesso com a solicitação da API. Use a chave API da sua conta na nuvem para gerar um token IAM.

Para gerar credenciais de API, execute as seguintes etapas:

  1. Crie uma chave de API:

    Na sua conta watsonx em IBM Cloud, no menu de navegação, selecione Administração > Acesso (IAM) > (redirecionar para IBM Cloud IAM) > Chaves API e, em seguida, clique em Criar +. Para obter mais informações, consulte Chave API IBM Cloud.

    Importante: por motivos de segurança, a chave API só pode ser copiada ou baixada no momento da criação. Salve a chave API para seus registros.

    Na sua conta AWS, no menu de navegação, selecione Administração > Acesso (IAM) > Chaves de acesso pessoais e clique em Criar +.

  2. Use a chave API para criar um token IAM.

    Para IBM Cloud, execute o seguinte comando:

    curl -X POST \
--url https://iam.cloud.ibm.com/identity/token \
--header "Content-Type: application/x-www-form-urlencoded" \
--data "grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=${APIKEY}"

    Para AWS, execute o seguinte comando:

    curl --request POST \
--url https://<region>.aws.data.ibm.com/api/rest/mcsp/apikeys/token \
--header 'Content-Type: application/json' \
--data '{
   "apikey": "${APIKEY}"
}'

    Para uma conta AWS no centro de dados GovCloud, execute o seguinte comando:

    curl --request POST \
--url https:///dai.ibmforusgov.com/api/rest/mcsp/apikeys/token \
--header 'Content-Type: application/json' \
--data '{
   "apikey": "${APIKEY}"
}'

    Recupere o token portador IAM do access_token campo na resposta. Você pode usar o token portador para autenticar-se na API watsonx.

    Importante: você é responsável por atualizar o token portador quando ele expirar, recriando o token.

O que fazer a seguir

Você pode invocar os pontos de extremidade da API especificando o token de portador IAM gerado no cabeçalho de autorização ao enviar uma solicitação de API REST, conforme mostrado a seguir:

curl -X POST "https://<region>.<cloud-provider-domain>/<api-endpoint>" --header "Authorization: Bearer ${TOKEN} ..."

Defina o <cloud-provider-domain> com base no endpoint da API que você invoca e o <region> para o URL de uma localização geográfica disponível da sua conta.

Para obter detalhes sobre os domínios dos provedores de nuvem e as localizações geográficas das APIs do watsonx, consulte a documentação da API. Consulte APIs e SDKs disponíveis.