Configure a autenticação necessária para testar a API do Knowledge Base ou conectar um aplicativo a ela.
As solicitações da API da Knowledge Base usam autenticação por token bearer. Use um token de usuário autenticado para testes de curto prazo ou configure uma conta técnica para um aplicativo ou integração.
Antes de começar
Certifique-se de que:
- Sua organização tem acesso ao Knowledge Base.
- Você tem acesso aos recursos de API necessários para o seu fluxo de trabalho.
- Você pode acessar o Adobe Developer Console se estiver configurando uma integração de aplicativo.
O acesso à API não substitui as permissões do Knowledge Base. A identidade autenticada deve ter acesso às coleções, documentos e operações solicitados pelo aplicativo.
Escolher um método de autenticação
Use o método de autenticação que corresponda ao estágio de desenvolvimento.
| Caso de uso | Autenticação |
|---|---|
| Testar solicitações ou explorar a API | Token bearer de usuário autenticado |
| Criar um aplicativo ou integração | Conta técnica |
Token bearer de usuário
Um token bearer de usuário autenticado é útil para testar solicitações de API, incluindo solicitações feitas pela referência de API.
O token representa o usuário conectado e é válido por 24 horas. As solicitações feitas com o token têm o mesmo acesso ao Knowledge Base disponível para esse usuário.
Após obter um token bearer de usuário, inclua-o em cada solicitação:
Authorization: Bearer <access-token>
Você também pode usar o token com a referência interativa da API do Knowledge Base para testar endpoints disponíveis.
Comece com uma operação que recupere um recurso ao qual você já tenha acesso. Uma resposta bem-sucedida confirma que o token é aceito e que a identidade autenticada pode acessar esse recurso.
Não crie uma integração de aplicativo persistente baseada em um token bearer de usuário.
Conta técnica
Use uma conta técnica para aplicativos e integrações que precisem autenticar sem uma sessão de usuário interativa.
As contas técnicas são configuradas por meio do Adobe Developer Console. Siga o processo de configuração de conta técnica para criar as credenciais necessárias para seu aplicativo.
Depois de criar a conta técnica, volte a esta página para validar seu acesso à API do Knowledge Base.
Entender as permissões de API
A autenticação estabelece a identidade que faz a solicitação de API. A autorização determina o que essa identidade pode fazer.
Por exemplo, uma identidade autenticada pode conseguir recuperar uma coleção, mas não outra, ou pode não ter acesso a um recurso de nível de administrador.
Se a autenticação for bem-sucedida, mas uma operação for rejeitada, verifique se a identidade autenticada tem permissão para acessar o recurso solicitado antes de tratar a resposta como uma falha de autenticação.
Validar seu acesso à API
Depois que a autenticação for configurada:
- Obtenha um token de acesso.
- Envie uma solicitação para um recurso que a identidade autenticada possa acessar.
- Confirme se a API retorna a resposta esperada.
- Continue com o fluxo de trabalho de primeiros passos da API.
