Wprowadzenie

To API umożliwia zewnętrznym aplikacjom pobieranie listy miast obsługiwanych przez system przesyłek miejskich.

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 listy miast

Zwraca listę dostępnych miast, dla których możliwe jest nadawanie i odbiór przesyłek.

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

Endpoint:

GET /pricing/cities

Przykładowe żądania (cURL)

curl -X GET "https://api.przesylkamiejska.pl/v1/pricing/cities"

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


// Pobranie listy miast dostępnych w cenniku
fetch('https://api.przesylkamiejska.pl/v1/pricing/cities')
    .then(response => response.json())
    .then(data => console.log(data)) // wynik w konsoli
    .catch(error => console.error('Error:', error));
    

Opis

Metoda zwraca tablicę miast, w których świadczona jest usługa przesyłek miejskich.

Przykładowa odpowiedź (JSON)

{
    "cities": [
        {
            "name": "Trójmiasto",
            "slug": "3city",
            "cities": [
                "Gdynia",
                "Sopot",
                "Gdańsk"
            ]
        },
        {
            "name": "Bydgoszcz\/Toruń",
            "slug": "btom",
            "cities": [
                "Bydgoszcz",
                "Toruń"
            ]
        }
    ]
}

Wskazówki i uwagi

  • W przypadku pytań lub zgłoszeń błędów prosimy o kontakt z administratorem.