Como usar um token de acesso

Um token de acesso autoriza solicitações à API do Altium 365. Você o inclui em cada solicitação como um token Bearer no cabeçalho Authorization.

Os tokens de acesso podem ser obtidos de duas formas:

• Directly – ao criar um token de acesso de longa duração em Administração → Desenvolvedor

• Via exchange – ao usar um token de atualização para gerar um token de acesso de curta duração (que não será listado em Administração → Desenvolvedor)

O padrão de autorização é o mesmo, independentemente de como o token foi obtido.

Cabeçalho de autorização

Authorization: Bearer {access-token}

Exemplo: curl

curl -X POST https://{workspace-domain}/api/graphql/ \
  -H "Authorization: Bearer {access-token}" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ desProjects(first: 5) { nodes { id name } } }"}'

Expiração do token

Long-lived access tokens expiram após o período de validade configurado na criação (até 1 ano). Após a expiração, você precisará criar um novo token em Administração → Desenvolvedor.

Short-lived access tokens (obtidos por meio da troca de um token de atualização) expiram após um curto período. Quando isso acontecer, troque seu token de atualização novamente para obter um novo token de acesso – consulte Como usar um token de atualização.

Um token expirado faz com que as solicitações à API retornem 401 Unauthorized ou 200 OK com o código de erro AuthExpiredToken na resposta GraphQL.

Segurança

• Não incorpore tokens de acesso no código do lado do cliente nem os inclua em commits no controle de versão.

• Para integrações automatizadas de longa duração, prefira a abordagem com token de atualização – tokens de acesso de curta duração limitam a janela de exposição caso um token seja comprometido.

Veja também

• Como usar um token de atualização