In last month’s overview of our current API landscape, we introduced the idea of our consolidated REST API, the one place to go to use all DataCite services. As part of this grand consolidation, we’re pleased to say that DOI creation is now available as part of the REST API. We’re calling on all interested early adopters who want to try it out to .

Wait. Didn’t you already have a REST API?

Yes, we did. You’ve already been able to use the REST API for all your metadata-fetching needs for about two years now. Those functions are still available, and they still require no authentication to dig into the publicly available DataCite DOI metadata.

What we’ve now added is the ability to also use the REST API for your DOI creation tasks. DataCite members will now be able to use the same REST API endpoint (https://api.datacite.org), along with their existing credentials, to create and manage their DOIs. Providers are also able to manage prefixes and Clients via the REST API.

So why should I switch?

In the future, the REST API will be the single place to access DataCite services. As we add additional features and services, you’ll be able to access them via the REST API. Eventually, both the EZ API and the MDS API will be phased out, but that won’t be for several more years.

The REST API also offers advantages from a technical perspective. In addition to being able to use just one API for everything (both fetching and creating), you can also create, update, and retrieve DOI metadata using JSON, since the REST API follows the JSONAPI specification. This will make working with the DataCite APIs much easier.

Do I have to switch?

No, you don’t have to switch to the REST API for DOI creation right now. You may continue to use whichever other DataCite API you’re already using. You will eventually need to switch to the REST API, but again, we’re talking in a few years’ time. We know that API transitions take a lot of resources, so we’ll continue to support both the EZ API and the MDS API for quite a while.

However, we want to encourage enthusiastic early adopters to put DOI creation in the REST API through its paces and let us know what tweaks it needs. We’re especially interested to hear from platform integrators as part of our first target audience for the new API.

Sounds great! Where do I sign up?

Those interested in jumping on board the REST API train right away can take a look at our updated REST API Guide for a walkthrough and examples and our updated API Reference for the technical nitty gritty.

If you need any help, you can as always feel free to


Blog Logo

Robin Dasler

DataCite Product Manager

https://orcid.org/0000-0002-4695-7874

Create DOIs with the REST API

https://doi.org/10.5438/s8rt-zv48

History

© 2018 Robin Dasler. Distributed under the terms of the Creative Commons Attribution license.

featured