ReviewerCredits is continually working to expand functionalities. APIs allow a smoother dataflow for the peer-review process, heeding to the automation of tasks currently performed manually with great benefits in terms of scalabilty, operational time and reduction of human errors.
API (Application Programming Interface)
We developed API (Application Programming Interface) which allows, at first, the automated transferral of peer-review data from publishing platforms; specifications can be found here.
Our APIs are developed following the paradigm of simplicity and uniformity of mature RESTful webservice. More specifically the API are designed to target level 3 of the Richardson Maturity Model (read the Martin Fowler article here). Our API specifications are fully documented using Swagger (https://swagger.io/) allowing easy consultation and testing with the ability to self generate clients for the most used programming languages including PHP, Java, Python, R, Ruby, Node.js and many others.
The latest API released is ARPHA powered by Pensoft. This API allows the data import directly to ReviewerCredits platform as soon as the Journals’ Editor makes his/her final decision on the acceptance/rejection of a submitted manuscript (Accept, Reject or Reject, but resubmission encouraged) in an ARPHA-hosted participating Journals. With this API, the reviewers who had previously agreed to have their review activity registered on ReviewerCredits, will have their contribution automatically submitted to ReviewerCredits.
To activate this service, reviewers need to:
Log in to the Journal’s website with the account they have used to submit their review. This is also their account on the ARPHA system.
Register in the ReviewerCredits system using the pop-up that will automatically appear once they are logged in.
Arpha is just one of the APIs currently under development.
If you are interested in enhancing your systems through our APIs or in suggesting other integrations, please contact us.
Open Journals Systems (OJS) plugin
This plugin allows automated transfer of peer-review data from your Journals to our database enabling a seamless experience to your reviewers. Installing the plugin, Journals will interact automatically with our API. The plugin is released within the OJS plug n gallery, according to the OJS licence rules. The plugin is compatible with OJS 3.x versions. We recommend to register your Journal before installing the plugin.
Unpack the plugin package
Save it in the plugin folder of your OJS installation. The plugin will be added to your OJS plugins page.
Proceed to configure it with your journal credentials for ReviewerCredits.
The plugin connects your journal to ReviewerCredits database using the Reviewer’s ORCID or email address. If a reviewer is not registered on ReviewerCredits it will not be possible to transfer peer review information.
Upon submitting their review (in review step 3), reviewers will find a tick box to agree to the transfer of data to ReviewerCredits.com. Which data is transferred?
- Peer reviewer Email address and ORCID (for matching purposes)
- Manuscript ID
- Peer review due date
- Peer review submission date
Upon successful transfer of data, the reviewer will receive a confirmation pop up message from OJS:
Peer review claim information will be visible in you journal’s page and no further action is required on your part.
If a reviewer is not registered to ReviewerCredits or should the claim transfer fail, a pop up message will be displayed, for example:
In this case the reviewer will be prompted to register his/her review claim manually to the ReviewerCredits service.