Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Polish

Szablony autoryzacji umożliwiają zdefiniowanie wspólnej metody autoryzacji dla wielu źródeł danych typu RESTful API.

Zapisany szablon można wykorzystywać wielokrotnie przy konfiguracji kolejnych źródeł danych komunikujących się z tym samym systemem API.

Tworzenie szablonu autoryzacji:

Aby utworzyć autoryzację należy wybrać na formularzu źródła danych przycisk "Utwórz szablon autoryzacji":

Następnie pojawi się okienko z konfiguracją szablonu autoryzacji:

Opis konfiguracji szablonu autoryzacji:

Nazwa parametruOpisWymagalność
SzablonPozwala na uzupełnienie pól konfiguracji jednym z wcześniej zapisanych szablonów w celu przyspieszenia konfiguracji wielu podobnych szablonów.Nie dotyczy
IdUnikalne id szablonu autoryzacji.Wymagany
NazwaWyświetlana nazwa szablonu autoryzacji.Wymagany
OpisWyświetlany opis szablonu autoryzacji.Wymagany
Rodzaj autoryzacjiPozwala na wybranie jednego z dostępnych rodzajów autoryzacji, obsługiwanych przez wtyczkę. Po wybraniu rodzaju autoryzacji na formularzu pojawią się dodatkowe pola konfiguracyjne specyficzne dla niego. Lista dostępnych rodzajów autoryzacji zamieszczona została poniżej.Wymagany


Dostępne rodzaje autoryzacji:

Table of Contents
exclude(Dostępne rodzaje autoryzacji:)|(Tworzenie szablonu autoryzacji:)|(Opis konfiguracji szablonu autoryzacji:)|(Modyfikacja szablonów autoryzacji)

API Key

Szablon autoryzacji API Key umożliwia dodanie do każdego żądania stałego klucza API. Klucz może zostać dodany do adresu URL w formacie ?klucz=wartość lub do nagłówka w formacie { headers: { klucz: wartość } }

Opis konfiguracji:

Nazwa parametruOpisWymagalność
KluczKlucz parametru URL lub nazwa nagłówka (w zależności od parametru "Dodaj do")Wymagany
WartośćWartość parametru URL lub wartość nagłówka (w zależności od parametru "Dodaj do")Wymagany
Dodaj doOkreśla czy klucz ma zostać dodany do żądania jako parametr adresu URL czy jako nagłówek.Wymagany

Przykłady konfiguracji:

 

KonfiguracjaWynik

Doda do adresu URL żądania, podanego w konfiguracji źródła parametr ?token=ASDF

Np. http://localhost:8080 => http://localhost:8080?token=ASDF

Doda do żądania nagłówek "API-KEY: someConstantToken"

Basic Auth

Szablon autoryzacji Basic Auth umożliwia dodanie do każdego żądania nagłówka Basic Auth w postaci: Authorization: Basic {credentials}, gdzie {credentials} to wartość Base64 obliczana z ciągu: {Użytkownik}:{Hasło}.

Opis konfiguracji:

Nazwa parametruOpisWymagalność
UżytkownikNazwa użytkownika zarejestrowanego w APIWymagany
HasłoHasło użytkownikaWymagany

Bearer Token

Szablon autoryzacji Bearer Token umożliwia dodanie do każdego żądania nagłówka Basic Auth w postaci: Authorization: Bearer {token}

Opis konfiguracji:

Nazwa parametruOpisWymagalność
TokenWartość tokenu, który ma być podstawiony do nagłówkaWymagany

Szablon autoryzacji Cookie umożliwia dodanie do każdego żądania ciasteczka wymaganego do autoryzacji żądania.

Opis konfiguracji:

Nazwa parametruOpisWymagalność
Metoda HTTPMetoda HTTP, która ma zostać użyta w żądaniu; możliwe wartości: [GET, POST]Wymagany
URLAdres URL pod który wysłane zostanie żądanie w celu otrzymania ciasteczka z APIWymagany
Content-TypeDostępny tylko po wybraniu metody POST. Dostępne wartości: application/json, application/x-www-form-urlencoded, multipart/form-dataWymagany
ParametryDostępny tylko po wybraniu metody POST. Parametry przekazywane w ciele żądania.Opcjonalny

Przykłady konfiguracji:

