You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Jak prawidłowo skonfigurować API w YetiForce
3
+
description: How to properly configure API in YetiForce
4
4
keywords:
5
5
- Webservice
6
6
- API
@@ -16,90 +16,90 @@ preview: configuration-1.jpg
16
16
17
17
## Configuration
18
18
19
-
W celu skonfigurowania połączenie API, należy najpierw wygenerować klucz API oraz utworzyć użytkownika do autoryzacji.
19
+
To configure an API connection, you must first generate an API key and create a user for authorization.
20
20
21
-
### Generowanie API Key
21
+
### Generate API Key
22
22
23
-
Pierwszym krokiem w celu podłączenia się do API, jest wygenerowanie `API Key`. W tym celu, w sekcji administracyjnej należy wybrać w lewym menu `Integracja` a następnie `Web service - Alikacje`.
23
+
The first step to connect to the API is to generate an `API Key`. To do this, in the administration section, select `Integration` in the left menu and then `Web service - Applications`.
24
24
25
25

26
26
27
-
W celu dodania nowego API Key, wybieramy `Dodaj klucz` z prawej górnej strony.
27
+
To add a new API Key, select `Add Key` from the top right.
28
28
29
29

30
30
31
-
Pojawi nam się okno dodawania nowego API Key:
31
+
A popup window will appear where you can add a new API Key:
32
32
33
33

34
34
35
-
#### Nazwa
35
+
#### Name
36
36
37
-
-dowolna nazwa, pozwlająca nam zidentyfikować dodany API Key
37
+
-any name that allows us to identify the added API Key
38
38
39
-
#### Hasło
39
+
#### Password
40
40
41
-
-ciąg znaków wykorzystywany do uwierzytelniania
41
+
-string of characters used for authentication
42
42
43
43
#### Status
44
44
45
-
-odznaczenie checkboxa, spowoduje, że API Key nie będzie aktywne
45
+
-leaving this checkbox unticked will cause the API to be inactive
46
46
47
-
#### Typ
47
+
#### Type
48
48
49
-
-określa jakich funkcjonalności będzie dotyczył API Key
49
+
-determines what functionalities the API Key will cover
50
50
51
-
#### Dozwolone adresy IP
51
+
#### Allowed IPs
52
52
53
-
-Pusta wartość - dostęp ze wszystkich serwerów.
54
-
Jeśli adresy IP zostaną wprowadzone (po przecinku), to dostęp do API będzie dozwolony tylko z tych adresów IP.
55
-
Przykład: x.x.x.x , y.y.y.y
53
+
-Empty value - access from all servers.
54
+
If IP addresses are entered (after a comma), then API access will be allowed only from these IP addresses.
55
+
Example: x.x.x.x , y.y.y.y
56
56
57
-
#### Publiczny adres URL
57
+
#### Public URL address
58
58
59
-
-Adres URL będzie używany do wysyłania powiadomień mailowych gdzie w treści będzie można używać adresu URL np. reset hasła w Portalu Klienta, link do podglądu rekordu w Portalu Klienta
59
+
-The URL will be used to send email notifications where the URL address can be used in the content, e.g., password reset in the Customer Portal, link to view the record in the Customer Portal
60
60
61
-
### Utworzenie użytkownika
61
+
### Create user
62
62
63
-
Kolejnym krokiem jest utworzenie danych walidacyjnych do API. W tym celu w sekcji administracyjnej z lewym menu wybieramy `Integracja ➞ Web service - Użytkownicy`.
63
+
The next step is to create validation data for the API. To do this, in the administration section from the left menu, select `Integration ➞ Web service - Users`.
64
64
65
65

66
66
67
-
Użytkownika będziemy dodawać dla konkretnego rodzaju usługi, dlatego w pierwszej kolejności wybieramy odpowiednią zakładkę.
67
+
The user will be added for a specific type of service, so first select the relevant tab.
68
68
69
69

70
70
71
-
W celu dodania nowego użytkownika, wybieramy przycisk <kbd>Dodaj rekord</kbd>. Pojawi się nam wówczas okno modalne, w którym będziemy mogli skonfigurować dostępy.
71
+
To add a new user, select the <kbd>Add record</kbd> button. A popup window will then appear, where you can configure credentials.
72
72
73
73

74
74
75
75

