DOI API
Format
doi:10.7303/syn<id>.<version>
Where <id> is the entity ID without the "syn" prefix and <version> is the version of the entity. The version is optional. Without version, the DOI always points to the most recent version of the entity.
DOI Status
As it takes time to create and register a DOI, we provide a status field in the DOI data object to track updates. Users can poll the status field for updates. When a call is first made to create a DOI, the status is IN_PROCESS. After the DOI is successfully registered, its status changes to READY. If the creation fails, the status will be updated as ERROR, in which case the client can retry creating the same DOI.
REST APIs
Create
| URL | HTTP Type | Description |
|---|---|---|
| /entity/<entity_id>/doi | PUT | Creates a new DOI for the specified entity. |
| /entity/<entity_id>/version/<version_number>/doi | PUT | Creates a new DOI for the specified entity version. |
Get
| URL | HTTP Type | Description |
|---|---|---|
| /entity/<entity_id>/doi | GET | Gets the DOI status for the specified entity. |
| /entity/<entity_id>/version/<version_number>/doi | GET | Gets the DOI status for the specified entity version. |