KonfiguracjaWynik
Dołączy do żądań ze źródła danych ciasteczko autoryzacyjne z systemu PlusWorkflow
Dołączy do żądań ze źródła danych ciasteczko autoryzacyjne z systemu PlusWorkflow

OAuth2

Szablon autoryzacji OAuth2 umożliwia dodanie do każdego żądania tokena OAuth w postaci odpowiedniego nagłówka lub parametru adresu URL.

Opis konfiguracji:

Nazwa parametruOpisWymagalność
Grant type

Określa czy żądanie autoryzujące ma zawierać tylko sekrety klienta, czy również informacje o użytkowniku. Dostępne wartości:

  • Client credentials - tylko sekrety klienta
  • Password credentials - sekrety klienta + informacje o użytkowniku
Wymagany
Access Token URLAdres URL, pod który wysłane zostanie żądanieWymagany
UsernameNazwa użytkownika. Dostępny jedynie w przypadku, gdy parametr "Grant type" ustawiony zostanie na wartość "Password credentials"Wymagany
PasswordHasło użytkownika. Dostępny jedynie w przypadku, gdy parametr "Grant type" ustawiony zostanie na wartość "Password credentials"Wymagany
Client IDhttps://www.oauth.com/oauth2-servers/client-registration/client-id-secret/Wymagany
Client Secrethttps://www.oauth.com/oauth2-servers/client-registration/client-id-secret/Wymagany
ScopeOpcjonalny parametr określający do jakich zasobów ma zostać udzielony dostęp. Wartość parametru zależy od konkretnego rozwiązania API, do którego łączyć się będzie źródło danychOpcjonalny
ResourceOpcjonalny parametr określający do jakich zasobów ma zostać udzielony dostęp. Wartość parametru zależy od konkretnego rozwiązania API, do którego łączyć się będzie źródło danychOpcjonalny
Autoryzacja klienta

Określa w jaki sposób mają zostać przekazane dane autoryzujące (sekrety klienta). Dostępne wartości:

  • Wyślij jako nagłówek Basic Auth,
  • Wyślij jako dane formularza w ciele żądania
Wymagany
Dodaj dane autoryzujące do

Określa w jaki sposób ma być przekazywany token autoryzujący (otrzymany w odpowiedzi na żądanie autoryzujące) przy kolejnych wywołaniach API. Dostępne wartości:

  • Nagłówka żądania
  • URL-a żądania
Wymagany

Przykład konfiguracji:

Modyfikacja szablonów autoryzacji

Szablony autoryzacji umożliwiają modyfikację wcześniej zapisanych szablonów. Aby tego dokonać należy na formularzy wybrać przycisk "Modyfikuj szablony autoryzacji".

Po kliknięciu ukaże się okno modyfikacji szablonu autoryzacji.

W otwartym oknie należy wybrać z listy rozwijanej zapisany szablon autoryzacji.

Po wybraniu szablonu formularz zostanie uzupełniony o dane w nim zapisane.

Po zakończeniu edycji danych należy wybrać przycisk "Modyfikuj szablon autoryzacji" w celu zapisania szablonu ze zmianami.

Nieużywany szablon można również usunąć z bazy za pomocą przycisku "Usuń".

English

Szablony autoryzacji umożliwiają zdefiniowanie wspólnej metody autoryzacji dla wielu źródeł danych typu RESTful API.

Zapisany szablon można wykorzystywać wielokrotnie przy konfiguracji kolejnych źródeł danych komunikujących się z tym samym systemem API.

Tworzenie szablonu autoryzacji:

Aby utworzyć autoryzację należy wybrać na formularzu źródła danych przycisk "Utwórz szablon autoryzacji":

Image Removed

Następnie pojawi się okienko z konfiguracją szablonu autoryzacji:

Image Removed

Opis konfiguracji szablonu autoryzacji:

Nazwa parametruOpisWymagalność
SzablonPozwala na uzupełnienie pól konfiguracji jednym z wcześniej zapisanych szablonów w celu przyspieszenia konfiguracji wielu podobnych szablonów.Nie dotyczy
IdUnikalne id szablonu autoryzacji.Wymagany
NazwaWyświetlana nazwa szablonu autoryzacji.Wymagany
OpisWyświetlany opis szablonu autoryzacji.Wymagany
Rodzaj autoryzacjiPozwala na wybranie jednego z dostępnych rodzajów autoryzacji, obsługiwanych przez wtyczkę. Po wybraniu rodzaju autoryzacji na formularzu pojawią się dodatkowe pola konfiguracyjne specyficzne dla niego. Lista dostępnych rodzajów autoryzacji zamieszczona została poniżej.Wymagany
Dostępne rodzaje autoryzacji

