Przejdź do treści

Stan usługi

GET /

tylko alleelimit: read

Bez tokenu. Do monitoringu: 200 i bieżący czas (UTC).

Zgodność: tylko allee.
Uwierzytelnienie: brak.

Odpowiedzi

200 API działa. · ServiceStatus
status string zawsze
Wartości: ok
api string zawsze
Wartości: allee
czas string · date-time zawsze

Bieżący czas serwera (UTC).

Błędy

HTTPKodZnaczenie
500INTERNAL_ERRORBłąd serwera allee.
Sprawdzenie, czy API działa
curl -sS -X GET "${ALLEE_API_URL:-https://api.allee.pl}/" \
  -H "Accept: application/vnd.allegro.public.v1+json" \
  -w '\nHTTP %{http_code}\n'
Odpowiedź (środowisko testowe)
HTTP 200 application/vnd.allegro.public.v1+json
{
  "status": "ok",
  "api": "allee",
  "czas": "2026-11-10T11:10:02Z"
}

Specyfikacja OpenAPI 3.1

GET /openapi.json

tylko alleelimit: read

Ten dokument — opis wszystkich operacji, schematów, błędów, zakresów i limitów w formacie OpenAPI 3.1 (z przykładami kodu x-codeSamples w 7 językach). Zaimportuj go do Postmana, Insomnii albo generatora klientów (openapi-generator).

Bez tokenu. ETag + If-None-Match → 304; gzip, gdy klient go przyjmuje. Ten sam plik jest w portalu dla deweloperów.

Zgodność: tylko allee.
Uwierzytelnienie: brak.

Odpowiedzi

200 Specyfikacja. · object
304 Bez zmian (If-None-Match).

Błędy

HTTPKodZnaczenie
429TOO_MANY_REQUESTSPrzekroczony limit (minutowy, grupy operacji albo IP).
500INTERNAL_ERRORBłąd serwera allee.
503NOT_DEPLOYEDFunkcja jeszcze nie uruchomiona (np. sandbox, wsady).
Pobranie specyfikacji OpenAPI do pliku
curl -sS -X GET "${ALLEE_API_URL:-https://api.allee.pl}/openapi.json" \
  -H "Accept: application/json" \
  -o openapi.json -w 'HTTP %{http_code}\n'
Odpowiedź (środowisko testowe)
HTTP 200 application/json; charset=utf-8
(plik openapi.json: 2602539 B, application/json; charset=utf-8)

Dokumentacja (przekierowanie)

GET /docs

tylko alleelimit: read

301 na portal dla deweloperów: https://allee.pl/dla-deweloperow/

Zgodność: tylko allee.
Uwierzytelnienie: brak.

Odpowiedzi

301 Przekierowanie na portal.

Błędy

HTTPKodZnaczenie
500INTERNAL_ERRORBłąd serwera allee.
Przykład
curl -sS -X GET "${ALLEE_API_URL:-https://api.allee.pl}/docs" \
  -H "Accept: text/html" \
  -w '\nHTTP %{http_code}\n'
Odpowiedź (środowisko testowe)
HTTP 301 text/html; charset=UTF-8
(0 B: text/html; charset=UTF-8)