Project

General

Profile

Actions

API Whitepaper

Issue: #1050

To make it easier for other application to use data from OpenAtlas directly we plan to implement an API (application programming interface).

There are already some use cases:

  • THANADOS OpenAtlas presentation software, developed by Stefan Eichert
  • ARCHE (for long time archiving), developed by ACDH-CH
  • Pelagios

Purpose

Main purpose is the automatic data exchange between systems via URLs.

  • All API request will include "api" after the domain URL e.g. demo.openatlas.eu/api/0.1/1234 for one entity or demo.openatlas.eu/api/0.1/actors for a list of entities
  • There will be multiple formats available (e.g. RDFS, JSON, XML)
  • First step is to get basic information of an entity via including the entity id in the URL
  • Next step will be to get (most) associated information e.g. information about super and sub entities, related entities like actors, events, ...
  • Finally it should be possible to get all the information needed for e.g. OpenAtlas frontend presentation software, either especially developed or with a generic parameterized URL solution

Since the API should be very stable (additions are ok but no interface changes for possible other systems already using it) we will take some time to plan it in detail.

Resources

Great Resources on API development:

Ideas

Meeting Questions:

  • The Linked Places field names (https://github.com/LinkedPasts/linked-places#names-required) requires at least one citation of the toponym name. Is it really required for our purpose? We can't provide a Gazetteer link or citation so it is not reasonable.
  • Depictions Licenses, how to get the cc: namespace? We will make something like, if the string contains "cc" followed by "by" then add cc: in front of the name.

Todo:

Development: Administration:
  • Error Handling:
    • refactor error codes in redmine
    • Describe error codes in manual
  • Make a list, what features the API 0.1 contains

Updated by Bernhard Koschicek 3 months ago · 24 revisions

Also available in: PDF HTML TXT