Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Guia completo de autenticação via OAuth2 + PKCE para as APIs Zipdin
POST /oauth/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials
client_id=SEU_CLIENT_ID
client_secret=SEU_CLIENT_SECRET
scope=api
GET /oauth/authorize?
response_type=code
&client_id=SEU_CLIENT_ID
&redirect_uri=https://seuapp.com/callback
&scope=api+profile
&code_challenge=CHALLENGE_BASE64
&code_challenge_method=S256
POST /oauth/token
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
code=CODIGO_RECEBIDO
redirect_uri=https://seuapp.com/callback
client_id=SEU_CLIENT_ID
code_verifier=VERIFIER_ORIGINAL
| Claim | Descrição |
|---|---|
sub | Identificador do usuário ou client |
iss | Issuer (servidor de autenticação Zipdin) |
exp | Timestamp de expiração (Unix) |
scope | Escopos concedidos |
tenant | Código da conveniada/parceiro |
Authorization de todas as requisições:
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
refresh_token, renove o acesso sem reautenticação:
POST /oauth/token
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token
refresh_token=SEU_REFRESH_TOKEN
client_id=SEU_CLIENT_ID
| Escopo | Descrição | Acesso |
|---|---|---|
api | Acesso geral às APIs | Leitura e escrita |
api:read | Somente leitura | Consultas |
profile | Dados do perfil do usuário | Login interativo |
admin | Operações administrativas | Restrito |
| HTTP Status | Código | Descrição |
|---|---|---|
| 401 | invalid_token | Token expirado ou inválido |
| 401 | missing_token | Header Authorization ausente |
| 403 | insufficient_scope | Token não possui escopo necessário |
| 429 | rate_limited | Muitas tentativas de autenticação |