وثائق API

الوصول إلى بيانات الملاجئ برمجياً

توفر واجهة Schutzraum API وصولاً للقراءة فقط إلى جميع بيانات الملاجئ. يلزم وجود مفتاح API، يمكنك طلبه في حسابك.

عنوان URL الأساسيhttps://schutzraum.app

يرجى استخدام API بشكل مسؤول. قد يتم تقييد الطلبات المفرطة.

المصادقة

تتطلب جميع طلبات API مفتاح API صالحاً. أرسله كترويسة أو معامل استعلام:

كترويسة (مُوصى به):

X-API-Key: dein_api_key

كمعامل استعلام:

/api/shelters?api_key=dein_api_key

يمكن طلب مفاتيح API في حسابك تحت 'مفاتيح API'. بعد المراجعة اليدوية، سيتم تفعيل المفتاح (عادةً خلال 48 ساعة).

GET/api/shelters

يعيد قائمة مرقّمة من الملاجئ مع إمكانية التصفية. يدعم أيضاً التصفية الجغرافية باستخدام معاملات 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/:id

يعيد ملجأ واحداً بواسطة معرّفه.

مثال

GET /api/shelters/24b4e1f0-7723-45a7-bd1c-537a2ff02174

GET/api/shelters/nearby

يعيد الملاجئ ضمن نطاق محدد من نقطة جغرافية، مرتبة حسب المسافة.

المعامل	النوع	مطلوب	افتراضي	الوصف
`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

GET/api/shelters/bbox

يعيد جميع الملاجئ ضمن مربع جغرافي محيط.

المعامل	النوع	مطلوب	افتراضي	الوصف
`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

GET/api/shelters/geojson

يعيد جميع الملاجئ كمجموعة معالم 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`	أخرى

المصادقة

تتطلب جميع طلبات API مفتاح API صالحاً. أرسله كترويسة أو معامل استعلام:

كترويسة (مُوصى به):

X-API-Key: dein_api_key

كمعامل استعلام:

/api/shelters?api_key=dein_api_key

يمكن طلب مفاتيح API في حسابك تحت 'مفاتيح API'. بعد المراجعة اليدوية، سيتم تفعيل المفتاح (عادةً خلال 48 ساعة).

المعامل

النوع

مطلوب

افتراضي

الوصف

page

number

لا

Page number

limit

number

لا

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

المعامل

النوع

مطلوب

افتراضي

الوصف

lat

number

نعم

–

Latitude (–90 to 90)

lng

number

نعم

–

Longitude (–180 to 180)

radius

number

لا

5000

Radius in meters (100–50000)

limit

number

لا

Max results (1–100)

type

string

لا

–

Shelter type filter

المعامل

النوع

مطلوب

افتراضي

الوصف

west

number

نعم

–

West longitude

south

number

نعم

–

South latitude

east

number

نعم

–

East longitude

north

number

نعم

–

North latitude

type

string

لا

–

Shelter type filter

المعامل

النوع

مطلوب

افتراضي

الوصف

type

string

لا

–

Shelter type filter

wheelchair

boolean

لا

–

Filter accessible

verified

boolean

لا

–

Filter verified

minCapacity

number

لا

–

Minimum capacity

{ "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

أخرى