Documentación para Desarrolladores
Integre los metadatos editoriales de SIMEH en sus aplicaciones, plataformas y sistemas mediante nuestra API REST. Acceda a catálogos completos en formato JSON o ONIX 3.
Autenticación
Uso de token
SIMEH permite el uso de API para consulta de metadatos y listado de ítems haciendo uso de un token de acceso. El token de acceso es generado y entregado a todos los usuarios de SIMEH que posean una licencia activa.
Para autorizar una solicitud de API, el token de acceso debe enviarse en el encabezado de autorización (bearer authorization header).
Ejemplo de autorización
GET /api/json/products HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Productos — JSON
Listar productos
Retorna un listado paginado de todos los productos de la cuenta con sus referencias e ISBNs.
GET /api/json/products/:page HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| page | Integer | OPCIONAL | Número de la página que se desea navegar. Si el parámetro no se incluye, retornará la primera página de resultados. |
Respuesta
{ "pager": { "totalitems": 47, "totalpages": 7, "currentpage": 1 }, "items": [ { "id": "785e2ffe4518bc902bd117a2a10031ca", "created_at": "2018-10-09 21:09:08", "name": "Título de ejemplo", "references": [ { "format": "print", "recordreference": "SIMEHPRINTH0MPVIH5S93FWKOS66MU", "isbn": [ "9872435126312", "9879265847" ] }, ... ] }, ... ] }
Lista incremental
Permite recuperar los registros que han sido creados o actualizados en las últimas 6 horas desde el momento en que se realiza la solicitud. Ideal para sincronizaciones periódicas.
GET /api/json/productslatest/:page HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| page | Integer | OPCIONAL | Número de la página que se desea navegar. Si el parámetro no se incluye, retornará la primera página de resultados. |
La estructura de la respuesta es idéntica al endpoint de listado general.
Recuperar por RecordReference
Recupera un producto específico utilizando su RecordReference SIMEH — el identificador único asignado a cada versión/formato del producto.
GET /api/json/product/recref/:recordreference HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| recordreference | String | REQUERIDO | Valor de la etiqueta RecordReference asignada a la versión (impreso, e-book o pod) del producto que se desea recuperar. |
Recuperar por ISBN
Recupera un producto específico utilizando su código ISBN.
GET /api/json/product/isbn/:isbncode HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| isbncode | String | REQUERIDO | Código ISBN de la versión (impreso, e-book o pod) del producto que se desea recuperar. |
Respuesta (por referencia o ISBN)
[ { "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": [...] } } ]↓ Descargar formato de respuesta completo (JSON)
Recuperar por Document ID
Recupera un producto específico utilizando el identificador único interno documentid del registro.
GET /api/json/product/doc/:id HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| id | String | REQUERIDO | Identificador único del registro del producto que se desea recuperar (documentid). |
Productos — ONIX 3
La API ONIX retorna directamente la estructura XML del estándar ONIX 3 con los datos completos del producto diligenciados por los usuarios finales.
Recuperar por RecordReference
GET /api/onix/product/recref/:recordreference HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| recordreference | String | REQUERIDO | Valor de la etiqueta RecordReference asignada a la versión (impreso, e-book o pod) del producto. |
Respuesta
Recuperar por ISBN
GET /api/onix/product/isbn/:isbncode HTTP/1.1 Protocol: HTTPS Host: simeh.co Authorization: Bearer ACCESS_TOKEN
Parámetros
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| isbncode | String | REQUERIDO | Código ISBN de la versión (impreso, e-book o pod) del producto que se desea recuperar. |