Centrum wsparcia Workiva

W dynamicznych integracjach, zwłaszcza w przypadku korzystania z konektorów HTTP w zautomatyzowanych przepływach pracy (takich jak łańcuchy), kluczowe znaczenie ma efektywna obsługa odpowiedzi z wywołania API. Parametry wyjściowe umożliwiają użytkownikom przechwytywanie istotnych fragmentów danych zwracanych przez interfejs API - takich jak treść odpowiedzi, nagłówki odpowiedzi i kod stanu - dzięki czemu dane te mogą być wykorzystywane w dalszych krokach.

Jaki problem to rozwiązuje?

Parametry wyjściowe mają kluczowe znaczenie dla tworzenia responsywnych i inteligentnych przepływów pracy.

• Dynamiczne przepływy pracy: Parametry wyjściowe umożliwiają dostosowanie dalszych działań na podstawie tego, co zwraca interfejs API - na przykład wyodrębnienie tokena, sprawdzenie, czy rekord istnieje lub potwierdzenie pomyślnej operacji.
• Automatyzacja: Dzięki automatycznemu przechwytywaniu wartości użytkownicy unikają ręcznego wprowadzania danych lub kodowania na sztywno, co pozwala na skalowanie przepływów pracy przy mniejszej konserwacji.
• Usprawnione integracje: Łączenie systemów, takich jak serwery uwierzytelniające, CRM lub niestandardowe interfejsy API, staje się bardziej płynne, ponieważ konektor dostosowuje się na podstawie otrzymywanych danych.

Kogo to dotyczy?

• Deweloperzy i integratorzy: Osoby budujące łańcuchy automatyzacji lub integracje między systemami.
• Analitycy danych: Ci, którzy polegają na dokładnych przepływach danych w czasie rzeczywistym w celu zasilania pulpitów nawigacyjnych lub raportowania.
• Administratorzy systemu: Osoby zajmujące się utrzymaniem i rozwiązywaniem problemów z integracjami - dostęp do parametrów wyjściowych pomaga szybko zidentyfikować problemy.

Czym są parametry wyjściowe?

Parametry wyjściowe w konektorze HTTP służą do definiowania oczekiwanych wyników żądania HTTP, takich jak nagłówki odpowiedzi, treść odpowiedzi lub kod odpowiedzi. Definiują one oczekiwane wyniki żądania HTTP, które mogą być następnie ponownie wykorzystane w kolejnych węzłach lub krokach logicznych w łańcuchu.

Przykładowe parametry wyjściowe:

• Nagłówki odpowiedzi: Metadane, takie jak typ zawartości, serwer lub status limitu szybkości.
• Treść odpowiedzi: Rzeczywista treść zwrócona przez API - zazwyczaj w formacie JSON lub XML.
• Kod odpowiedzi: Wskazuje sukces (200), błąd klienta (400), błąd serwera (500) itp.

Przykład: Przechwytywanie tokena dostępu

Załóżmy, że interfejs API zwraca token w następujący sposób:

{ "token_type": "Bearer", "expires_in": 600, "access_token": "<access_token_string>", "scope": "graph:write graph_api|r permissions|w ..." }

Możesz zdefiniować access_token jako parametr wyjściowy, a następnie przekazać go do następnego kroku (np. w celu uwierzytelnienia innego wywołania API).

Dlaczego ciało odpowiedzi jest potrzebne?

Treść odpowiedzi jest zazwyczaj miejscem, w którym API zwraca najważniejsze informacje. Mogą one obejmować między innymi:

• Identyfikatory nowo utworzonych rekordów
• Tokeny uwierzytelniające
• Wyniki zapytań lub ładunki danych

Bez dostępu do treści odpowiedzi jesteś ograniczony do metadanych, co ogranicza dynamikę przepływu pracy. 

Możemy teraz uzyskać access_token dostępny w rozwijanym menu Response.

Typowe scenariusze obsługi błędów

Typowe problemy, które możesz napotkać podczas pracy z parametrami wyjściowymi:

• Błąd: niezdefiniowany parametr wyjściowy

  Przyczyna i rozwiązanie: Struktura treści odpowiedzi uległa zmianie lub jest zagnieżdżona. Potwierdź poprawną ścieżkę JSON do pola.

• Błąd: 401 Nieautoryzowany

  Przyczyna i naprawa: Brak tokena lub jego ważność wygasła. Upewnij się, że token został poprawnie przechwycony i przekazany.

• Błąd: 500 Wewnętrzny błąd serwera

  Przyczyna i rozwiązanie: Problem z serwerem lub nieprawidłowy ładunek żądania. Sprawdź treść odpowiedzi, aby uzyskać więcej informacji.

• Błąd: Nieprawidłowy JSON

  Przyczyna i rozwiązanie: Interfejs API zwraca nieprawidłową odpowiedź. Użyj bloku Try-Catch lub zweryfikuj dane wyjściowe przed parsowaniem.

Czym jest token na okaziciela i dlaczego jest potrzebny?

Token okaziciela to rodzaj tokena dostępu używanego w uwierzytelnianiu OAuth 2.0. Autoryzuje użytkownika lub aplikację do dostępu do API. Nazywa się to "Bearer", ponieważ "nosisz" token w nagłówku żądania HTTP.

Przykładowy nagłówek:

Autoryzacja: Bearer <access_token&gt

Ten token jest bezpieczniejszy niż podstawowe uwierzytelnianie, ponieważ:

• Wygasa, zmniejszając ryzyko wycieku tokenów.
• Może przenosić lunety i uprawnienia.
• Oddziela uwierzytelnianie od autoryzacji.

Dlaczego nie skorzystać z podstawowego uwierzytelniania?

Podczas gdy Basic Auth wysyła nazwę użytkownika i hasło zakodowane w każdym żądaniu:

• Jest mniej bezpieczny - dane uwierzytelniające mogą zostać ponownie wykorzystane lub przechwycone.
• Nie można łatwo wygasić lub ograniczyć dostępu.
• Brak kontroli uprawnień opartej na tokenach.

Tokeny na okaziciela obsługują wygasanie tokenów, odświeżanie i szczegółowe uprawnienia, co czyni je lepszym wyborem dla nowoczesnych interfejsów API i bezpieczeństwa klasy korporacyjnej.