API – kasy biletowe

To jest dokumentacja dla wersji 2 API. Dokumentacja dla przestarzałej wersji 1.

Informacje o kasach biletowych.

  • Endpoint: GET https://www.zditm.szczecin.pl/api/v2/ticket-offices?format=json|cbor
  • Typ danych: application/json (domyślnie) lub application/cbor (gdy format=cbor)
  • Częstotliwość aktualizacji: w miarę potrzeb

Struktura danych

{
  "data": [
    {
      "id": 26,
      "name": "C.H. Turzyn",
      "type": {
        "symbol": "POK",
        "name": {
          "pl": "Punkt Obsługi Klientów",
          "en": "Passenger Service Point",
          "de": "Kundenberatungsstelle",
          "uk": "Пункт обслуговування клієнтів"
        }
      },
      "address": "najbliższe wejście od ul. 26 Kwietnia",
      "phone": "695690715",
      "note": null,
      "latitude": 53.427471,
      "longitude": 14.53099,
      "monday": {
        "opening_hours": "9:00–19:00",
        "note": null
      },
      "tuesday": {
        "opening_hours": "9:00–19:00",
        "note": null
      },
      "wednesday": {
        "opening_hours": "9:00–19:00",
        "note": null
      },
      "thursday": {
        "opening_hours": "9:00–19:00",
        "note": null
      },
      "friday": {
        "opening_hours": "9:00–19:00",
        "note": null
      },
      "saturday": {
        "opening_hours": "9:00–19:00",
        "note": null
      },
      "sunday": {
        "opening_hours": "10:00–16:00",
        "note": {
          "pl": "tylko niedziele handlowe",
          "en": "only on Sunday trading days",
          "de": "nur verkaufsoffene Sonntage",
          "uk": "тільки по робочих неділях"
        }
      },
      "updated_at": "2023-07-14T16:00:27.000000Z"
    },

    ...

  ]
}
  • int id – identyfikator kasy biletowej
  • string name – nazwa kasy biletowej
  • object type – obiekt zawierający informacje na temat typu kasy biletowej
    • string symbol – symbol typu kasy biletowej
    • object name – obiekt zawierający nazwę typu kasy biletowej
      • string pl – nazwa typu kasy biletowej w języku polskim
      • string en – nazwa typu kasy biletowej w języku angielskim
      • string de – nazwa typu kasy biletowej w języku niemieckim
      • string uk – nazwa typu kasy biletowej w języku ukraińskim
  • string|null address – adres kasy biletowej
  • string|null phone – numer telefonu do kasy biletowej
  • object|null note – obiekt zawierający dodatkowe informacje (wartość null, jeśli wszystkie pola podrzędne zwracają wartość null)
    • string|null pl – dodatkowe informacje w języku polskim
    • string|null en – dodatkowe informacje w języku angielskim
    • string|null de – dodatkowe informacje w języku niemieckim
    • string|null uk – dodatkowe informacje w języku ukraińskim
  • float latitude – współrzędne geograficzne kasy biletowej (szerokość geograficzna)
  • float longitude – współrzędne geograficzne kasy biletowej (długość geograficzna)
  • object monday, object tuesday, object wednesday, object thursday, object friday, object saturday, object sunday – obiekty zawierające informacje o godzinach otwarcia kas biletowych w poszczególne dni tygodnia (poniedziałek, wtorek, środa, czwartek, piątek, sobota, niedziela)
    • string|null opening_hours – godziny otwarcia kasy biletowej
    • object|null note – obiekt zawierający dodatkowe informacje (wartość null, jeśli wszystkie pola podrzędne zwracają wartość null)
      • string|null pl – dodatkowe informacje w języku polskim
      • string|null en – dodatkowe informacje w języku angielskim
      • string|null de – dodatkowe informacje w języku niemieckim
      • string|null uk – dodatkowe informacje w języku ukraińskim
  • string updated_at – moment ostatniej aktualizacji danych

Informacje ogólne

  1. Dane udostępniane są bezpłatnie na licencji CC0 1.0, do wykorzystania w dowolnym celu, a ich użycie nie wymaga wcześniejszego zgłoszenia.
  2. Zarząd Dróg i Transportu Miejskiego w Szczecinie nie gwarantuje, że udostępniane dane są prawidłowe i kompletne. Nie ponosi również odpowiedzialności za szkody lub niewłaściwe decyzje podjęte na ich podstawie.
  3. W produkcie korzystającym z danych (aplikacja, strona internetowa, publikacja itp.) prosimy o podanie źródła danych, tj. Zarząd Dróg i Transportu Miejskiego w Szczecinie lub – w formie skróconej – ZDiTM Szczecin, ale nie jest to wymóg prawny.
  4. W produkcie korzystającym z danych (aplikacja, strona internetowa, publikacja itp.) prosimy o – jeżeli jest to możliwe – umieszczenie odsyłacza do niniejszej strony lub do strony głównej, ale nie jest to wymóg prawny.
  5. Klient powinien rozpoznawać i honorować nagłówki HTTP Cache-Control i ETag.
  6. Liczba żądań do API jest limitowana. Limit jest wspólny dla wszystkich endpointów i wynosi 100 żądań na minutę na adres IP. Nagłówek X-RateLimit-Remaining zawiera liczbę żądań pozostałych w ramach dostępnego limitu. Po wyczerpaniu limitu zwracany jest kod odpowiedzi HTTP 429. Nagłówek odpowiedzi X-RateLimit-Reset zawiera wówczas uniksowy timestamp równy czasowi zresetowania limitu, a nagłówek Retry-After zawiera liczbę sekund pozostałych do zresetowania limitu.
  7. Jeżeli to możliwe, prosimy o umieszczenie w nagłówku User-Agent żądania informacji o podmiocie korzystającym z danych (np. nazwa aplikacji, strony internetowej, adres URL).
  8. W przypadku nadmiernego obciążania serwera ZDiTM Szczecin zastrzega sobie prawo do częściowego lub całkowitego zablokowania dostępu do API.

Migracja z wersji 1

  1. Endpoint zmieniono na: GET https://www.zditm.szczecin.pl/api/v2/ticket-offices.
  2. Pola type_symbol, type_name_pl, type_name_en, type_name_de i type_name_uk zostały przeniesione do nowego obiektu type.
  3. Pola notes_pl, notes_en, notes_de i notes_uk zostały przeniesione do nowego obiektu note.
  4. Pola notes_pl, notes_en, notes_de i notes_uk w obiektach monday, tuesday, wednesday, thursday, friday, saturday i sunday zostały przeniesione do nowego obiektu note.
  5. Obsługiwany jest dodatkowo format CBOR (application/cbor) poprzez parametr format=cbor.