osrmroute
Sənədləşdirmə

Xəritə, axtarış və Studio API-ləri

Xəritə və məkan məlumatları ilə yaradın

Autentifikasiya və xətalar

Açarı Authorization: Bearer başlığında göndərin. Koordinatlar [uzunluq, enlik] formatındadır. OSRMROUTE_API_KEY dəyişənini lokal təyin edin; dataset sorğusu üçün DATASET_ID sahib olduğunuz datasetin UUID-si olmalıdır. Studio açarını brauzer kodunda göstərməyin.

401: açar yoxdur və ya yanlışdır · 403: icazə yoxdur · 402: kredit çatmır · 429: sorğu limiti · 502/503: mənbə xidməti əlçatmazdır. Cavabı istifadə etməzdən əvvəl HTTP statusunu yoxlayın; uğursuz ödənişli əməliyyatın rezerv krediti azad edilir.

409: revision ziddiyyəti. Yenidən cəhd etməzdən əvvəl son resursu oxuyun və dəyişiklikləri uyğunlaşdırın.

Məkan detalları

Axtarış nəticəsindəki mənbə atributlarını oxuyun.

Sorğu kreditləri
1
Tələb olunan icazələr
places

places icazəsi ilə 1 kredit. Axtarış nəticəsinin ID-si üzrə OpenStreetMap obyektini oxuyur; mənbə keşi 1 saatdır. Telefon, sayt, iş saatları və əlçatanlıq yoxdursa null qalır. Mənbə vaxtı obyektin redaktə tarixidir, biznesin təsdiqi deyil. Canlı açıq/bağlı statusu yoxdur. Açar üçün 20 sorğu/dəq; keşdə olmayan mənbə sorğuları ümumi 30/dəq.

POST /api/v1/places/details

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
id *stringmaxLength: 24
cURL
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/places/details" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"osm:N:123"}'
Cavab
place.details.phone
place.details.website
place.details.opening_hours
place.details.wheelchair
place.details.observed_at
place.details.source_updated_at
place.details.open_now: null

Mətnlə stil önizləməsi

Rəng və qat dəyişikliklərini yazın, xəritəyə baxıb tətbiq edin.

Sorğu kreditləri
0
Tələb olunan icazələr
studio

Nöqtəli vergüllə ayrılmış ingilis əmrləri: hazır stil, hex rəng və qat görünməsi. Önizləmə saxlamır və yayımlamır; Tətbiq et mövcud qaralama və avtomatik saxlama axınına keçir.

POST /api/v1/studio/preview

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
prompt *stringmaxLength: 1000
aibooleandefault: false
designobject
cURL
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/studio/preview" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"dark; water #123456; hide buildings"}'
Cavab
design
changes[]
saved: false
method: explicit_style_commands

Static Maps API

Hesabat və tətbiqlər üçün üslublu xəritələri PNG kimi ixrac edin.

Sorğu kreditləri
4
Tələb olunan icazələr
maps

Dörd palitra: light, dark, navigation və minimal. Şəkil ölçüsü 128–512 px, zoom 1–14. Sadələşdirilmiş render mənbə qeydini saxlayır; xüsusi Studio qatları və effektləri göstərilmir.

POST /api/v1/maps/static

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
center *array
zoomintegermin: 1 · max: 14 · default: 12
widthintegermin: 128 · max: 512 · default: 512
heightintegermin: 128 · max: 512 · default: 512
stylestringlight | dark | navigation | minimal
cURL
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/maps/static" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"center":[13.405,52.52],"zoom":12,"width":512,"height":512,"style":"light"}' \
  --output map.png
Cavab
Content-Type: image/png

Dataset Query API

Yüklədiyiniz coğrafi datasetlərdə yaxın obyektləri tapın.

Sorğu kreditləri
1
Tələb olunan icazələr
maps

Yalnız açar sahibinin datasetləri əlçatandır. Radius 0–50 000 m, limit 1–50. Nəticə yaxın nöqtələr və təxmini lokal məsafədir; yol məsafəsi və tam ilkin həndəsə deyil. Boş uğurlu nəticə də 1 kreditdir.

POST /api/v1/maps/datasets/{id}/query

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
point *array
radiusnumbermin: 0 · max: 50000 · default: 0
limitintegermin: 1 · max: 50 · default: 10
cURL
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/maps/datasets/$DATASET_ID/query" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"point":[2.3522,48.8566],"radius":1000,"limit":10}'
Cavab
type: FeatureCollection
features[].geometry.type: Point
features[].properties
returned

Search Along Route API

Marşrut boyunca dayanacaqları və əlavə sürüş vaxtını müqayisə edin.

Sorğu kreditləri
14
Tələb olunan icazələr
places + route

200 km-dək avtomobil marşrutları. Beş nöqtədə axtarış və ən çox səkkiz əlavə yol hesablanır; axtarış tam əhatəli deyil. Kateqoriyalar: fuel, charging_station, restaurant, cafe, parking, pharmacy. Canlı trafik və şarj mövcudluğu yoxdur.

