Skonfiguruj uwierzytelnianie wymagane do testowania interfejsu API Knowledge Base lub połączenia z nim aplikacji.
Żądania interfejsu API Knowledge Base używają uwierzytelniania token bearer.Używaj tokenu uwierzytelnionego użytkownika do krótkotrwałych testów lub skonfiguruj konto techniczne dla aplikacji lub integracji.
Zanim zaczniesz
Upewnij się, że:
- Organizacja ma dostęp do Knowledge Base.
- Masz dostęp do zasobów interfejsu API wymaganych w ramach obiegu pracy.
- Możesz uzyskać dostęp do konsoli Adobe Developer Console, jeśli konfigurujesz integrację aplikacji.
Dostęp do interfejsu API nie zastępuje uprawnień Knowledge Base.Uwierzytelniona tożsamość musi mieć dostęp do kolekcji, dokumentów i operacji żądanych przez aplikację.
Wybierz metodę uwierzytelniania
Użyj metody uwierzytelniania odpowiadającej etapowi rozwoju.
| Przypadek użycia | Uwierzytelnianie |
|---|---|
| Testuj żądania lub eksploruj interfejs API | Token bearer uwierzytelnionego użytkownika |
| Buduj aplikację lub integrację | Konto techniczne |
Token bearer użytkownika
Token bearer uwierzytelnionego użytkownika jest przydatny do testowania żądań interfejsu API, w tym żądań wysyłanych przez dokumentację interfejsu API.
Token reprezentuje zalogowanego użytkownika i jest ważny przez 24 godziny.Żądania wysyłane z tokenem mają taki sam dostęp do Knowledge Base jak użytkownik.
Po uzyskaniu tokenu bearer użytkownika dołącz go do każdego żądania:
Authorization: Bearer <access-token>
Można także użyć tokenu z interaktywną dokumentacją interfejsu API Knowledge Base do testowania dostępnych punktów końcowych.
Zacznij od operacji pobierającej zasób, do którego już masz dostęp.Pomyślna odpowiedź potwierdza, że token jest akceptowany i uwierzytelniona tożsamość może uzyskać dostęp do tego zasobu.
Nie twórz integracji aplikacji z trwałym tokenem okaziciela użytkownika.
Konto techniczne
Użyj konta technicznego do aplikacji i integracji, które muszą przeprowadzić uwierzytelnianie bez interaktywnej sesji użytkownika.
Konta techniczne są konfigurowane w usłudze Adobe Developer Console.Postępuj zgodnie z procesem konfiguracji konta technicznego, aby utworzyć poświadczenia wymagane przez aplikację.
Po utworzeniu konta technicznego wróć na tę stronę, aby zweryfikować dostęp do interfejsu API Knowledge Base.
Informacje o uprawnieniach interfejsu API
Uwierzytelnianie ustala tożsamość wysyłającą żądanie interfejsu API.Autoryzacja określa, co może robić dana tożsamość.
Na przykład uwierzytelniona tożsamość może mieć możliwość pobierania jednej kolekcji, ale nie innej, lub może nie mieć dostępu do zasobu na poziomie administratora.
Jeśli uwierzytelnianie powiedzie się, ale operacja zostanie odrzucona, sprawdź, czy uwierzytelniona tożsamość ma uprawnienia dostępu do żądanego zasobu, zanim odpowiedź zostanie potraktowana jako błąd uwierzytelniania.
Zweryfikuj dostęp do interfejsu API
Po skonfigurowaniu uwierzytelniania:
- Uzyskaj token dostępu.
- Prześlij żądanie do zasobu, do którego uwierzytelniona tożsamość ma dostęp.
- Potwierdź, że interfejs API zwraca oczekiwaną odpowiedź.
- Kontynuuj workflow rozpoczynania pracy z interfejsem API.