76
76
77
-
#### Serwer
77
+
#### Server
78
78
79
-
-wybieramy, API Key, który będzie powiązany z tworzonym użytkownikiem
79
+
-choose the API Key that will be associated with the new user
80
80
81
81
#### Status
82
82
83
-
-określamy, czy dany użytkownik jest aktywny
83
+
-defines if the user is active
84
84
85
-
#### Hasło
85
+
#### Password
86
86
87
-
-ciąg znaków wykorzystywany do autoryzacji
87
+
-string of characters used for authentication
88
88
89
-
#### Typ
89
+
#### Type
90
90
91
-
-podstawa uprawień do rekordów
91
+
-basis for record permissions
92
92
93
-
#### Kontakt
93
+
#### Contact
94
94
95
-
-opcjonalny w zależności od wybranego `Typu` uprawień do rekordów
95
+
-optional depending on the selected `Type` of record permissions
96
96
97
-
#### Profil uprawnień
97
+
#### Permission profile
98
98
99
-
-użytkownik, na którym bazują uprawnienia do akcji i danych
99
+
-permissions for actions and data are based on the selected user
100
100
101
-
#### Metoda uwierzytelniania i Metoda uwierzytelniania 2FA
101
+
#### Authentication Method and 2FA Authentication Method
Po utworzeniu API Key i użytkownika, możemy przystąpić do nawiązania połączenia przez API. Jak to zrobić zostało opisane w tym artykule: [Pierwsze połączenie API](/developer-guides/api/first-connect)
105
+
After creating the API Key and user, you can start connecting via API. How to do that is described in this article: [First API Connection](/developer-guides/api/first-connect)
Copy file name to clipboardExpand all lines: i18n/en/docusaurus-plugin-content-docs/current/4-developer-guides/2-api/1-first-connect.mdx
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title: Pierwsze Połączenie
3
-
description: Jak rozpocząć pierwsze połączenie
2
+
title: First connection
3
+
description: How to establish the first connection
4
4
keywords:
5
5
- Webservice
6
6
- API
@@ -15,39 +15,39 @@ tags:
15
15
preview: request-3.jpg
16
16
---
17
17
18
-
Posiadając już prawidłowo skonfigurowany klucz API i dane uwierzytelniające (zgodnie z instrukcją [konfiguracji](/developer-guides/api/config)), możemy nawiązać połączenie. By pobrać dane z serwera, należy najpierw uzyskać token uwierzytelniający. Poniższa instrukcja wyjaśnia, jak to zrobić.
18
+
Once you have the API key and credentials properly configured (according to the [configuration](/developer-guides/api/config) instructions), you can establish a connection. To retrieve data from the server, you must first obtain an authentication token. The instructions below explain how to do this.
19
19
20
-
## Uzyskiwanie Tokenu uwierzytelniającego
20
+
## Obtain an Authentication Token
21
21
22
-
W celu uzyskania tokenu, wysyłamy do naszego serwera żądanie pod adres:
22
+
To obtain a token, send a request to your server at the following address:
23
23
24
24

25
25
26
-
Do testowania tego procesu można użyć programu `Postman`. Na kolejnych zrzutach ekranu będzie przedstawione krok po kroku, jak to zrobić.
26
+
You can use `Postman` to test this process. The following screenshots will guide you step by step how to do it.
27
27
28
-
W pierwszej kolejności będzie potrzebna wartość `API Key`. By ją pobrać, w sekcji administracyjnej wybierz z lewego menu `Integracja ➞ Web service - aplikacje` a następnie przy interesującym cię kluczu naciśnij przycisk <kbd><iclass="fa-solid fa-copy"></i></kbd> by skopiować jego wartość.
28
+
First, you will need the `API Key` value. To download it, in the administration section, select `Integration ➞ Web service - applications` from the left menu, select the relevant key, and click the <kbd><iclass="fa-solid fa-copy"></i></kbd> button to copy its value.
29
29
30
30

31
31
32
-
W programie `Postman`dodajemy nagłówek`X-API-KEY`. Zamiast wartości `{{APi-KEY}}`wpisujemy wartość API Key skopiowaną z systemu YetiForce.
32
+
In `Postman`add the`X-API-KEY` header. Instead of the `{{APi-KEY}}`value enter the API Key value copied from the YetiForce system.
33
33
34
34

35
35
36
-
Następnie podajemy dane do logowania, zgodnie z poniższym zrzutem ekranu. Zamiast zmiennej `{{URL}}`podajemy adres naszej platformy YetiForce. Dane uwierzytelniające`userName`i`password`wpisujemy zgodnie z wartościami ustalonymi w sekcji administracyjnej w zakładce `Integracja ➞ Web service - użytkownicy`.
36
+
Then enter the credentials, according to the screenshot below. Instead of the `{{URL}}`variable, provide the address of your YetiForce platform. Enter the`userName`and`password`credentials according to the values set in the administration section in the `Integration ➞ Web service - users` tab.
37
37
38
-
W informacji zwrotnej otrzymamy parametr `token`, który będziemy przekazywać w kolejnych requestach.
38
+
You will receive the `token` parameter as feedback, which you will pass in subsequent requests.
39
39
40
40

41
41
42
-
## Kolejne requesty
42
+
## Next requests
43
43
44
-
Po uzyskaniu wartości `token`, możemy przejść do odpytywania API o interesujące nas dane. W tym celu do kolejnych requestów dodajemy nagłówek `x-token`z wartością uzyskanego tokena.
44
+
Once you get the `token` value, you can proceed to query the API for the relevant data. To do this, add the `x-token`header with the value of the obtained token to subsequent requests.
45
45
46
46

47
47
48
-
W zależności od tego, czy mamy wykupioną usługę `WebService Premium`czy też korzystamy z `WebService Standard`, będziemy mieć do dyspozycji inny zakres dostępnych endpointów.
48
+
Depending on whether you have purchased the `WebService Premium`service or use `WebService Standard`, you will have a different range of available endpoints at your disposal.
0 commit comments