Authorization templates allow you to define a common authorization method for many RESTful API datasources.

The saved template can be used many times to configure subsequent datasources that communicate with the same API system.

Creating an authorization template:

To create an authorization template, select the "Create authorization template" button on the datasource form:

Image Added

Then a window will appear with the configuration of the authorization template:

Image Added

Description of the authorization template configuration:

Name of the parameterDescriptionOptionality
TemplateIt allows you to complete the configuration fields with one of the previously saved templates to speed up the configuration of many similar templates.Not applicable
IdUnique authorization template id.Required
NameAuthorization template display name.Required
DescriptionDisplayed description of the authorization template.Required
Authorization typeIt allows you to choose one of the available authorization types supported by the plugin. After selecting the authorization type, additional configuration fields specific to it will appear on the form. The list of available authorization types is given below.Required


Available authorization types:

Table of Contents
exclude(Dostępne rodzaje autoryzacji:)|(Tworzenie szablonu autoryzacji:)|(Opis konfiguracji szablonu autoryzacji:)|(Modyfikacja szablonów autoryzacji)

API Key

Szablon autoryzacji API Key umożliwia dodanie do każdego żądania stałego klucza API. Klucz może zostać dodany do adresu URL w formacie ?klucz=wartość lub do nagłówka w formacie The API Key authorization template allows you to add a permanent API key to each request. The key can be added to the URL in the format - ?key=value - or to the header in the format { headers: { kluczkey: wartość value } }

Opis konfiguracji

Configuration description:

Nazwa parametruOpisWymagalność
KluczKlucz parametru URL lub nazwa nagłówka (w zależności od parametru "Dodaj do")Wymagany
WartośćWartość parametru URL lub wartość nagłówka (w zależności od parametru "Dodaj do")Wymagany
Dodaj doOkreśla czy klucz ma zostać dodany do żądania jako parametr adresu URL czy jako nagłówek.Wymagany

Przykłady konfiguracji:

 

Doda do adresu URL żądania, podanego w konfiguracji źródła parametr ?token=ASDF

Np
KonfiguracjaWynik
Image RemovedName of the parameterDescriptionOptionality
KeyURL parameter key or header name (depending on the "Add to" parameter)Required
ValueURL parameter value or header value (depending on the "Add to" parameter)Required
Add toSpecifies whether to add the key to the request as a URL parameter or as a header.Required

Configuration examples:

ConfigurationResult
Image Added

It will add the request parameter provided in the source configuration to the URL ?token=ASDF

Eg. http://localhost:8080 => http://localhost:8080?token=ASDF

Doda do żądania nagłówek It will add following header to the request "API-KEY: someConstantToken"

Basic Auth

Szablon autoryzacji Basic Auth umożliwia dodanie do każdego żądania nagłówka Basic Auth w postaciThe Basic Auth authorization template allows you to add a Basic Auth header to each request in the form: Authorization: Basic {credentials}, gdzie where {credentials} to wartość Base64 obliczana z ciągu is the Base64 value calculated from: {Użytkownik}:{Hasło}.

Opis konfiguracji

Configuration description:

Wymagany
Nazwa parametruOpisWymagalność
UżytkownikNazwa użytkownika zarejestrowanego w APIWymagany
HasłoHasło użytkownikaName of the parameterDescriptionOptionality
UserName of the user registered in the APIRequired
PasswordUser passwordRequired

Bearer Token

Szablon autoryzacji Bearer Token umożliwia dodanie do każdego żądania nagłówka Basic Auth w postaciThe Bearer Token authorization template allows you to add a Basic Auth header to each request in the form: Authorization: Bearer {token}

Opis konfiguracji:

Nazwa parametruOpisWymagalność
TokenWartość tokenu, który ma być podstawiony do nagłówkaWymagany

Cookie

Szablon autoryzacji Cookie umożliwia dodanie do każdego żądania ciasteczka wymaganego do autoryzacji żądania
Name of the parameterDescriptionOptionality
TokenThe value of the token to be forwarder into the headerRequired

