Artykuł ten wyjaśnia, jak korzystać z API w DevZone z EloView 4

W poniższym opisie przedstawiono, jak korzystać z API w Elo DevZone. Artykuł ten obejmuje następujące tematy:
1. Generowanie poświadczeń OAuth
2. Uzyskiwanie tokenu uwierzytelniającego
3. Autoryzacja API
4. Uzyskiwanie OrgId:
5. Uruchomienie API

1. Generowanie poświadczeń OAuth
OAuth (Open Authorization) to otwarty protokół autoryzacji, który umożliwia aplikacjom „bezpieczny dostęp”. Będzie to używane do uzyskania tokenu autoryzacji. 

 
b. Kliknij na Ikonę profilu

 

c. Kliknij na Generuj poświadczenia OAuth
    
 
d. Skopiuj i wklej poświadczenia OAuth (clientID i clientSecret) do notatnika, a następnie kliknij OK



2. Uzyskiwanie tokenu uwierzytelniającego
Jest to proces uwierzytelniania użytkowników lub procesów dla aplikacji w chmurze. Aplikacja użytkownika wysyła żądanie do usługi autoryzacji, która potwierdza tożsamość użytkownika i wydaje token. Użytkownik może wtedy uzyskać dostęp do aplikacji. 

a. Kliknij na zakładkę API


 
b. Rozwiń siatkę Uwierzytelnianie i kliknij na przycisk „Wypróbuj to” (pokazany na poniższym obrazku), umożliwi to wprowadzenie wartości dla wymaganych parametrów i pokaże przycisk wykonania na dole okna API.

 
c. Dodaj Client Id (parametr ścieżki) i clientsecret jako parametr ciała (otrzymany z poświadczeń OAuth / Krok 1), a następnie kliknij na wykonaj.


d. To zwróci token uwierzytelniający, który może być użyty w dalszych operacjach.

e. Sprawdź ciało odpowiedzi i skopiuj access_token z odpowiedzi. Będzie on używany jako token Bearer do uzyskania dostępu do innych API. Odpowiedź będzie wyglądać jak na poniższym obrazie.
 


3. Autoryzacja API
Tokeny dostępu to elementy, które aplikacje wykorzystują do składania żądań API w imieniu użytkownika. Token dostępu reprezentuje autoryzację konkretnej aplikacji do dostępu do określonych części danych użytkownika.
 
a. Kliknij na przycisk Autoryzuj znajdujący się w prawym górnym rogu ekranu.



b. Otworzy to okno dialogowe, z którego możemy dodać wartość tokenu dostępu, aby autoryzować API.


c. Wpisz bearer i wklej token dostępu w polu wejściowym.



d. Kliknij na przycisk Autoryzuj i zamknij okno pop-up

e. Teraz użytkownik jest autoryzowany do uzyskania dostępu do dowolnego dostępnego API.

4. Uzyskiwanie OrgId:
OrgId (identyfikator organizacji) będzie używany do wykonywania różnych działań API z Dev-zone.
 
a. Kliknij na Ikonę koła zębatego
 
b. OrgId znajduje się w prawym dolnym rogu
 

5. Uruchomienie API
Po dokonaniu autoryzacji możemy uruchomić API z dev-zone.

a. Rozwiń tytuł modułu, np. Treść / Uzyskaj listę treści

b. Kliknij Wypróbuj to

c. Wprowadź ORG ID

d. Wybierz Wykonaj



Wyniki powinny wyglądać tak: