دسترسی برنامه‌نویسی به داده‌های پناهگاه‌ها
API اسکوتسراوم دسترسی فقط‌خواندنی به تمام داده‌های پناهگاه‌ها را فراهم می‌کند. یک کلید API لازم است که می‌توانید آن را در حساب کاربری خود درخواست کنید.
https://schutzraum.appلطفاً از API به صورت مسئولانه استفاده کنید. درخواست‌های بیش از حد ممکن است محدود شوند.
تمام درخواست‌های API به یک کلید API معتبر نیاز دارند. آن را به عنوان هدر یا پارامتر جستجو ارسال کنید:
به عنوان هدر (توصیه شده):
X-API-Key: dein_api_keyبه عنوان پارامتر جستجو:
/api/shelters?api_key=dein_api_keyکلیدهای API را می‌توانید در حساب کاربری خود در بخش 'کلیدهای API' درخواست کنید. پس از بررسی دستی، کلید فعال خواهد شد (معمولاً ظرف ۴۸ ساعت).
فهرست صفحه‌بندی‌شده‌ای از پناهگاه‌ها با فیلتر اختیاری برمی‌گرداند. همچنین از فیلتر جغرافیایی با پارامترهای 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
}یک پناهگاه را بر اساس شناسه آن برمی‌گرداند.
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 برای نمایش روی نقشه برمی‌گرداند.
| پارامتر | نوع | الزامی | پیش‌فرض | توضیحات |
|---|---|---|---|---|
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 | سایر |