Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cyrille37/yapafo

Yet Another Php Api For Openstreetmap (read/write with Api, read with XApi or Overpass)
https://github.com/cyrille37/yapafo

api openstreetmap php

Last synced: 2 months ago
JSON representation

Yet Another Php Api For Openstreetmap (read/write with Api, read with XApi or Overpass)

Awesome Lists containing this project

README 

        
# Yet Another Php Api For OpenStreetMap



**yapafo** is a library which permits to authenticate, read and write objects in the OpenStreetMap database.



It's not an user friendly `App` but a tool for processing OSM data ;-)



## FEATURES



- Read (query) objects from **API**, **XAPI** and **Overpass**.

- Write (create, update, delete) objects on **API**.

- Authenticate with **Basic** or **OAuth 2**.

- Class for osm objects are **serializable**.

- A bit of **geometry** stuff are available locally (on query result)

  - is node inside/outside polygon

  - get gravity center for relation or way

- it's for developer, so by default debug is on, it use test API endpoint

- ...



## Installation



- install dependencies

  - `composer install`



## The configuration



By default:

  - API operations are done on Osm developement instance at `master.apis.dev.openstreetmap.org` ;

    - Write operations are carried out in "simulation" mode, so that no queries are made.

  - Overpass queries are done on `overpass-api.de` ;

  - XAPI  queries are done on `overpass-api.de` ;

  - Print some tech message because logger level is Notice.



To overide those default behaviors, create file `.env` and set

  - `simulation = false` to really write on API

  - `osm_api_url = https://api.openstreetmap.org/api/0.6` to query and update on production OSM instance



When developing

  - you can avoid repetitive call to services by activatin the cache

    - `osm_api_cacheFolder = a_folder`

  - you can store in file each out/in from services

    - `outputFolder = a_folder`



Read `.env.example` to know more about configuration.



## Generate an Access Token



The command-line `./vendor/bin/oauth-console.php` will drive you on getting an OAuth2 Access Token, launch it and read the instructions.



The process consists of several stages:

1. choose the OSM server instance

2. choose the permissions you need

3. enter Application ID and Secret

  - if you have to create an Application

  - visit `/oauth2/applications/`

    - for example the test instance https://master.apis.dev.openstreetmap.org/oauth2/applications/

  - create a new Application

    - with redirect to `urn:ietf:wg:oauth:2.0:oob`

    - and needed scopes

    - I don't know about 'confidential' option

4. get an authorization code

5. finally, get the precious Access Token you need to access some services as an authenticated user.



To facilitate the procedure for obtaining the token, a Web page is **currently under construction** at `examples-web/OAuthRequestAccess.php`



## Tuto and examples



### examples-console



Look at the code to learn more abour Yapafo.



### examples-web



Work in progress



## BUG and Discussions



- https://github.com/Cyrille37/yapafo/issues



## REQUIREMENTS



Requirements are covered by `composer.json`.



Php >=7.4 et <8.3.



Php extensions:



- [SimpleXml](https://www.php.net/manual/en/book.simplexml.php)



Php libraries:



- [psr/log](https://github.com/php-fig/log)

- [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv)

- [jbelien/oauth2-openstreetmap](https://github.com/jbelien/oauth2-openstreetmap)

  - which is a provider for [league/oauth2-client](https://github.com/thephpleague/oauth2-client)



## References



- The OAuth 2 Protocol : https://oauth.net/2/ and https://datatracker.ietf.org/doc/html/rfc6749

- OSM OAuth doc : http://wiki.openstreetmap.org/wiki/OAuth

- [PSR-3: Logger Interface](https://www.php-fig.org/psr/psr-3/)