Dokumentacja API Ver. 1.0.d.5

Wprowadzenie

To API umożliwia pobranie listy dzielnic dla wskazanego miasta, aby klient mógł wybrać dokładną lokalizację nadania lub odbioru przesyłki.

API jest publiczne i nie wymaga autoryzacji. Prosimy o odpowiedzialne korzystanie i unikanie nadmiernej liczby zapytań. Nie stosujemy throttlingu, natomiast wszystkie próby użycia API są 👀 rejestrowane.

Endpoint: Pobieranie dzielnic miasta

Zwraca listę dzielnic przypisanych do danego miasta na podstawie podanego identyfikatora (slug) miasta.

URL -> https://api.przesylkamiejska.pl/v1/

Endpoint:

GET /pricing/districts/{citySlug}/{cityName}

Parametry URL (Path Parameters)

• {citySlug} (wymagany, string): Skrócona nazwa miasta, np. "3city", "btom".
• {cityName} (wymagany, string): Nazwa miasta, np. "Gdynia", "Sopot".

Przykładowe żądania (cURL)

curl -X GET "https://api.przesylkamiejska.pl/v1/pricing/districts?citySlug=3city&cityName=Gdynia"

Przykładowe żądanie (JavaScript - Fetch API)

// Pobranie listy dzielnic dla miasta Gdańsk
fetch('https://api.przesylkamiejska.pl/v1/pricing/districts?citySlug=3city&cityName=Gdynia')
    .then(response => response.json())
    .then(data => console.log(data)) // wynik w konsoli
    .catch(error => console.error('Error:', error));
    

Opis

Metoda zwraca tablicę dzielnic przypisanych do wybranego miasta.

Przykładowa odpowiedź (JSON)

{
    "allowed": [
        "Centrum",
        "Chełm",
        "Dąbrowa",
        "Kamienny Potok",
        "Karwiny",
        "Morena"
        ... (inne dzielnice, które są obsługiwane)
    ],
    "excluded": [
        "Babie Doły",
        "Chwarzno",
        "Kokoszki",
        "Krakowiec"
        ... (inne dzielnice, które nie są obsługiwane)
    ]
}