DataCite

DataCite REST API

The REST API is used for all API interactions with DataCite services.

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The REST API is used for all API interactions with DataCite services.

Endpoints 34

activities

  • GETGet a JSON API result of activities./activities
  • GETGet a JSON API result of a specific activity./activities/:id

client-prefixes

  • GETReturn a list of client-prefixes./client-prefixes

clients

  • GETReturn a list of clients (repositories)./clients
  • GETReturn clients DOI production statistics./clients/totals
  • GETReturn a client./clients/:id
  • GETReturn activities for a specific client./clients/:id/activities

dois

  • GETReturn a list of DOIs./dois
  • POSTAdd a new DOI./dois
  • GETReturn a DOI./dois/:id
  • PUTUpdate a DOI./dois/:idPUT requests to the /dois endpoint will update a DOI record if it already exists and create a new record if the DOI name is not already taken.
  • DELETEDelete a DOI (for DOIs in draft state only)./dois/:id
  • GETReturn activities for a specific DOI./dois/:id/activities

events

  • GETReturn a list of events./events
  • GETReturn an event./events/:id

heartbeat

  • GETReturn the current status of the REST API./heartbeat

prefixes

  • GETReturn a list of prefixes./prefixes
  • GETReturn prefixes DOI production statistics./prefixes/totals
  • GETReturn a prefix./prefixes/:id

provider-prefixes

  • GETReturn a list of provider-prefixes./provider-prefixes

providers

  • GETReturn a list of providers (including members and consortium organizations)./providers
  • GETReturn providers DOI production statistics./providers/totals
  • GETReturn a provider./providers/:id
  • GETReturn activities for a specific provider./providers/:id/activities

reports

  • GETA JSON array of reports./reports
  • POSTAdd a new report./reports
  • GETReturn a report./reports/:id
  • PUTUpdate a report./reports/:id

repositories

  • POSTAdd a new repository./repositories
  • PUTUpdate a repository./repositories/:id
  • DELETEDelete a repository (only possible if no DOIs are in the repository)/repositories/:id

credentials

  • GETReturn a list of API keys for the authenticated repository account./credentials/api-keys
  • POSTCreate a new API key for the authenticated repository account./credentials/api-keys
  • DELETERevoke an API key for the authenticated repository account./credentials/api-keys/:id

API details

Base URL
https://api.test.datacite.org
https://api.datacite.org
Authentication
HTTP Basic authentication (username and password)
A bearer token in the Authorization header
Operations
34 operations on 27 pathsGET 24POST 4PUT 3DELETE 3
Main resources
dois 6activities 5clients 4providers 4reports 4credentials 3prefixes 3repositories 3events 2client-prefixes 1
Response formats
application/vnd.api+json text/plain
Description format
OpenAPI 3.0.0, API version 2.3.0

How to test the DataCite REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the DataCite REST API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get a JSON API result of activities.” (GET /activities), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the DataCite REST API?

The REST API is used for all API interactions with DataCite services. It is listed under Data & analytics and has 34 endpoints.

Who publishes the DataCite REST API?

It is listed from DataCite's public API description (an OpenAPI document), not published by DataCite on Swastik Codes. Anyone who controls datacite.org can claim the profile by adding a DNS TXT record.

What is the base URL of the DataCite REST API?

Its description lists 2 base URLs: https://api.test.datacite.org, https://api.datacite.org. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the DataCite REST API?

It accepts 2 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header.

How many endpoints does the DataCite REST API have?

34 operations on 27 paths (24 GET, 4 POST, 3 PUT, 3 DELETE). The largest groups are dois, activities, clients, providers.

Is forking the DataCite REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.