Autenticación

Uso de token

SIMEH permite el uso de API para consulta de metadatos y listado de items 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

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

Productos

JSON

Listar

Definición

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

Parámetros

page:[optional] Integer => Número de la página que se desea navegar. Si el parámetro no se encuentra, 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

Esta API permite recuperar los registros que han sido creados o actualizados en las últimas 6 horas desde el momento en que se realiza la solicitud.

Definición

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

Parámetros

page:[optional] Integer => Número de la página que se desea navegar. Si el parámetro no se encuentra, retornará la primera página de resultados.

Respuesta

Recuperar por referencia

Definición

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

Parámetros

recordreference:[required] String => Valor de la etiqueta RecordReference asignada a la versión (impreso, e-book o pod) del producto que se desea recuperar.

Recuperar por ISBN

Definición

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

Parámetros

isbncode:[required] String => Código ISBN de la versión (impreso, e-book o pod) del producto que se desea recuperar.

Respuesta para los casos de recuperación de producto por referencia o ISBN

Nota
La información retornada variará según los datos diligenciados por los usuarios finales.

[
{
"documentid": "785e2ffe4518bc902bd117a2a1000aba",
"created_at": "2018-10-09 14:48:07",
"updated_at": "2019-01-14 14:51:55",
"format": "print",
"publisher": [
{
"role": "01",
"roleonixlist": "45",
"id": "6168a09b4a9e9406d9a2d135aa0024a8",
"name": "Test publisher"
},
...
],
"cover": {
"full": "http://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"
},
"supportingresource": {
"images": [
{
"contenttype": "02",
"contenttypeonixlist": "158",
"resourcemode": "03",
"resourcemodeonixlist": "159",
"name": "564b3926cXXX88821d8b45a1",
"mimetype": "image/jpeg",
"uri": {
"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"
}
},
...
],
"files": [
{
"contenttype": "15",
"contenttypeonixlist": "158",
"resourcemode": "01",
"resourcemodeonixlist": "159",
"name": "real_sociedad",
"mimetype": "image/jpeg",
"uri": "https://url.example/miscfiles/asd_zxc_qwe.jpg"
},
...
]
},
"status": "04",
"statusonixlist": "64",
"recordreference": "SIMEHPRINT8E9CGHGH708FH91IXXG0",
"identifier": {
"isbn13": {
"type": "15",
"typeonixlist": "5",
"idvalue": "1234567891234"
},
"isbn10": {
"type": "02",
"typeonixlist": "5",
"idvalue": "1234567890"
},
"doi": {
"type": "06",
"typeonixlist": "5",
"idvalue": "10.1002/0470841559.ch1"
},
"otheridentifier": [
{
"type": "01",
"typeonixlist": "5",
"idvalue": "7698697876"
},
...
]
},
"title": [
{
"value": "Título en español",
"lang": "spa"
},
{
"value": "Title in english",
"lang": "eng"
},
...
],
"subtitle": [
{
"value": "Subtítulo en español",
"lang": "spa"
},
{
"value": "Subtitle in english",
"lang": "eng"
},
...
],
"textcontent": [
{
"type": "02",
"typeonixlist": "153",
"audience": "00",
"audienceonixlist": "154",
"content": {
"spa": "Descripción corta"
}
},
...
],
"contributor": [
{
...
},
...
]

Descargue completo el formato de respuesta

Recuperar por DOCUMENTID

Definición

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

Parámetros

id:[required] String => Identificador único del registro del producto que se desea recuperar.

Respuesta para los casos de recuperación de producto por referencia o ISBN

Nota
La información retornada variará según los datos diligenciados por los usuarios finales.

Descargue completo el formato de respuesta

ONIX

Recuperar por referencia

Definición

GET /api/onix/product/recref/:recordreference HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parámetros

recordreference:[required] String => Valor de la etiqueta RecordReference asignada a la versión (impreso, e-book o pod) del producto que se desea recuperar.

Respuesta

Estructura XML de estandar ONIX 3 con los datos diligenciados por los usuarios finales.

Recuperar por ISBN

Definición

GET /api/onix/product/isbn/:isbncode HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parámetros

isbncode:[required] String => Código ISBN de la versión (impreso, e-book o pod) del producto que se desea recuperar.

Respuesta

Estructura XML de estandar ONIX 3 con los datos diligenciados por los usuarios finales.