Centrum wsparcia Workiva

Chcesz połączyć się z aplikacją innej firmy poza gotowymi konektorami Premium Workiva? Możesz to osiągnąć, wykorzystując polecenia HTTP Request Connector do interakcji z interfejsami API REST. W tej połączonej ścieżce edukacyjnej zaktualizujemy nasz łańcuch, aby użyć tokena okaziciela w poleceniu, które wykorzystuje punkt końcowy listy Spreadsheets, aby wyświetlić listę arkuszy kalkulacyjnych w obszarze roboczym.

Uwaga: Chociaż jest to oznaczone jako żądanie HTTP, HTTPS (bezpieczny HTTP) jest obsługiwany (i zalecany).

Krok 1: Utwórz zmienne obszaru roboczego

Aby korzystać ze szczegółów interfejsu API Workiva w wielu łańcuchach i poleceniach, utworzymy zmienne Workspace do przechowywania tych informacji. Utworzymy nową zmienną obszaru roboczego dla adresu URL API platformy.

1. Z poziomu Chain Builder przejdź do Workspace Settings.
2. W sekcji Workspace Variables kliknij znak plus, aby utworzyć nową zmienną obszaru roboczego.

3. Skonfiguruj zmienne, korzystając z poniższych informacji:

   • Nazwa: wsv-BaseURL-Platform
   • Wartość: W zależności od regionu, użyj odpowiedniej wartości. Możesz zweryfikować region, sprawdzając adres URL; jeśli adres URL zawiera EU lub APAC, użyj odpowiedniego adresu URL. W przeciwnym razie użyj wartości amerykańskiej.

   Uwaga: Region USA zawiera tylko "app".

   • Region USA
   • Region UE
   • Region APAC

   Pole	Wartość USA
   IAM Base URL	https://api.app.wdesk.com/platform/v1

   Pole	Wartość UE
   IAM Base URL	https://api.eu.wdesk.com/platform/v1

   Pole	Wartość APAC
   IAM Base URL	https://api.apac.wdesk.com/platform/v1

4. Zapisz ustawienia obszaru roboczego .

Uwaga: Powinieneś zobaczyć wszystkie cztery zmienne w ustawieniach obszaru roboczego. Jeśli nie, zapoznaj się ponownie z wymaganiami wstępnymi opisanymi powyżej

Krok 2: Skopiuj i zmodyfikuj łańcuch

1. Przejdź do narzędzia Chain Builder i znajdź łańcuch o nazwie CLP | Generate a Token.
2. Kliknij pionową elipsę po prawej stronie i wybierz Kopiuj.
3. Po utworzeniu kopii łańcucha kliknij ikonę ołówka, aby edytować łańcuch.
4. Kliknij Ustawienia łańcucha w prawym górnym rogu.
5. Zmień nazwę łańcucha: CLP | HTTP Request List Spreadsheets.
6. (Opcjonalnie) Wprowadź Opis: "Ten łańcuch generuje nowy token dostępu do interfejsu API Workiva. Musisz podać prawidłowy Client ID i Client Secret z wcześniej wygenerowanego API Grant w zmiennych wartościach poniżej. Następnie pobiera listę wszystkich arkuszy kalkulacyjnych w obszarze roboczym. Twój obszar roboczy musi zawierać co najmniej jeden arkusz kalkulacyjny".
7. Uratuj łańcuch.

Krok 3: Lista arkuszy kalkulacyjnych

Aby pobrać listę naszych arkuszy kalkulacyjnych, ten łańcuch używa polecenia GET z konektora żądań HTTP.

4. Dodaj polecenie Get z konektora HTTP Request do kanwy Chain.
5. Połącz polecenie Post - Retrieve a Token z poleceniem Get.
6. Kliknij dwukrotnie polecenie, aby je skonfigurować.
   1. Zmień nazwę polecenia: Pobierz - Lista arkuszy kalkulacyjnych
   2. Kliknij polecenie, a następnie powiązaną z nim ikonę ołówka, aby edytować polecenie.
   3. Zaznacz pole wyboru Show Response.
   4. Kliknij w URL, a następnie kliknij Workspace w panelu "Wybierz zmienną" i wybierz zmienną utworzoną w kroku 1 (wsv-BaseURL-Platform).
   5. Dodaj /spreadsheets po zmiennej.
      
      
      Następnie przekażemy punktowi końcowemu sposób wykonania, określając Headers w formularzu Get.
      Te nagłówki przekażą Bearer Token do API, aby pokazać, że mamy dostęp do listy arkuszy kalkulacyjnych.
   6. Kliknij dwukrotnie szary przycisk plus (+) obok sekcji Header i wypełnij każde pole poniższymi wartościami, zwracając szczególną uwagę na wielkość liter i spację po słowie "Bearer".
      • Pole nagłówka 1:
        • Klucz: Akceptuj
        • Wartość: application/json
      • Pole nagłówka 2:
        • Klucz: Autoryzacja

        • Wartość: Bearer <Post - Retrieve a Token - Response>
          Zastąp <Post - Retrieve a Token - Response> danymi wyjściowymi z polecenia POST - Retrieve a Token.

          

          1. W panelu Select a Variable kliknij strzałkę w dół Runtime, aby rozwinąć POST - Retrieve a Token
          2. Kliknij strzałkę w dół obok Response, aby rozwinąć opcje zmiennych.
          3. Wybierz Access_token.

7. Wypełnij Typ zawartości z: application/json.

   

8. Wypełnij odpowiedź przykładowym ładunkiem poniżej. W ten sposób zapewniamy format danych wyjściowych polecenia, dzięki czemu każda zwrócona zmienna jest łatwiejsza w użyciu.

   { "data": { "created": { "dateTime": "2018-10-21T15:03:27Z" }, "name": "Przegląd na koniec roku", "id": "124efa2a142f472ba1ceab34ed18915f", "modified": { "dateTime": "2018-10-21T15:03:27Z" }, "template": false }, { "created": { "dateTime": "2020-02-20T15:03:27Z" }, "name": "Q1 Review", "id": "164cfb2b132c4623a2cfaa31ef13925a", "modified": { "dateTime": "2020-03-29T13:15:27Z" }, "template": false } ], "@nextLink": "<opaque_url>" }

9. (Opcjonalnie) Wprowadź Opis: "To polecenie zwraca jedną stronę listy arkuszy kalkulacyjnych. Aby uzyskać więcej informacji, zapoznaj się z dokumentacją dla deweloperów na stronie https://developers.workiva.com/platform-v1/platform-getspreadsheets/".

   Wskazówka! Aby określić sposób wypełniania pól nagłówka i odpowiedzi, zapoznaj się z dokumentacją programisty dla punktu końcowego API, z którym się łączysz, w tym przypadku używamy punktu końcowego "Get Spreadsheets".

10. Zapisz polecenie.

Krok 4: Przetestuj ćwiczenie

Teraz, gdy łańcuch jest gotowy, przetestuj wynik.

1. Opublikuj the Chain.
2. Kliknij Execute, a następnie Run Chain.
3. Gdy łańcuch zakończy swoje działanie, powinieneś zobaczyć listę arkuszy kalkulacyjnych w zakładce Outputs - Response Body polecenia Get.

Aby kontynuować wyzwanie i dowiedzieć się więcej o korzystaniu z konektora żądań HTTP do łączenia się z interfejsem API innej firmy, sprawdź następne ćwiczenie: CLP - HTTP Request Get a Single Spreadsheet.