A API usa OAuth 2.0 com PKCE para autenticação.
AvisoA autenticação básica está obsoleta e será removida em uma atualização futura. Migre para o OAuth 2.0.
client_idA maioria das bibliotecas cliente de OAuth 2.0 cuida desse fluxo automaticamente quando você as configura com o endpoint de metadados do servidor /.well-known/oauth-authorization-server.
Todos os endpoints abaixo são relativos a https://api.attendium.com.
Crie um aplicativo OAuth no Attendium para obter seu client_id e, se for um aplicativo confidencial, seu client_secret. Você só precisa fazer isso uma vez por aplicativo. Consulte Aplicativos OAuth.
Os URIs de redirecionamento devem usar https, ou http com um endereço de loopback (localhost, 127.0.0.1 ou ::1) para desenvolvimento local. Um aplicativo público também pode usar um esquema de URI de uso privado em notação de domínio invertido, como com.example.app:/oauth/callback.
Ao criar um aplicativo OAuth — no Attendium ou por meio do registro dinâmico de clientes — você aceita os Termos para desenvolvedores na versão publicada naquele momento.
Cada autorização vale para um único recurso. Defina o parâmetro OAuth resource como:
https://api.attendium.com para a API. Esse é o valor padrão quando você omite resource da requisição de autorizaçãohttps://api.attendium.com/mcp para o servidor MCP (consulte Configurar MCP)Inclua o mesmo valor de resource na requisição de autorização e nas requisições de token. Se você o omitir na troca do código ou em uma renovação, o recurso continua sendo o autorizado originalmente. Recursos desconhecidos ou repetidos, ou uma tentativa de alterar o recurso, retornam invalid_target. Para acessar os dois recursos, autorize cada um separadamente.
Em um token de acesso, aud identifica o recurso do token e client_id identifica seu aplicativo OAuth. Um token da API não pode ser usado para MCP, e um token do MCP não pode ser usado para requisições à API.
Gere um verificador de código e um desafio de código PKCE:
A-Z, a-z, 0-9, -, ., _, ~) — esse é o seu code_verifiercode_challengeEm seguida, redirecione o usuário para:
GET /oauth2/authorize?response_type=code
&client_id=your-client-id
&redirect_uri=https://yourapp.example.com/callback
&code_challenge=your-code-challenge
&code_challenge_method=S256
&state=random-state-value
O usuário entra no Attendium e é redirecionado de volta para o seu redirect_uri com um code de autorização e o seu valor de state.
POST /oauth2/token
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
&client_id=your-client-id
&redirect_uri=https://yourapp.example.com/callback
&code=the-authorization-code
&code_verifier=your-code-verifier
Um aplicativo confidencial também precisa se autenticar, seja com autenticação básica (client_secret_basic), seja enviando o client_secret no corpo da requisição (client_secret_post):
POST /oauth2/token
Authorization: Basic base64(your-client-id:your-client-secret)
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
&redirect_uri=https://yourapp.example.com/callback
&code=the-authorization-code
&code_verifier=your-code-verifier
A resposta inclui um access_token e um refresh_token.
Inclua o token de acesso no cabeçalho Authorization:
curl -H "Authorization: Bearer your-access-token" \
-H "Content-Type: application/json" \
-d '{"query": "{ me { id } }"}' \
https://api.attendium.com/graphql
A resposta do token inclui um campo expires_in, que indica por quanto tempo o token de acesso é válido. Use o token de atualização para obter um novo token de acesso antes que ele expire:
POST /oauth2/token
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token
&client_id=your-client-id
&refresh_token=your-refresh-token
Os tokens de atualização são rotacionados após cada renovação bem-sucedida. Armazene o refresh_token retornado antes de fazer outra requisição de renovação; o token anterior deixa de ser válido. Coordene as renovações para que as requisições da mesma autorização sejam executadas uma de cada vez.
Um aplicativo confidencial autentica essa requisição da mesma forma que na troca do código de autorização.
Os aplicativos que se configuram a partir dos metadados do servidor — incluindo assistentes de IA que se conectam via MCP (consulte Configurar MCP) — se registram enviando uma requisição POST para /oauth2/register. Você não precisa disso se criar seu aplicativo OAuth no Attendium.
POST /oauth2/register
Content-Type: application/json
{
"redirect_uris": ["https://yourapp.example.com/callback"],
"client_name": "Meu aplicativo"
}
Um aplicativo registrado dessa forma não aparece em “Aplicativos OAuth”, então o nome, os URIs de redirecionamento e o segredo do cliente dele não podem ser alterados lá.