POST /api/v1/places/along-route

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
start *array
end *array
category *stringfuel | charging_station | restaurant | cafe | parking | pharmacy
max_detour_secondsnumbermin: 0 · max: 1800 · default: 600
limitintegermin: 1 · max: 8 · default: 5
cURL
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/places/along-route" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"start":[13.405,52.52],"end":[13.3777,52.5163],"category":"cafe","max_detour_seconds":600,"limit":5}'
Cavab
places[]
baseline.duration_seconds
baseline.distance_meters
discovery
duration_model

Structured Geocoding API

Küçə, şəhər, poçt indeksi və ölkə ilə ünvan axtarın.

Sorğu kreditləri
1
Tələb olunan icazələr
geocode

street, city və ya postcode verin. Ölkə kodu iki hərf, digər sahələr ən çox 100 simvoldur. Sahələr mətn axtarışına çevrilir. matched/different/missing müqayisəsi və mənbə dəqiqliyi ünvanın təsdiqi deyil.

POST /api/v1/search/structured

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
housenumberstringmaxLength: 100
streetstringmaxLength: 100
citystringmaxLength: 100
statestringmaxLength: 100
postcodestringmaxLength: 100
countrycodestringmaxLength: 2
cURL
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/search/structured" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"street":"Friedrichstraße","city":"Berlin","countrycode":"DE"}'
Cavab
features[].id
features[].address
features[].precision
features[].match.components
features[].precision_basis
search_method: composed_address_query

Suggest & Retrieve API

Təkliflər və təhlükəsiz nəticə əldəetmə ilə məkan axtarışı yaradın.

Sorğu kreditləri
1 + 1
Tələb olunan icazələr
geocode

Hər suggest və retrieve sorğusu 1 kreditdir. Sorğu 1–200 simvol. Token 10 dəqiqəyə bitir və açar sahibinə bağlıdır. Retrieve yeni axtarış deyil, imzalanmış təklifin saxlanmış nəticəsini qaytarır.

POST /api/v1/search/suggest

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
q *stringmaxLength: 200

POST /api/v1/search/retrieve

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
token *stringmaxLength: 16384
cURL
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/search/suggest" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q":"Paris"}'
Cavab
suggestions[].id
suggestions[].name
suggestions[].address
suggestions[].token
expires_in_seconds: 600

retrieve → place, retrieval: signed_suggestion_snapshot
cURL · retrieve
curl --fail-with-body -X POST "https://osrmroute.com/api/v1/search/retrieve" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"token":"TOKEN_FROM_SUGGEST"}'

Studio API

Tətbiqinizdən xəritə stillərini, datasetləri və nəşri idarə edin.

Sorğu kreditləri
0
Tələb olunan icazələr
studio

Limitsiz açarlarda da ayrıca studio icazəsi tələb olunur. GET stilləri və ya dataset metadatasını siyahılayır; POST idarə edir. Stillərdə revision və nəşr təsdiqi var. Dataset yaratmaq/silmək olar, yerində redaktə edilmir. Limit: açar başına dəqiqədə 30 oxuma və ya 5 yazma; iş sahəsi kvotaları tətbiq olunur.

GET / POST /api/v1/studio/{resource}

Sorğunun gövdəsi — * işarəli sahələr məcburidir.
action *string
idstring
revisioninteger
namestringmaxLength: 80
designobject
dataobject
confirmPublicboolean
confirmDeleteboolean
versioninteger
cURL
curl --fail-with-body "https://osrmroute.com/api/v1/studio/styles" \
  -H "Authorization: Bearer $OSRMROUTE_API_KEY"
Cavab
GET styles → styles[]
GET datasets → datasets[]
Studio əməliyyatları
styles · createname, design
styles · save / autosaveid, revision, name, design
styles · duplicateid, revision, name
styles · restoreid, revision, version
styles · publishid, revision, confirmPublic: true
styles · unpublish / deleteid, revision
datasets · createname, data: GeoJSON FeatureCollection
datasets · deleteid, confirmDelete: true
POST /api/v1/studio/styles · application/json
{
  "action": "create",
  "name": "Berlin",
  "design": {
    "preset": "light",
    "colors": {
      "land": "#f1f3f5",
      "water": "#a9d8ed",
      "park": "#c9dfc6",
      "road": "#ffffff",
      "highway": "#edc779",
      "building": "#d9dee3",
      "label": "#334155"
    },
    "visible": {
      "roads": true,
      "buildings": true,
      "parks": true,
      "labels": true,
      "pois": true,
      "boundaries": true
    },
    "center": [
      13.405,
      52.52
    ],
    "zoom": 11,
    "overlays": []
  }
}
POST /api/v1/studio/datasets · application/json
{
  "action": "create",
  "name": "Paris places",
  "data": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "properties": {
          "name": "Paris"
        },
        "geometry": {
          "type": "Point",
          "coordinates": [
            2.3522,
            48.8566
          ]
        }
      }
    ]
  }
}
Dəstək komandası

OSRMRoute Dəstək

Komandamıza birbaşa yazın

KÖMƏK ÜÇÜN BURADAYIQ

Sizə necə kömək edək?

İnteqrasiya, ödəniş və ya hesabınız barədə yazın. Cavablarımız bu söhbətdə görünəcək.

Sizin çatlarınız

Çatlarınız burada görünəcək.