API – linie

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

Informacje o liniach komunikacji miejskiej.

  • Endpoint: GET https://www.zditm.szczecin.pl/api/v2/lines?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": 1,
      "number": "1",
      "type": "DAY",
      "subtype": "NORMAL",
      "vehicle_type": "TRAM",
      "on_demand": false,
      "highlighted": false,
      "sort_order": 1,
      "updated_at": "2024-07-24T08:58:15.000000Z"
    },

    ...

  ]
}
  • int id – identyfikator linii (niezmienny)
  • string number – oznaczenie (numer) linii (może ulegać zmianom)
  • string type – typ linii:
    • DAY – linia dzienna
    • NIGHT – linia nocna
  • string subtype – podtyp linii:
    • NORMAL – linia zwykła
    • SEMI_FAST – linia przyspieszona
    • FAST – linia pospieszna
    • REPLACEMENT – linia zastępcza
    • ADDITIONAL – linia dodatkowa
    • SPECIAL – linia specjalna
    • TOURIST – linia turystyczna
  • string vehicle_type – rodzaj trakcji:
    • SKM – pociąg SKM
    • TRAM – tramwaj
    • BUS – autobus
  • bool on_demand – wartość true, jeśli linia funkcjonuje w ramach systemu transportu na żądanie
  • bool highlighted – wartość true, jeśli linia wyróżniona jest na materiałach informacji pasażerskiej pomarańczowym kolorem (kursuje na zmienionej trasie lub jest linią zastępczą)
  • int sort_order – liczba porządkowa ułatwiająca prezentację linii w sposób posortowany (numeracja zwracana w tym polu nie musi mieć zachowanej ciągłości)
  • 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/lines.
  2. Dla pól type, subtype i vehicle_type zmienił się format zwracanych wartości – są one zwracane w konwencji UPPER_SNAKE_CASE.
  3. Obsługiwany jest dodatkowo format CBOR (application/cbor) poprzez parametr format=cbor.