📡 API Reference v1

Developer Documentation

Integrate SIMEH editorial metadata into your applications, platforms, and systems via our REST API. Access complete catalogs in JSON or ONIX 3 format.

🔐 Authentication

Token usage

SIMEH allows the use of an API for querying metadata and listing items using an access token. The access token is generated and delivered to all SIMEH users with an active license.

To authorize an API request, the access token must be sent in the bearer authorization header.

Access token: Available in your SIMEH account panel for all users with an active license (Premium or SIMEH Scientific).

Authorization example

GET /api/json/products HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

📋 Products — JSON

List products

Returns a paginated list of all products in the account with their references and ISBNs.

GET /api/json/products/:page Paginated product list 
GET /api/json/products/:page HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parameters

ParameterTypeRequiredDescription
page Integer OPTIONAL Page number to navigate. If not included, the first page of results will be returned.

Response

{
  "pager": {
    "totalitems": 47,
    "totalpages": 7,
    "currentpage": 1
  },
  "items": [
    {
      "id": "785e2ffe4518bc902bd117a2a10031ca",
      "created_at": "2018-10-09 21:09:08",
      "name": "Example title",
      "references": [
        {
          "format": "print",
          "recordreference": "SIMEHPRINTH0MPVIH5S93FWKOS66MU",
          "isbn": [
            "9872435126312",
            "9879265847"
          ]
        },
        ...
      ]
    },
    ...
  ]
}

Incremental list

Retrieves records that have been created or updated in the last 6 hours from the time the request is made. Ideal for periodic synchronizations.

GET /api/json/productslatest/:page Records updated in the last 6h 
GET /api/json/productslatest/:page HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parameters

ParameterTypeRequiredDescription
page Integer OPTIONAL Page number to navigate. If not included, the first page of results will be returned.

The response structure is identical to the general listing endpoint.

Retrieve by RecordReference

Retrieves a specific product using its SIMEH RecordReference — the unique identifier assigned to each version/format of the product.

GET /api/json/product/recref/:recordreference Product by RecordReference 
GET /api/json/product/recref/:recordreference HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parameters

ParameterTypeRequiredDescription
recordreference String REQUIRED Value of the RecordReference tag assigned to the version (print, e-book or pod) of the product to retrieve.

Retrieve by ISBN

Retrieves a specific product using its ISBN code.

GET /api/json/product/isbn/:isbncode Product by ISBN 
GET /api/json/product/isbn/:isbncode HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parameters

ParameterTypeRequiredDescription
isbncode String REQUIRED ISBN code of the version (print, e-book or pod) of the product to retrieve.

Response (by reference or ISBN)

⚠️ Note: The returned information will vary depending on the data entered by end users.
[
  {
    "documentid": "785e2ffe4518bc902bd117a2a1000aba",
    "created_at": "2018-10-09 14:48:07",
    "updated_at": "2019-01-14 14:51:55",
    "format": "print",
    "publisher": [{ "role": "01", "name": "Test publisher", ... }],
    "cover": {
      "full": "https://simeh.co/resources/image/SOMECODE",
      "large": "https://simeh.co/resources/image/SOMECODE/large",
      "medium": "https://simeh.co/resources/image/SOMECODE/medium",
      "small": "https://simeh.co/resources/image/SOMECODE/small",
      "thumbnail": "https://simeh.co/resources/image/SOMECODE/thumbnail"
    },
    "status": "04",
    "recordreference": "SIMEHPRINT8E9CGHGH708FH91IXXG0",
    "identifier": {
      "isbn13": { "type": "15", "idvalue": "1234567891234" },
      "isbn10": { "type": "02", "idvalue": "1234567890" },
      "doi":   { "type": "06", "idvalue": "10.1002/0470841559.ch1" }
    },
    "title": [
      { "value": "Título en español", "lang": "spa" },
      { "value": "Title in english",  "lang": "eng" }
    ],
    "subtitle": [ ... ],
    "textcontent": [ ... ],
    "contributor": [ ... ],
    "supportingresource": { "images": [...], "files": [...] }
  }
]
↓ Download full response format (JSON)

Retrieve by Document ID

Retrieves a specific product using its unique internal identifier documentid.

GET /api/json/product/doc/:id Product by Document ID 
GET /api/json/product/doc/:id HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parameters

ParameterTypeRequiredDescription
id String REQUIRED Unique identifier of the product record to retrieve (documentid).
⚠️ Note: The response structure is identical to retrieval by ISBN or RecordReference.
↓ Download full response format (JSON)

📦 Products — ONIX 3

The ONIX API directly returns the XML structure of the ONIX 3 standard with the complete product data entered by end users.

Retrieve by RecordReference

GET /api/onix/product/recref/:recordreference ONIX 3 XML by RecordReference 
GET /api/onix/product/recref/:recordreference HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parameters

ParameterTypeRequiredDescription
recordreference String REQUIRED Value of the RecordReference tag assigned to the version (print, e-book or pod) of the product.

Response

Format: XML structure of the ONIX 3 standard with the complete data entered by end users.

Retrieve by ISBN

GET /api/onix/product/isbn/:isbncode ONIX 3 XML by ISBN 
GET /api/onix/product/isbn/:isbncode HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parameters

ParameterTypeRequiredDescription
isbncode String REQUIRED ISBN code of the version (print, e-book or pod) of the product to retrieve.
Format: XML structure of the ONIX 3 standard with the complete data entered by end users.