osrm-api-client's Introduction

Overview

osrm-api-client is a an open source PHP implementation of the OSRM Server API.

###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:

{
    "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. 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);