README.md

Open Route Service - Interface for the ORS API v6

PHP package to help geocode addresses and calculate distances using the Open Route Service API.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Requirements

PHP 7.1+

Before being able to use the API, consequently this package as well, you need to create an account with Open Route Service and request an API key.
Please visit their official website in order to do so: https://open-route-service.org

Check out the plan page as well to aknowledge the limitations: https://openrouteservice.org/plans

Installation

Install this package with composer by simply adding the following to your composer.json file:

"repositories": [
    {
        "url": "https://github.com/FrancoisChaumont/open-route-service.git",
        "type": "git"
    }
]

and running the following command:

composer require francoischaumont/open-route-service:3.*

Requires a file named api.key at the root which contains the API key in order to run.

Testing

A tests file is provided under the tests folder to give an overall idea how to use this library. Not intented to be run.

Built with

• Visual Studio Code

Authors

• Francois Chaumont - Initial work - FrancoisChaumont

See also the list of contributors who particpated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Notes