Skip to content

Commit fefa606

Browse files
committed
Merge remote-tracking branch 'origin/release' into release
2 parents eb5a5aa + 2754c56 commit fefa606

File tree

3 files changed

+51
-51
lines changed

3 files changed

+51
-51
lines changed
-14.7 KB
Loading
Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Configuration
3-
description: Jak prawidłowo skonfigurować API w YetiForce
3+
description: How to properly configure API in YetiForce
44
keywords:
55
- Webservice
66
- API
@@ -16,90 +16,90 @@ preview: configuration-1.jpg
1616

1717
## Configuration
1818

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.
2020

21-
### Generowanie API Key
21+
### Generate API Key
2222

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`.
2424

2525
![step 1](configuration-1.jpg)
2626

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.
2828

2929
![step 2](configuration-2.jpg)
3030

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

3333
![step 3](configuration-3.jpg)
3434

35-
#### Nazwa
35+
#### Name
3636

37-
- dowolna nazwa, pozwlająca nam zidentyfikować dodany API Key
37+
- any name that allows us to identify the added API Key
3838

39-
#### Hasło
39+
#### Password
4040

41-
- ciąg znaków wykorzystywany do uwierzytelniania
41+
- string of characters used for authentication
4242

4343
#### Status
4444

45-
- odznaczenie checkboxa, spowoduje, że API Key nie będzie aktywne
45+
- leaving this checkbox unticked will cause the API to be inactive
4646

47-
#### Typ
47+
#### Type
4848

49-
- określa jakich funkcjonalności będzie dotyczył API Key
49+
- determines what functionalities the API Key will cover
5050

51-
#### Dozwolone adresy IP
51+
#### Allowed IPs
5252

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
5656

57-
#### Publiczny adres URL
57+
#### Public URL address
5858

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
6060

61-
### Utworzenie użytkownika
61+
### Create user
6262

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`.
6464

6565
![step 4](configuration-4.jpg)
6666

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.
6868

6969
![step 5](configuration-5.jpg)
7070

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.
7272

7373
![step 6](configuration-6.jpg)
7474

7575
![step 7](configuration-7.jpg)
7676

77-
#### Serwer
77+
#### Server
7878

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
8080

8181
#### Status
8282

83-
- określamy, czy dany użytkownik jest aktywny
83+
- defines if the user is active
8484

85-
#### Hasło
85+
#### Password
8686

87-
- ciąg znaków wykorzystywany do autoryzacji
87+
- string of characters used for authentication
8888

89-
#### Typ
89+
#### Type
9090

91-
- podstawa uprawień do rekordów
91+
- basis for record permissions
9292

93-
#### Kontakt
93+
#### Contact
9494

95-
- opcjonalny w zależności od wybranego `Typu` uprawień do rekordów
95+
- optional depending on the selected `Type` of record permissions
9696

97-
#### Profil uprawnień
97+
#### Permission profile
9898

99-
- użytkownik, na którym bazują uprawnienia do akcji i danych
99+
- permissions for actions and data are based on the selected user
100100

101-
#### Metoda uwierzytelniania i Metoda uwierzytelniania 2FA
101+
#### Authentication Method and 2FA Authentication Method
102102

103-
- określa szczegóły odnośnie uwierzytelniania użytkownika
103+
- specifies the details for user authentication
104104

105-
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)

i18n/en/docusaurus-plugin-content-docs/current/4-developer-guides/2-api/1-first-connect.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Pierwsze Połączenie
3-
description: Jak rozpocząć pierwsze połączenie
2+
title: First connection
3+
description: How to establish the first connection
44
keywords:
55
- Webservice
66
- API
@@ -15,39 +15,39 @@ tags:
1515
preview: request-3.jpg
1616
---
1717

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.
1919

20-
## Uzyskiwanie Tokenu uwierzytelniającego
20+
## Obtain an Authentication Token
2121

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:
2323

2424
![request 1](request-1.jpg)
2525

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.
2727

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><i class="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><i class="fa-solid fa-copy"></i></kbd> button to copy its value.
2929

3030
![api_key](api_key.jpg)
3131

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.
3333

3434
![request 2](request-2.jpg)
3535

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.
3737

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.
3939

4040
![request 3](request-3.jpg)
4141

42-
## Kolejne requesty
42+
## Next requests
4343

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.
4545

4646
![request 4](request-4.jpg)
4747

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.
4949

50-
### Lista Endpointów dla poszczególnych usług
50+
### List of Endpoints for services
5151

5252
- [Webservice Standard](/developer-guides/api/WebserviceStandard)
5353
- [Webservice Premium](/developer-guides/api/WebservicePremium)

0 commit comments

Comments
 (0)