Interfejs API Reach 360 jest zorganizowany wokół REST. Nasz interfejs API ma przewidywalne adresy URL zorientowane na zasoby, akceptuje treści żądań zakodowane w formacie JSON, zwraca odpowiedzi zakodowane w formacie JSON i używa standardowych kodów odpowiedzi HTTP, uwierzytelniania i czasowników.

• Reach 360 API jest dostępny pod adresem https://api.reach360.com
• Interfejs API EU Reach 360 jest dostępny pod adresem https://api.reach360.eu

Najnowsze aktualizacje, zobacz Changelog.

Kliknij tutaj, aby dowiedzieć się, jak generować klucze API w Reach 360.

• Uwierzytelnianie
• Wersjonowanie
• Paginacja
• Błędy
• Wsparcie

Uwierzytelnianie

Twój klucz API służy do uwierzytelniania żądań i identyfikuje Twoje konto Reach 360. Powinien być bezpiecznie przechowywany: upewnij się, że jest przechowywany poza kontrolą wersji i może być dostępny tylko dla tych, którzy go potrzebują. Traktuj to jak każde inne hasło.

Wszystkie żądania API muszą korzystać z uwierzytelniania Bearer: Twój klucz API musi być dostarczony jako token na okaziciela w nagłówku. Authorization Wszystkie żądania API muszą być składane przez HTTPS. Połączenia wykonywane przez zwykły HTTP zakończą się niepowodzeniem. Żądania API bez uwierzytelniania również nie powiodą się.

Wersjonowanie

Gdy w naszym interfejsie API zostaną wprowadzone zmiany, które nie są kompatybilne wstecznie, wydamy nową, przestarzałą wersję interfejsu API. Początkowa wersja API 2023-04-04 zostanie przyjęta, gdy żądania nie zawierają API-Version nagłówka.

Gdy podany zostanie nieprawidłowy nagłówek wersji API, otrzymasz odpowiedź 400 z kodem błędu. invalid_api_version Pomyślne żądania API będą zawierać nagłówek API-Version odpowiedzi wskazujący, z której wersji interfejsu API zostało przetworzone żądanie.

Za każdym razem, gdy pojawia się nowa wersja API, wywołujemy ją wyraźnie w naszym dzienniku zmian, oprócz tworzenia nowego wpisu na stronie Wersje API.

Przykładowe żądanie

curl -i < https://api.reach360.com/users >\\ 
 -H „Autoryzacja: Bearer $API_KEY” -H „Wersja interfejsu API: 16.07.20" 
 

Paginacja

Wszystkie podzielone na strony punkty końcowe są oparte na kursorze i zwracają właściwość. nextUrl Jeśli nienull, nextUrl oznacza, że mogą wystąpić dodatkowe wyniki. Można wysłać GET żądanie do nextUrl adresu URL, aby uzyskać następną stronę wyników. A nextUrl null wskazuje, że nie ma dalszych wyników. Wszystkie punkty końcowe podzielone na strony obsługują limit parametr ciągu zapytania, który określa maksymalną liczbę wyników do zwrócenia w pojedynczej odpowiedzi. Wszystkie punkty końcowe, które zwracają listę wyników, wspierają paginację.

Uwaga: limit Wartość musi wynosić od 1 do 100 (chyba że zaznaczono inaczej; a domyślnie 50, jeśli nie określono).

Punkty końcowe wspierające paginację

• GET /courses
• GET /groups
• GET /groups/{groupId}/users
• GET /invitations
• GET /learning-paths
• GET /learning-paths/{learningPathId}
• GET /learning-paths/{learningPathId}/courses
• GET /groups/{groupId}/managers
• GET /users/{userId}/managing-groups
• GET /reports/activity
• GET /reports/courses/{courseId}
• GET /reports/learners/{userId}
• GET /reports/learning-paths/{learningPathId}/courses
• GET /reports/learning-paths/{learningPathId}/learners
• GET /users
• GET /users/{userId}/groups
• GET /groups/{groupId}/reporters
• GET /users/{userId}/reporting-groups
• GET /webhooks

Błędy

Odpowiedź 400 zawierająca listę errors zostanie zwrócona, gdy żądanie jest nieprawidłowe. Niektóre typowe kody błędów obejmują:

• validation_failed: W treści żądania wystąpił błąd walidacji
• invalid_email: email Właściwość nie jest poprawnie sformatowanym adresem e-mail
• missing_api_key: W żądaniu brakuje klucza API
• invalid_api_key: Podany klucz API jest nieprawidłowy
• invalid_content_type: Żądanie brakuje/ma nieprawidłowy typ treści

Przykładowa odpowiedź

{
„errors”: [
{
„code”: „invalid_email”, 
 „message”: „\\" email\\” musi być poprawnym adresem e-mail”
}]]} 
 
 

Wsparcie

Cieszymy się, że połączysz Reach 360 z narzędziami, których najczęściej używasz. Wsparcie może potwierdzić, czy wywołania API działają zgodnie z oczekiwaniami, ale nie możemy pomóc w pisaniu niestandardowego skryptu lub debugowaniu aplikacji innych firm.

Jeśli napotkasz problem, dołożymy wszelkich starań, aby pomóc Ci rozwiązać problem, prosząc o:

• Najprostsza wersja połączenia, którą wykonujesz za pomocą interfejsu API
• Czy problem można powielić poza aplikacją
• Nagłówki żądań, nagłówki odpowiedzi (w tym nagłówek X-Request-Id), organy żądań i organy odpowiedzi

Skontaktuj się z naszym zespołem i daj nam znać, co się dzieje. Zabierzemy to stamtąd!