Once you have downloaded and set up the software, keys and certificates described in PIDs: New system setup, you can begin minting and managing your PIDs! This is predominately done through a HTTP JSON REST API and the programming language of your choice. We also offer some additional tools like a search tool to see if a PID already exists for an object and a bulk upload tool for initial migration.

Handle HTTP JSON REST API

An Application Programming Interface (API) is a document or standard that parties agree to facilitate the communication between them. The handle API follows REST API standards and allows programmatic access to handle resolution using HTTP and returns JSON.

With the HTTP JSON REST API users can:

  • Mint/Create new handles
  • Modify existing handles (e.g. change the reference location, add or remove metadata, etc)
  • Delete handles

Example

Request:

https://hdl.handle.net/api/handles/11112/SURF.82df4163-f7c855ca

Response:

{"responseCode":1,"handle":"11112/SURF.82df4163-f7c855ca","values":[{"index":1,"type":"URL","data":{"format":"string","value":"https://repository.surfsara.nl/community/surf"},"ttl":86400,"timestamp":"2020-03-10T16:06:41Z"},{"index":100,"type":"HS_ADMIN","data":{"format":"admin","value":{"handle":"0.NA/11112","index":200,"permissions":"011111110011"}},"ttl":86400,"timestamp":"2020-03-10T16:06:41Z"}]}

More Information

The Handle API is described in detail in the Handle Tech Manual in chapter 14.

We also provide key information on various implementations on the following pages:

HTTP reverse lookup API

SURF supports searching the handle database for items in handles for handle administrators. We call this a reverse lookup.


See PIDs: Handle reverse lookup.

Bulk upload

SURF supports using the handle tools for an initial bulk upload. And only for an initial upload! This is described in the Handle Tech Manual in chapter 4.


See PIDs: Initial bulk upload using hdl-genericbatch.

Table of contents

  • No labels