API — маршрути

Це документація для версії 2 API. Документація для застарілої версії 1.

Інформація про маршрути громадського транспорту.

  • Endpoint: GET https://www.zditm.szczecin.pl/api/v2/lines?format=json|cbor
  • Формат даних: application/json (за замовчуванням) або application/cbor (коли format=cbor)
  • Частота оновлення: за потребою

Структура даних

{
  "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 — унікальний ідентифікатор маршруту (незмінний)
  • string number — позначення маршруту (номер) (може змінюватися)
  • string type — тип маршруту:
    • DAY — денний маршрут
    • NIGHT — нічний маршрут
  • string subtype — підтип маршруту:
    • NORMAL — звичайний маршрут
    • SEMI_FAST — напівшвидкісний маршрут
    • FAST — швидкісний маршрут
    • REPLACEMENT — заміщаючий маршрут
    • ADDITIONAL — додатковий маршрут
    • SPECIAL — спеціальний маршрут
    • TOURIST — туристичний маршрут
  • string vehicle_type — тип рухомого складу:
    • SKM — потяг SKM
    • TRAM — трамвай
    • BUS — автобус
  • bool on_demand — true, якщо маршрут працює за системою «за викликом»
  • bool highlighted — true, якщо маршрут виділено помаранчевим кольором у пасажирських матеріалах (змінений маршрут або заміщаючий)
  • int sort_order — порядковий номер для впорядкованого відображення маршрутів (номери не обов’язково послідовні)
  • string updated_at — мітка часу останнього оновлення даних

Загальна інформація

  1. Дані надаються безкоштовно за ліцензією CC0 1.0, для будь‑якого використання без попереднього погодження.
  2. Zarząd Dróg i Transportu Miejskiego w Szczecinie (Управління доріг і міського транспорту в Щецині) не гарантує правильність чи повноту даних і не несе відповідальності за можливі збитки чи помилкові рішення на їх основі.
  3. У продуктах (додатках, веб‑сайтах, публікаціях тощо) рекомендується вказувати джерело даних як «Zarząd Dróg i Transportu Miejskiego w Szczecinie» або скорочено «ZDiTM Szczecin» (не є обов’язковим).
  4. За можливості бажано додати посилання на цю сторінку або на головну сторінку ZDiTM Szczecin (не є юридично обов’язковим).
  5. Клієнти повинні розпізнавати й дотримуватися HTTP‑заголовки Cache-Control та ETag.
  6. Кількість запитів до API обмежена: 100 запитів на хвилину з однієї IP‑адреси для всіх endpointів. Заголовок X-RateLimit-Remaining показує кількість залишкових запитів. Після вичерпання ліміту повертається код HTTP 429. У відповідному заголовку X-RateLimit-Reset вказано Unix‑мітку часу скидання ліміту, а Retry-After — кількість секунд до скидання.
  7. Якщо можливо, додайте в заголовок User-Agent інформацію про організацію чи додаток, що використовує дані (наприклад, назву або URL).
  8. У разі надмірного навантаження на сервер ZDiTM Szczecin залишає за собою право частково або повністю блокувати доступ до API.

Міграція з версії 1

  1. Endpoint змінено на: GET https://www.zditm.szczecin.pl/api/v2/lines.
  2. Для полів type, subtype і vehicle_type змінився формат значень, що повертаються — тепер вони повертаються у форматі UPPER_SNAKE_CASE.
  3. Додатково підтримується формат CBOR (application/cbor) через параметр format=cbor.