Настройте аутентификацию, необходимую для тестирования API Knowledge Base или подключения к нему приложения.
В запросах к API Knowledge Base используется аутентификация с помощью токена носителя. Используйте токен аутентифицированного пользователя для кратковременного тестирования или настройте техническую учетную запись для приложения или интеграции.
Перед началом работы
Убедитесь, что:
- У вашей организации есть доступ к Knowledge Base.
- У вас есть доступ к ресурсам API, необходимым для вашего рабочего процесса.
- Вы можете получить доступ к Adobe Developer Console, если настраиваете интеграцию приложения.
Доступ к API не переопределяет разрешения Knowledge Base. Учетная запись, от имени которой выполняется аутентификация, должна иметь доступ к коллекциям, документам и операциям, запрашиваемым приложением.
Выбор метода аутентификации
Используйте метод аутентификации, соответствующий этапу разработки.
| Пример использования | Аутентификация |
|---|---|
| Тестирование запросов или изучение API | Bearer-токен аутентифицированного пользователя |
| Создание приложения или интеграции | Техническая учетная запись |
Токен носителя
Bearer-токен аутентифицированного пользователя полезен для тестирования запросов API, включая запросы, выполняемые через справочник API.
Токен представляет вошедшего в систему пользователя и действителен в течение 24 часов. Запросы, выполняемые с использованием токена, предоставляют доступ к Knowledge Base в том же объеме, который доступен соответствующему пользователю.
После получения токена носителя, включайте его в каждый запрос:
Авторизация: носитель <access-token>
Вы также можете использовать токен совместно с интерактивным справочником по API Knowledge Base для тестирования доступных конечных точек.
Начните с операции, которая извлекает ресурс, к которому у вас уже есть доступ. Успешный ответ подтверждает, что токен принят, а аутентифицированный пользователь может получить доступ к этому ресурсу.
Не стройте постоянную интеграцию приложений на основе пользовательского токена носителя
Техническая учетная запись
Используйте техническую учетную запись для приложений и интеграций, которым необходима аутентификация без интерактивного пользовательского сеанса.
Технические учетные записи настраиваются через Adobe Developer Console. Следуйте процессу настройки технической учетной записи, чтобы создать учетные данные, необходимые для вашего приложения.
Создание технической учетной записи
После создания технической учетной записи вернитесь на эту страницу, чтобы подтвердить наличие доступа к API-интерфейсу Knowledge Base.
Понимание прав доступа в API
Аутентификация определяет личность отправителя запроса API. Авторизация определяет, какие действия эта личность может выполнять.
Например, прошедший аутентификацию субъект может получить доступ к одной коллекции, но не к другой, или может не иметь доступа к ресурсу уровня администратора.
Если аутентификация прошла успешно, но операция отклонена, убедитесь, что аутентифицированный субъект имеет разрешение на доступ к запрошенному ресурсу, прежде чем рассматривать ответ как сбой аутентификации.
Проверьте ваш доступ к API
После настройки аутентификации:
- Получите токен доступа.
- Отправьте запрос к ресурсу, к которому аутентифицированный пользователь может получить доступ.
- Убедитесь, что API возвращает ожидаемый ответ.
- Продолжите работу с API, следуя руководству по началу работы.
