Skip to content

BeMap Sandbox (1.0.0)

Documentation for the BeMap API, including authentication and routing services.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
MIT
Languages
Servers
Mock server
https://docs.benomad.com/_mock/openapi/
Beta environment
https://bemap-beta.benomad.com/
Preproduction environment
https://bemap-preprod.benomad.com/
Production environment
https://bemap-prod.benomad.com/

Authentication

Operations related to BeMap authentication process

Operations

Routing

Route, isochrone, and matrix computations

Operations

Computes a route through the road network

Request

Performs route, isochrone or matrix calculation based on coordinates and vehicle profile.

Security
basicAuth
Bodyapplication/jsonrequired
destinationsArray of objects(RoutingDest)
routingVehicleProfileobject(RoutingVehicleProf)
routingEnergyVehicleFeatureobject(RoutingEnergyVehicleFeature)
routingSpeedPonderationsArray of objects(RoutingSpeedPond)
routingCriteriasArray of strings
routingModestring
Enum"MODE_VIAS""MODE_MATRIX""MODE_ISOCHRONE""MODE_N_TO_N""MODE_1_TO_N"
outputLanguagestring
Example: "fr"
optionsArray of strings
curl -i -X POST \
  -u <username>:<password> \
  https://docs.benomad.com/_mock/openapi/bgis/service/routing/1.0 \
  -H 'Content-Type: application/json' \
  -d '{
    "destinations": [
      {
        "coordinateSat": {
          "lon": 0,
          "lat": 0
        }
      }
    ],
    "routingVehicleProfile": {
      "transportMode": "CAR",
      "routingVehicleFeature": {
        "height": 0,
        "width": 0,
        "length": 0,
        "weight": 0,
        "axleWeight": 0,
        "adrTunnelCategory": "string",
        "caravan": "string",
        "cial": "string",
        "disEquipped": "string",
        "emissionClass": "string",
        "hazardousMaterials": "string",
        "hov": "string",
        "hybrid": "string",
        "nbPassengers": 0,
        "nbTires": 0,
        "nbTrailAxles": 0,
        "nbTrailer": 0,
        "nbVehAxles": 0,
        "onlyPhysical": true,
        "pollMin": "string",
        "tollTransportCategory": "string",
        "trailHeight": 0,
        "vehHeight": 0,
        "vehWeight": 0
      }
    },
    "routingEnergyVehicleFeature": {
      "auxConsumption": 0,
      "batCapacity": 0,
      "crr": 0,
      "engineEfficiency": 0,
      "payload": 0,
      "recuperation": 0,
      "scx": 0,
      "temperature": 0,
      "userSpeed": 0,
      "windDirection": 0,
      "windSpeed": 0
    },
    "routingSpeedPonderations": [
      {
        "factor": 1,
        "level": 0,
        "pondType": "string",
        "roadType": "string"
      }
    ],
    "routingCriterias": [
      "string"
    ],
    "routingMode": "MODE_VIAS",
    "outputLanguage": "fr",
    "options": [
      "string"
    ]
  }'

Responses

Route successfully calculated. The response includes a set of path segments and metadata such as duration, distance, and waypoints.

Bodyapplication/json
Response
application/json
{
  "route": {
    "duration": 320,
    "distance": 7500,
    "segments": [ … ]
  }
}