Fahrtenbuch

Geocoding

GET
/geocoding/search

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

q*string
Length2 <= length
lang?string
Default"de"
limit?integer
Rangevalue <= 50
Default10

Response Body

Suchergebnisse

Example Request
curl -X GET 'https://example.com/api/v1/geocoding/search?q=string'
Example Response200
Empty
GET
/geocoding/reverse

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

lat*number
Range-90 <= value <= 90
lon*number
Range-180 <= value <= 180
lang?string
Default"de"

Response Body

Adresse beziehungsweise Ort

Example Request
curl -X GET 'https://example.com/api/v1/geocoding/reverse?lat=-90&lon=-180'
Example Response200
Empty
POST
/geocoding/route-path

Für den Fahrt-Editor: verbindet die Punkte in ihrer Reihenfolge. Abstände über gapMeters (Standard 250 m) werden über den Routing-Dienst entlang der Straße gefüllt, höchstens 60 Lücken. Jeder zusätzliche Punkt lenkt die Route. Eine Lücke, die der Dienst nicht routen kann, bleibt eine gerade Linie (failedGaps).

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
gapMeters?number
Range50 <= value <= 100000
points*array<>
Items2 <= items <= 20000

Response Body

Pfad

application/json
  1. response
provider?string
Value in"atlas""valhalla""osrm"
distanceMeters?integer
gapCount?integer
routedGaps?integer
failedGaps?integer
uTurnGaps?integer

Abschnitte

correctedGaps?integer

Davon per Map-Matching korrigiert

maxGaps?integer
path?array<>
Example Request
curl -X POST 'https://example.com/api/v1/geocoding/route-path' \  -H 'Content-Type: application/json' \  -d '{  "points": [    {      "lat": 0,      "lon": 0    },    {      "lat": 0,      "lon": 0    }  ]}'
Example Response
{  "provider": "atlas",  "distanceMeters": 0,  "gapCount": 0,  "routedGaps": 0,  "failedGaps": 0,  "uTurnGaps": 0,  "correctedGaps": 0,  "maxGaps": 0,  "path": [    {      "lat": 0,      "lon": 0,      "index": 0    }  ]}
GET
/geocoding/route

Berechnet die Autostrecke zwischen zwei Koordinaten über den eingerichteten Map-Matching-Dienst (Atlas, Valhalla oder OSRM), z. B. für manuell angelegte Fahrten. Ob ein Dienst eingerichtet ist, steht in GET /config/services unter routing.enabled.

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

fromLat*number
Range-90 <= value <= 90
fromLon*number
Range-180 <= value <= 180
toLat*number
Range-90 <= value <= 90
toLon*number
Range-180 <= value <= 180

Response Body

Strecke

application/json
  1. response
provider*string
Value in"atlas""valhalla""osrm"
distanceMeters*integer
durationSeconds?integer|null
Example Request
curl -X GET 'https://example.com/api/v1/geocoding/route?fromLat=-90&fromLon=-180&toLat=-90&toLon=-180'
Example Response
{  "provider": "atlas",  "distanceMeters": 0,  "durationSeconds": 0}
GET
/geocoding/nearby

Die API erzeugt die Overpass-QL-Abfrage selbst. Freie Abfragen durch Clients sind nicht erlaubt.

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

lat*number
Range-90 <= value <= 90
lon*number
Range-180 <= value <= 180
category*string
Value in"sight""restaurant""hotel""park""fuel""parking""supermarket""charging_station""hospital""pharmacy"

Response Body

POI-Ergebnisse

Example Request
curl -X GET 'https://example.com/api/v1/geocoding/nearby?lat=-90&lon=-180&category=sight'
Example Response200
Empty