Project

General

Profile

Actions

OpenAtlas API

OpenAtlas provides an API which is RESTlike to easily access data entered in OpenAtlas.
A complete overview of possible endpoints and usage is available at our swagger documentation.

Further reading

Versioning

The OpenAtlas API try to follow the REST principles. If breaking changes needed to be done, there will first be a deprecation notice at the OpenAPI documentation and at the JSON outcome. The sunset value of deprecated versions, endpoints and fields will be about 3 releases.

Further reading

Error handling

The OpenAtlas API provides two layers of errors catching. The first layer validates the given parameter of an endpoint. These errors are caught by the "Flask-RESTful": extension, which has it own error handler.
The second layer of errors handles is a self build error model. For more details, please see API Error Handling (depricated)

Links

https://flask-cors.readthedocs.io/

Output format

The standard output format for an entity is based on the LinkedPlacesFormat (LPF) with extensions for OpenAtlas. The other possible JSON format is a simpler GeoJSON format.
OpenAtlas API also supports an RDF output in XML, Pretty-XML, Turtle, Notion 3 and N-Triples. Please note, that these formats are derived from the LPF file and maybe not complete.

Please see API Output Formats for the specifications.

Endpoints

The API can be accessed via the following schema: {domain}/api/{api version}/{endpoint} for example: demo-openatlas.eu/api/0.2/entity/1234

Alternatively, if advanced layout is selected in your profile, a link to the different formats of entities is shown on their info page.
If in the site settings the API option Public is activated (default is off) the API can be used even when not logged in.

Currently, OpenAtlas supports two API version:

Resources

Great Resources on API development:

Updated by Alexander Watzinger 23 days ago · 124 revisions

Also available in: PDF HTML TXT