📡 API Reference v1

Documentação para Desenvolvedores

Integre os metadados editoriais do SIMEH em suas aplicações, plataformas e sistemas através da nossa API REST. Acesse catálogos completos em formato JSON ou ONIX 3.

🔐 Autenticação

Uso do token

O SIMEH permite o uso de API para consulta de metadados e listagem de itens utilizando um token de acesso. O token é gerado e entregue a todos os usuários com licença ativa.

Para autorizar uma solicitação de API, o token de acesso deve ser enviado no cabeçalho de autorização (bearer authorization header).

Token de acesso: Disponível no painel da sua conta SIMEH para todos os usuários com licença ativa (Premium ou SIMEH Científico).

Exemplo de autorização

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

📋 Produtos — JSON

Listar produtos

Retorna uma lista paginada de todos os produtos da conta com suas referências e ISBNs.

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

Parâmetros

ParâmetroTipoObrigatórioDescrição
page Integer OPCIONAL Número da página que se deseja navegar. Se não incluído, retornará a primeira página.

Resposta

{
  "pager": {
    "totalitems": 47,
    "totalpages": 7,
    "currentpage": 1
  },
  "items": [
    {
      "id": "785e2ffe4518bc902bd117a2a10031ca",
      "created_at": "2018-10-09 21:09:08",
      "name": "Título de exemplo",
      "references": [{ "format": "print", "recordreference": "SIMEHPRINT...", "isbn": [...] }]
    }
  ]
}

Lista incremental

Recupera os registros criados ou atualizados nas últimas 6 horas. Ideal para sincronizações periódicas.

GET /api/json/productslatest/:page Registros atualizados nas últimas 6h 
GET /api/json/productslatest/:page HTTP/1.1
Protocol: HTTPS
Host: simeh.co
Authorization: Bearer ACCESS_TOKEN

Parâmetros

ParâmetroTipoObrigatórioDescrição
page Integer OPCIONAL Número da página. Se não incluído, retornará a primeira página.

A estrutura da resposta é idêntica ao endpoint de listagem geral.

Recuperar por RecordReference

Recupera um produto específico pelo seu RecordReference SIMEH — identificador único de cada versão/formato.

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

Parâmetros

ParâmetroTipoObrigatórioDescrição
recordreference String OBRIGATÓRIO Valor da etiqueta RecordReference da versão (impresso, e-book ou pod) do produto.

Recuperar por ISBN

Recupera um produto específico pelo seu código ISBN.

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

Parâmetros

ParâmetroTipoObrigatórioDescrição
isbncode String OBRIGATÓRIO Código ISBN da versão (impresso, e-book ou pod) do produto.

Resposta (por referência ou ISBN)

⚠️ Nota: As informações retornadas variarão conforme os dados preenchidos pelos usuários finais.
[
  {
    "documentid": "785e2ffe4518bc902bd117a2a1000aba",
    "created_at": "2018-10-09 14:48:07",
    "updated_at": "2019-01-14 14:51:55",
    "format": "print",
    "cover": { "full": "https://simeh.co/resources/image/SOMECODE", ... },
    "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 em português", "lang": "por" }],
    "subtitle": [ ... ],
    "textcontent": [ ... ],
    "contributor": [ ... ],
    "supportingresource": { "images": [...], "files": [...] }
  }
]
↓ Baixar formato de resposta completo (JSON)

Recuperar por Document ID

Recupera um produto específico pelo identificador único interno documentid.

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

Parâmetros

ParâmetroTipoObrigatórioDescrição
id String OBRIGATÓRIO Identificador único do registro (documentid) do produto a recuperar.
⚠️ Nota: A estrutura de resposta é idêntica à recuperação por ISBN ou RecordReference.
↓ Baixar formato de resposta completo (JSON)

📦 Produtos — ONIX 3

A API ONIX retorna diretamente a estrutura XML do padrão ONIX 3 com os dados completos preenchidos pelos usuários finais.

Recuperar por RecordReference

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

Parâmetros

ParâmetroTipoObrigatórioDescrição
recordreference String OBRIGATÓRIO Valor da etiqueta RecordReference da versão (impresso, e-book ou pod) do produto.
Formato: Estrutura XML do padrão ONIX 3 com os dados completos preenchidos pelos usuários finais.

Recuperar por ISBN

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

Parâmetros

ParâmetroTipoObrigatórioDescrição
isbncode String OBRIGATÓRIO Código ISBN da versão (impresso, e-book ou pod) do produto.
Formato: Estrutura XML do padrão ONIX 3 com os dados completos preenchidos pelos usuários finais.