Jump to table of contents

Crossref | V1 API Deposit Guide (OJS 2.4.x - 3.1)

PKP and Crossref are collaborating to help publishers and journals using Open Journal Systems take better advantage of Crossref services. In 2019, OJS 3.1.2 took advantage of a newer, more reliable deposit API between Crossref and OJS (the v2 deposit API). This has meant a division in the OJS community between Crossref members using the v1 deposit API and the v2 deposit API. The distinction is as follows:

  • Crossref v1 Deposit API // The Crossref v1 deposit API is employed on all versions of OJS from 3.1.1 and older.
  • Crossref v2 Deposit API // The Crossref v2 deposit API is employed on all versions of OJS from 3.1.2 and newer.

Mostly recently, Crossref have been working towards folding the v2 deposit API into their new REST API. This means that all versions of OJS from 3.1.2 and up will continue to have supported Crossref DOI deposits.

They are unable, however, to accommodate the v1 deposit API into the new REST API. As of July 13th, 2021, the v1 deposit API is deprecated and unsupported - if, during the REST API roll out, the v1 deposit API breaks, Crossref and PKP will be unable to fix the issue.

Solutions #

First and foremost, PKP encourages you to upgrade your OJS instance to at least version 3.1.2 or newer. Please see our upgrading guide.

If you are unable to upgrade and you still need to deposit your DOIs, please note that this deprecated API will only affect the plugin-based deposit. You will still be able to export your Crossref XML and deposit it via the Crossref admin tool at https://doi.crossref.org.