Cookie

The Cookie authorization template allows you to add to each request the cookie required to authorize the request.

Opis konfiguracji:

Metoda HTTP, która ma zostać użyta w żądaniu; możliwe wartościWymagany
Nazwa parametruOpisWymagalność
Metoda HTTPName of the parameterDescriptionOptionality
HTTP methodThe HTTP method to be used in the request; possible values: [GET, POST]WymaganyRequired
URLAdres URL pod który wysłane zostanie żądanie w celu otrzymania ciasteczka z APIThe URL to which the request will be sent to receive cookies from the APIRequired
Content-TypeDostępny tylko po wybraniu metody POST. Dostępne wartościAvailable only after selecting the POST method. Available values: application/json, application/x-www-form-urlencoded, multipart/form-dataWymaganyRequired
ParametryDostępny tylko po wybraniu metody POST. Parametry przekazywane w ciele żądania.Opcjonalny
Przykłady konfiguracji
ParametersAvailable only after selecting the POST method. Parameters passed in the body of the request.Optional

Configuration examples:

KonfiguracjaWynik
Image ModifiedDołączy do żądań ze źródła danych ciasteczko autoryzacyjne z systemu PlusWorkflow
Image ModifiedDołączy do żądań ze źródła danych ciasteczko autoryzacyjne z systemu PlusWorkflow

 

OAuth2

Szablon autoryzacji OAuth2 umożliwia dodanie do każdego żądania tokena OAuth w postaci odpowiedniego nagłówka lub parametru adresu URL.

Opis konfiguracji:

Nazwa parametruOpisWymagalność
Grant type

Określa czy żądanie autoryzujące ma zawierać tylko sekrety klienta, czy również informacje o użytkowniku. Dostępne wartości:

  • Client credentials - tylko sekrety klienta
  • Password credentials - sekrety klienta + informacje o użytkowniku
Wymagany
Access Token URLAdres URL, pod który wysłane zostanie żądanieWymagany
UsernameNazwa użytkownika. Dostępny jedynie w przypadku, gdy parametr "Grant type" ustawiony zostanie na wartość "Password credentials"Wymagany
PasswordHasło użytkownika. Dostępny jedynie w przypadku, gdy parametr "Grant type" ustawiony zostanie na wartość "Password credentials"Wymagany
Client IDhttps://www.oauth.com/oauth2-servers/client-registration/client-id-secret/Wymagany
Client Secrethttps://www.oauth.com/oauth2-servers/client-registration/client-id-secret/Wymagany
ScopeOpcjonalny parametr określający do jakich zasobów ma zostać udzielony dostęp. Wartość parametru zależy od konkretnego rozwiązania API, do którego łączyć się będzie źródło danychOpcjonalny
ResourceOpcjonalny parametr określający do jakich zasobów ma zostać udzielony dostęp. Wartość parametru zależy od konkretnego rozwiązania API, do którego łączyć się będzie źródło danychOpcjonalny
Autoryzacja klienta

Określa w jaki sposób mają zostać przekazane dane autoryzujące (sekrety klienta). Dostępne wartości:

  • Wyślij jako nagłówek Basic Auth,
  • Wyślij jako dane formularza w ciele żądania
Wymagany
Dodaj dane autoryzujące do

Określa w jaki sposób ma być przekazywany token autoryzujący (otrzymany w odpowiedzi na żądanie autoryzujące) przy kolejnych wywołaniach API. Dostępne wartości:

  • Nagłówka żądania
  • URL-a żądania
Wymagany

Przykład konfiguracji:

Modyfikacja szablonów autoryzacji

Szablony autoryzacji umożliwiają modyfikację wcześniej zapisanych szablonów. Aby tego dokonać należy na formularzy wybrać przycisk "Modyfikuj szablony autoryzacji".

Po kliknięciu ukaże się okno modyfikacji szablonu autoryzacji.

W otwartym oknie należy wybrać z listy rozwijanej zapisany szablon autoryzacji.

Po wybraniu szablonu formularz zostanie uzupełniony o dane w nim zapisane.

Po zakończeniu edycji danych należy wybrać przycisk "Modyfikuj szablon autoryzacji" w celu zapisania szablonu ze zmianami.

Nieużywany szablon można również usunąć z bazy za pomocą przycisku "Usuń".