allegro / allegro/allegro-api

[NEWS] Do końca czerwca 2026 zaimplementuj własny, niestandardowy identyfikator User-Agent w Twojej aplikacji / Implement your own custom User-Agent in your app by the end of June 2026

Open
#13,126 47 comments 0 reactions 1 assignee Claimed by @Lukasz-Zurek View on GitHub
News
Dominant language
No language data
Stars
244
Forks
40
PR merge metrics
No merged PRs in 30d

Description

Zgodnie z art. 3.4(c) [Regulaminu REST API](https://developer.allegro.pl/rules), udzielenie autoryzacji na rzecz Oprogramowania REST API wymaga zastosowania rozwiązań technicznych pozwalających na **wiarygodną i jednoznaczną identyfikację Twojej aplikacji**.

W związku z powyższym **do końca czerwca 2026** skonfiguruj własny, niestandardowy User-Agent.

**Co to jest User-Agent?**

W kontekście API, User-Agent to nagłówek HTTP, który jest przesyłany przez klienta (aplikację wysyłającą żądanie) do serwera. Nagłówek User-Agent służy aplikacjom zewnętrznym do rozpoznania typu programu klienckiego.

#### **Dlaczego wprowadzamy wymóg implementacji własnego identyfikatora User-Agent?**

Chcemy umożliwić naszym systemom monitorującym:

* precyzyjną identyfikację źródła ruchu,

* ścieżkę kontaktu z właścicielem aplikacji bezpośrednio na poziomie analizy logów serwerowych, co minimalizuje ryzyko prewencyjnego blokowania adresu IP aplikacji w przypadku wykrycia niestandardowej aktywności.

**Co musisz zrobić?**

Skonfiguruj identyfikator User-Agent zgodnie z poniższą strukturą:

* **Identyfikacja aplikacji:** Pierwszy człon musi zawierać unikalną nazwę systemu/aplikacji oraz aktualną wersję produkcyjną (np. `TestApplication/1.1.0`). Nazwa musi być spójna z nazwą [zarejestrowanej](https://apps.developer.allegro.pl/) aplikacji.

* **Adres URL:** Musisz wskazać dedykowaną stronę informacyjną lub repozytorium, gdzie administratorzy zewnętrzni mogą zapoznać się z celem działania aplikacji (np. `+https://firma.com/TestApplication-info`).

**Przykładowa struktura identyfikatora User-Agent:**

`NazwaAplikacji/Wersja (+AdresURL\_Dokumentacji)`

Prawidłowo skonfigurowany nagłówek powinien przyjąć postać:

`TestApplication/1.1.0 (+https://firma.com/TestApplication-info)`

**Ważne!** Nie modyfikuj zawartości nagłówka User-Agent, ponieważ będzie on używany jako czynnik umieszczania na białej liście.

--------

According to paragraph 3.4.c of the [REST API Terms & Conditions](https://developer.allegro.pl/rules), granting authorization for REST API Software requires the use of technical solutions enabling reliable and unambiguous identification of the REST API Software.

Therefore, configure your own custom User-Agent **by the end of June 2026**.

**What is User-Agent?**

In the context of APIs, User-Agent is an HTTP header sent by the client (the application sending the request) to the server. The User-Agent header is used by external applications to recognize the type of client program.

**Why are we introducing the requirement to implement your own User-Agent identifier?**

We want to enable our monitoring systems to:

* precisely identify the source of associated traffic,

* have an established path to contact the application owner directly through server log analysis, which minimizes the risk of preventively blocking the application's IP address if unusual activity is detected.

**What do you need to do?**

Configure the User-Agent identifier according to the following structure:

* **Application Identification**: The first part must contain a unique system/application name and the current production version (e.g. `TestApplication/1.1.0`). The name must be consistent with the [registered application](https://apps.developer.allegro.pl/) name.

* **URL address**: You must specify a dedicated information page or repository where external administrators can learn about the application's purpose (e.g. `+https://firma.com/TestApplication-info`).

**Example User-Agent structure:**

`ApplicationName/Version (+DocumentationURL)`

A properly configured header should look like this:

`TestApplication/1.1.0 (+https://firma.com/TestApplication-info)`

**Important!** Do not modify the content of the User-Agent header, as it will be used as a whitelisting factor.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.