A simple ARK NAAN resolver service.
ARKR is a minimalist ARK NAAN resolver service that supports redirection to registered NAAN targets or introspection (inflection) of a NAAN public record.
Requires a JSON copy of the NAAN public registry information, such as produced
by naan_reg_json.
To run ARKR locally, setup your python virtual environment then:
pip install -r backend/requirements.txt
Retrieve the NAAN records as json (currently requires a local copy of main_naans):
python ../naan_reg_json/naan_reg_json.py -p -f backend/naans ../naan_reg_priv/main_naans
Then run the service:
cd backend
uvicorn main:app
The service may be deployed to any service supporting python WSGI such as Vercel. For example:
vercel deploy
An example of the service running on Vercel is available at: https://arkr.vercel.app/
| Path | Description |
|---|---|
/docs |
API documentation |
/diag/{IDENTIFIER} |
Presents some diagnostics of request processing. E.g. diag/ark:/12148/bpt6k10733944 |
/{IDENTIFIER} |
Redirects to supplied ARK. * /ark:/12148/bpt6k10733944 * /ark:12148/bpt6k10733944 * /12148/bpt6k10733944 |
/{NAAN}[/][?? | ?info] |
Returns metadata about the NAAN. Note that if characters beyond a terminating "/" are included then the response is a redirect to the registered location with the provided inflection request. * /ark:/12148/?info * /ark:12148?? * /12148/?info |