Програмний доступ до даних укриттів
API Schutzraum надає доступ лише для читання до всіх даних укриттів. Потрібен ключ API, який ви можете запросити у своєму обліковому записі.
https://schutzraum.appБудь ласка, використовуйте API відповідально. Надмірні запити можуть бути обмежені.
Усі запити до API потребують дійсний ключ API. Надішліть його як заголовок або параметр запиту:
Як заголовок (рекомендовано):
X-API-Key: dein_api_keyЯк параметр запиту:
/api/shelters?api_key=dein_api_keyКлючі API можна запросити у вашому обліковому записі в розділі 'Ключі API'. Після ручної перевірки ключ буде активовано (зазвичай протягом 48 годин).
Повертає посторінковий список укриттів з можливістю фільтрації. Також підтримує географічну фільтрацію з параметрами lat, lng та radius — географічні запити автоматично сортуються за відстанню та включають поле відстані.
| Параметр | Тип | Обов'язковий | За замовчуванням | Опис |
|---|---|---|---|---|
page | number | Ні | 1 | Page number |
limit | number | Ні | 20 | Items per page (1–10000) |
type | string | Ні | – | Shelter type filter |
city | string | Ні | – | City name (partial match) |
search | string | Ні | – | Search name, city, address |
condition | string | Ні | – | gut, mittel, schlecht, unbekannt |
protection | string | Ні | – | hoch, mittel, niedrig, unbekannt |
wheelchair | boolean | Ні | – | Filter wheelchair accessible |
verified | boolean | Ні | – | Filter verified shelters |
minCapacity | number | Ні | – | Minimum capacity |
sort | string | Ні | name | name, city, capacity, type |
order | string | Ні | asc | asc or desc |
GET /api/shelters?type=bunker&city=Berlin&limit=10
{
"data": [{ "id": "...", "name": "...", "type": "bunker", ... }],
"total": 42,
"page": 1,
"limit": 10,
"totalPages": 5
}Повертає одне укриття за його ID.
GET /api/shelters/24b4e1f0-7723-45a7-bd1c-537a2ff02174
Повертає укриття в заданому радіусі від географічної точки, відсортовані за відстанню.
| Параметр | Тип | Обов'язковий | За замовчуванням | Опис |
|---|---|---|---|---|
lat | number | Так | – | Latitude (–90 to 90) |
lng | number | Так | – | Longitude (–180 to 180) |
radius | number | Ні | 5000 | Radius in meters (100–50000) |
limit | number | Ні | 20 | Max results (1–100) |
type | string | Ні | – | Shelter type filter |
GET /api/shelters/nearby?lat=48.137&lng=11.576&radius=3000
Повертає всі укриття в межах географічної обмежувальної рамки.
| Параметр | Тип | Обов'язковий | За замовчуванням | Опис |
|---|---|---|---|---|
west | number | Так | – | West longitude |
south | number | Так | – | South latitude |
east | number | Так | – | East longitude |
north | number | Так | – | North latitude |
type | string | Ні | – | Shelter type filter |
GET /api/shelters/bbox?west=11.4&south=48.0&east=11.7&north=48.2
Повертає всі укриття у форматі GeoJSON FeatureCollection для відображення на карті.
| Параметр | Тип | Обов'язковий | За замовчуванням | Опис |
|---|---|---|---|---|
type | string | Ні | – | Shelter type filter |
wheelchair | boolean | Ні | – | Filter accessible |
verified | boolean | Ні | – | Filter verified |
minCapacity | number | Ні | – | Minimum capacity |
GET /api/shelters/geojson?type=u_bahn_station&wheelchair=true
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [11.576, 48.137] },
"properties": { "id": "...", "name": "...", "type": "u_bahn_station", ... }
}]
}Параметр типу приймає такі значення:
| Value | Label |
|---|---|
bunker | Бункер |
tiefgarage | Підземний паркінг |
u_bahn_station | Станція метро |
tunnel | Тунель |
keller | Підвал |
hochbunker | Наземний бункер |
tiefbunker | Підземний бункер |
sonstige | Інше |