API raportowania SkillUp pozwalają na programowe wyodrębnianie sygnałów umiejętności, odznak i danych certyfikacyjnych z Twojej organizacji. Te API umożliwiają integrację wglądu w naukę z systemami HR, tworzenie spersonalizowanych raportów oraz łączenie wyników nauki z wpływem na biznes.

Dostępne punkty końcowe

Konfiguracja API raportowania‬

API SkillUp korzystają z OAuth 2.0 Client Credentials do bezpiecznego dostępu. Tylko autoryzowane systemy mogą żądać i pobierać informacje raportowe.

Aby skonfigurować API raportowania:

‭Krok 1: Generuj dane uwierzytelniające OAuth‬

1. ‭Zaloguj się do SkillUp za pomocą konta administratora.

2. Kliknij ikonę swojego profilu w prawym górnym rogu i wybierz Ustawienia.

3. Kliknij Zarejestruj nową aplikację.

4. Wprowadź nazwę swojej aplikacji.

5. Kliknij Zarejestruj aplikację.

6. Skopiuj ID klienta i Sekret klienta do schowka lub kliknij Pobierz JSON, aby zapisać dane uwierzytelniające jako plik.

   Ważna uwaga: Sekret klienta jest wyświetlany tylko raz podczas generowania. Musisz go bezpiecznie przechować przed zamknięciem dialogu, ponieważ nie możesz go ponownie odzyskać.

Twoja aplikacja została teraz pomyślnie zarejestrowana i możesz zacząć wysyłać żądania API.

‭Krok 2: Żądanie tokenu dostępu‬

‭Jako środek bezpieczeństwa, musisz najpierw uzyskać token dostępu, wysyłając żądanie POST do punktu końcowego /v1/oauth2/token.

Nagłówek Authorization musi zawierać Twoje dane uwierzytelniające klienta zakodowane w formacie Base64.

1. Połącz swój identyfikator klienta i sekret klienta za pomocą dwukropka (:).
   Przykład: client_id:client_secret

2. Zakoduj ciąg za pomocą Base64.

3. Dodaj prefiks Basic do zakodowanego ciągu, aby utworzyć nagłówek Authorization.
   Przykład: Basic <base64_encoded_string>.

Przykład

Jeśli client_id = "abc123" i client_secret = "def456"
Połączone: „abc123:def456”

Zakodowane w Base64: „YWJjMTIzOmRlZjQ1Ng==”

Ostateczny nagłówek: „Basic YWJjMTIzOmRlZjQ1Ng==”

Żądanie

curl -X POST https://www.hackerrank.com/skillup/api/v1/oauth2/token \
-H "Authorization: Basic <base64_encoded_credentials>" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials"

Nagłówki

Parametry ciała

Odpowiedź

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 600
}

‭Krok 3: Uzyskaj dostęp do API SkillUp‬

‭Po uzyskaniu ważnego tokena dostępu, użyj go do wywołania API raportowania SkillUp.

Dołącz token do nagłówka Authorization swojego żądania.

Przykład żądania

curl -X GET https://www.hackerrank.com/skillup/api/v2/credentials \
-H "Authorization: Bearer <access_token>"

Obsługa błędów

Najlepsze praktyki

• Przechowuj dane uwierzytelniające w bezpieczny sposób. Nigdy nie ujawniaj danych klienta w kodzie po stronie klienta.

• Tokeny pozostają ważne przez 10 minut. Pamiętaj o buforowaniu i ponownym używaniu tokenów dostępu zamiast generowania nowych dla każdego żądania

• Złóż nowe żądanie tokenu przed wygaśnięciem obecnego.

Limity szybkości

Po więcej informacji, skontaktuj się z skillup-support@hackerrank.com.‭