jens-na/osrm-api-client

API client for the OSRM project

Overview

osrm-api-client is a an open source PHP implementation of the OSRM Server API., _(*1)

, _(*2)

Features

• viaroute (computation of the shortest path on the road network between two coordinates)
• locate (nearest node of the road network)
• nearest (nearest point on any street segment of the road network)

Installation

To add osrm-api-client as a locally per-project dependency you can insert the following code to your composer.json file:, _(*3)

{
    "require": {
        "jens-na/osrm-api-client": "dev-master"
    }
}

API Usage Policy

If you are using the server router.project-osrm.org with this API client, please read the API Usage Policy of Project-OSRM., _(*4)

Usage

viaroute

$client = new Osrm\OsrmClient('http://server:5000');
$from = new Osrm\Coordinate(50.142739,9.122257);
$to = new Osrm\Coordinate(50.139631,9.107151);
$route = $client->getRoute($from, $to);

locate

$client = new Osrm\OsrmClient('http://server:5000');
$mylocation = new Osrm\Coordinate(9.305283, 50.344735);
$nearestStreet = $client->getNearestNodePoint($mylocation);

nearest

$client = new Osrm\OsrmClient('http://server:5000');
$mylocation = new Osrm\Coordinate(9.305283, 50.344735);
$nearestStreet = $client->getNearestStreetPoint($mylocation);

References

• OSRM Server API
• OSRM Json Output
• OSRM Turn instructions
• OSRM API Usage Policy

License and Copyright

Licensed under the GNU General Public License 3., _(*5)

(c) Jens Nazarenus, 2013, _(*6)