Skip to content
An application to wrap up APIs for accessing UKWA content.
Python CSS HTML JavaScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
access_api
api-data
integration-testing
test/data
.gitignore
Dockerfile
LICENSE
README.md
api.py
api_out_of_use.py
docker-compose.yml
gunicorn.ini
requirements.txt

README.md

UKWA Access API

This Flask RESTPlus application acts as a front-end for our access-time API services.

APIs

All APIs are documented using Swagger, and the system includes Swagger UI. e.g. when running in dev mode, you can go to:

http://localhost:5000/

and you'll get a UI that describes the APIs. (This may not be directly visible in production, i.e. when running behind a proxy.)

Currently, it provides the ARK and URL resolution services.

ARK Resolver

This looks up ARKs in a simple text file. See api-data/arks.txt for an example.

<ARK> <TIMESTAMP> <URL>

It just maps an ARK to a timestamp and URL, which is then passed to the Wayback Resolver.

The file should be generated from W3ACT in a separate process, see python-shepherd for details.

Wayback Resolver

This takes the timestamp and URL of interest, and redirects to the appropriate Wayback instance.

Development & Deployment

For development, you can run it (in a suitable virtualenv) using:

$ pip install -f requirements.txt
$ python api.py

For testing/production, it's designed to run under Docker, using gunicorn as the runtime engine.

You can’t perform that action at this time.