Authorization em todas as requisições.
Para integrações server-side multiusuário, envie também X-On-Behalf-Of para identificar o usuário final.
Envie sua chave de API
Passe sua chave de API como um token bearer.https://apigw.mka1.com como a URL base.
Envie X-On-Behalf-Of para um usuário final
Use X-On-Behalf-Of quando seu servidor estiver fazendo uma requisição para um dos seus usuários finais.
Defina o valor do cabeçalho para o seu próprio identificador estável de usuário final.
user_123, use esse valor de forma consistente nas requisições feitas para esse usuário.
X-On-Behalf-Of.
Escolha o padrão correto
Use apenasAuthorization quando:
- Você está chamando a API MKA1 para um fluxo de trabalho do seu próprio backend.
- A requisição não está vinculada a um usuário final específico.
Authorization quanto X-On-Behalf-Of quando:
- Seu servidor está agindo em nome de um dos seus usuários finais.
- Você deseja que requisições, respostas, arquivos ou uso permaneçam associados a esse usuário final.
Troque uma chave de API por um JWT
UsePOST /api/v1/authentication/api-key/exchange-token quando precisar de um JWT de curta duração para um serviço downstream.
Envie sua chave de API MKA1 em Authorization.
Depois, envie um corpo JSON com:
audience: A URL do serviço que deve aceitar o token.externalUserId: Seu ID de usuário final para o subject do JWT.expiresIn: Tempo de vida opcional do token, em segundos. O OpenAPI permite de 300 a 2592000.
token.
Use um JWT para requisições subsequentes
Depois de obter um JWT do endpoint de troca, use-o como token bearer no lugar da sua chave de API. Isso permite emitir credenciais de curta duração para serviços downstream ou usuários finais sem expor sua chave de API.Próximos passos
- Revise a visão geral da API para a URL base e o OpenAPI spec ao vivo.
- Leia o mergulho profundo em autenticação para entender o gateway de ponta a ponta, troca de JWT e modelo de identidade downstream.
- Aprenda como controlar o acesso a recursos com Autorização.