JAMS APIs - Inbound Manuscript

Please find below the technical documentation of the Inbound Manuscript native JAMS API. Head over to the public documentation space in Postman for more comprehensive details and the ability to run API requests directly in Postman.

Inbound Manuscript/Metadata API endpoint

This API allows the upload of manuscript metadata and creation of a new manuscript submission in JAMS. The API is secured using Bearer tokens and expects data in JSON format.

Authentication

Bearer Token: Each request must include a valid Bearer token in the Authorization   header.

Example:

-H 'Authorization: Bearer <your-token>'

Endpoint

POST https://{yourDomainName}.jams.pub/api/inbound_manuscript

Request Headers

Request Body

The request body must include a single parameter data  , which contains a JSON string. Below is the schema and description of the required and optional fields:

JSON Parameters

Nested Objects

• authors

• included_reviewers and excluded_reviewers

Example Parameters

{
  "data": "{
    "title": "This is a test title", 
    "submit_user": "test@tenant.com", 
    "authors": [{
      "first_name": "user1 first name",
      "last_name": "user1 last name",
      "corresponding": true,
      "email": "testauthor1@email.com"
    }], 
    "journal_name": "Example Journal", 
    "article_type": "Research Article", 
    "number_of_pages": 10, 
    "abstract": "This is the abstract.", 
    "keywords": "science;research;innovation" 
  }"
}

Example Request

curl -X 'POST'
  'https://{yourDomainName}.jams.pub/api/inbound_manuscript'
  -H 'accept: application/json'
  -H 'Authorization: Bearer 1c17d390dcbf73bb4628a68e32eae5a8'
  -H 'Content-Type: multipart/form-data'
  -F 'data={
    "title":"This is a test title",
    "submit_user":"test@tenant.com",
    "authors": [{
      "first_name": "user1 first name",
      "last_name": "user1 last name",
      "corresponding": true,
      "email": "testauthor1@email.com"
    }], 
    "journal_name":"Test Journal",
    "article_type":"Article",
    "number_of_pages":10,
    "abstract":"This is a test abstract.",
    "keywords":"science;research;innovation"
  }'

Responses

Success Response

Example:

{
  "status": "200",
  "message": "The metadata was uploaded successfully. Please copy the hash_key and use the Inbound Manuscript/Files API endpoint to upload the manuscript files.",
  "hash_key": "89d53617da30aec93fbc986bec23bf04"
}

Error Responses

General Errors

Field-Specific Errors

Notes

1. Token: Ensure the provided Bearer token is valid.
2. Validation Rules: The API enforces strict validation rules. Ensure all fields meet the described criteria.
3. Debugging: If issues persist, check the server logs or contact support for further assistance.

Inbound Manuscript/Files API endpoint

This API allows users to upload manuscript-related files using a hash key generated from the inbound_manuscript/metadata   API. The API is secured using Bearer tokens.

Authentication

Bearer Token: Each request must include a valid Bearer token in the Authorization   header.

Example:

-H 'Authorization: Bearer <your-token>'

Endpoint

POST https://{yourDomainName}.jams.pub/api/inbound_manuscript/file  

Request Headers

Request Boday

The request body must include the following parameters:

Example Request

curl -X 'POST' \
  'https://ucl.jams-staging.pub/api/inbound_manuscript/file' \
  -H 'Authorization: Bearer <your-token>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'hash_key=89d53617da30aec93fbc986bec23bf04' \
  -F 'manuscript_file=@/path/to/manuscript.zip' \
  -F 'presentation_file=@/path/to/presentation.pdf' \
  -F 'graphical_file=@/path/to/graphical.png'

Responses

Success Responses

Example:

{
  "status": "200",
  "message": "The manuscript file was uploaded successfully."
}

Error Responses

General Errors

Field-Specific Errors

Notes:

1. Token: Ensure the provided Bearer token is valid.
2. Validation Rules: The API enforces strict validation rules. Ensure all fields meet the described criteria.
3. File Size Limit: Files must not exceed the server’s allowed size.
4. Debugging: If issues persist, check the server logs or contact support for further assistance.