Outbound Manuscript API Documentation
Please find below the technical documentation for the Outbound Manuscript API. Head over to the public documentation space in Postman for more comprehensive details and the ability to run API requests directly in Postman.
Authentication
Bearer Token: Each request must include a valid Bearer token in the Authorization header.
Example:
CODE
-H 'Authorization: Bearer <token>'
Multiple Manuscript API Overview
This endpoint allows users to retrieve the metadata of a range at manuscripts at once.
The API is secured using Bearer tokens and expects data in JSON format.
/api/v1/manuscripts
Endpoint
POST https://{yourDomainName}.jams.pub/api/v1/manuscripts
Path Parameter
|
|
Type |
Required |
Description |
|---|---|---|---|
| journal_short_name | string | No | Filter by journal short name |
| status | string | No | Filter by exact manuscript status id. Example: 'Under Review' |
| volume_number | integer | No | Filter by volume number |
| issue_number | integer | No | Filter by issue number |
| handling_editor | string | No | Filter by assigned handling editor email or name |
| page | integer | No | Page number, default 1 |
| limit | integer | No | Page size, default 50, max 100 |
Single Manuscript API Overview
This endpoint exposes the metadata of a single manuscript by ID, hash key or DOI.
Endpoint
POST https://{yourDomainName}.jams.pub/api/v1/manuscript/{identifier}
Path Parameter
|
|
Type |
Required |
Description |
|---|---|---|---|
| identifier | string | Yes | manuscript ID, hash key, or DOI number |
Endpoint - URL from Metadata
This endpoint allows access to the files of a manuscript through an API.
Endpoint
/api/v1/manuscript/file/{hash_key}/{type}
API under the files object.
Get {file_url} from the files object returned by
GET /api/v1/manuscript/{identifier} .
Recommended terminal download command:
curl -L -OJ -H "Authorization: Bearer your_token_here" "{file_url}"
The -J option makes curl use the filename from the Content-Disposition
response header, e.g. filename="xxxx-1001.pdf" .
Path Parameter
|
|
Type |
Required |
Description |
|---|---|---|---|
| hash_key | string | Yes | manuscript hash_key |
| type | string | Yes | file type returned by the manuscript API, e.g. manuscript, presentation, xml-file, figures, supplementary |