Co robi ten punkt końcowy interfejsu API

Za pomocą interfejsu API Zaproszenia tworzysz i usuwasz zaproszenia do Reach 360. Administratorzy widzą to odzwierciedlone jako użytkownicy na karcie Oczekujące. Użytkownicy otrzymują e-maile po zaproszeniu. Jeśli oczekujące zaproszenie zostanie usunięte przed ich zaakceptowaniem, link e-mail nie będzie działał.

Możesz także użyć tego interfejsu API, aby pobrać listę wszystkich oczekujących zaproszeń lub szczegółów zaproszenia dla określonego użytkownika.

• Punkty końcowe
• Obiekty zaproszenia
• Utwórz zaproszenie
• Lista zaproszeń
• Odzyskaj zaproszenie według identyfikatora
• Usuń zaproszenia

Punkty końcowe

• POST /invitations—wyślij zaproszenie do użytkownika, aby dołączył do Twojego zespołu
• GET /invitations—lista oczekujących zaproszeń
• GET /invitations/{invitationId}—uzyskać szczegółowe informacje na temat oczekującego zaproszenia za pomocą identyfikatora zaproszenia
• DELETE /invitations/{invitationId}—usuń oczekujące zaproszenie za pomocą identyfikatora zaproszenia

Obiekty zaproszenia

• id(string) - unikalny identyfikator zaproszenia
• email(string) - adres e-mail osoby zaproszonej
• firstName(string) - imię osoby zaproszonej
• lastName(string) - nazwisko osoby zaproszonej
• groups(lista ciągów) - lista nazw grup, do których powinna zostać przypisana zaproszona osoba
• url(string) - URL do pobierania szczegółów zaproszenia z interfejsu API

Utwórz zaproszenie

POST /invitations

Parametry żądania (JSON)

• email(string, required) - e-mail użytkownika do zaproszenia
• firstName(string, opcjonalnie) - imię użytkownika do zaproszenia
• lastName(string, opcjonalne) - nazwisko użytkownika do zaproszenia
• groups(lista ciągów, opcjonalne) - lista nazw grup, do których można przypisać zaproszonego użytkownika. Wszystkie grupy, które nie istnieją, są tworzone, gdy użytkownik zaakceptuje zaproszenie.

Przykładowa odpowiedź

{
„invitation”: {
„id”: „example-invitation-id”, 
 „email”: "foo@example.com „, „FirstName”: „Przykładowe imię”, 
 „Nazwisko przykładowe”: 
 „Przykładowe nazwisko”, „grupy”: ["przykładowa grupa a”, 
 „exaple group b"]}} 
 

Kody błędów specyficzne dla punktu końcowego

• 'user_exists'- nie można utworzyć zaproszenia, ponieważ podany adres e-mail ma już konto
• 'invite_pending'- nie można utworzyć zaproszenia, ponieważ podany adres e-mail ma już zaproszenie oczekujące
• 'max_invites_reached'- nie można utworzyć zaproszenia, ponieważ przekroczyłeś limit konta próbnego. Zaktualizuj swój plan lub skontaktuj się z pomocą techniczną, aby zwiększyć ten limit.

Lista zaproszeń

GET /invitations

Parametry żądania (ciąg zapytania)

• limit(liczba całkowita, opcjonalna) - maksymalna liczba wyników do zwrócenia w pojedynczej odpowiedzi (patrz Paginacja); musi wynosić od 1 do 100 (domyślnie 50)
• email(string, opcjonalnie) - jeśli podano, zwracaj tylko zaproszenia na ten adres e-mail

Przykładowa odpowiedź

{
„invitations”: [
{
„id”: „example-invitation-id-1", „email”: "foo@example.com 
 „, „FirstName”: „Przykładowe imię 1", 
 „LastName”: „Przykładowe nazwisko 1", 
 „groups”: ["przykładowa grupa a”, 
 „exaple group b"]},... 
 
], 
 „NextURL”: "https://url-for-next-page-of-results"} 

Odzyskaj zaproszenie według identyfikatora

GET /invitations/{invitationId}

Przykładowa odpowiedź

{
„id”: „example-invitation-id”, 
 „email”: "foo@example.com „, „FirstName”: 
 „Przykładowe imię”, „LastName”: 
 „Przykładowe nazwisko”, „groups”: ["example group a”, 
 „exaple group b"]} 

Kody błędów specyficzne dla punktu końcowego

• 'invitation_not_found'- nie można pobrać zaproszenia, ponieważ zaproszenie nie istnieje

Usuń zaproszenia

DELETE /invitations/{invitationId}

Odpowiedź na sukces

204 „Brak treści”

Kody błędów specyficzne dla punktu końcowego

• 'invitation_not_found'- nie można pobrać zaproszenia, ponieważ zaproszenie nie istnieje