Introdução

A RestAPI do MercadoEditorial.org permite a consulta de metadados, adição e atualização de informações de livros.

Essa é a versão 1.0 da API, divulgada oficialmente em 10 de agosto de 2016.

Documentos, Coleções e Métodos

Basicamente, há apenas um tipo de conteúdo manipulável na versão v.1 da API do MercadoEditorial.org, que são os livros. Outros conteúdos, como Editoras, podem ser requisitados por métodos específicos, mas não atualizados pela API.

Ambientes de testes e de produção

Para possibilitar liberdade de testes aos usuários da API, criamos um ambiente de testes no endereço sandboxsite.mercadoeditorial.org. Os testes para esse ambiente devem ser feitos utilizando a chamada da API para a URL https://sandbox.mercadoeditorial.org, e apenas após completar a integração, deve-se apontar para a URL de produção.

A homologação é uma etapa necessária para que seja liberada a integração em produção dos métodos de adição e edição de metadados. Portanto, por favor, envie um e-mail para [email protected] no final da etapa de testes.

Na documentação que se segue, indicamos sempre os endereços para ambos endereços de produção e de sandbox, e possibilitamos os testes em ambos ambientes.

Para que o ambiente de testes permaneça similar ao ambiente de produção nos dados a serem devolvidos, periodicamente efetuamos a limpeza dos livros inseridos pelos usuários em seus testes.

É importante ressaltar que a chave_de_acesso para ambos ambientes será diferente. E a criação de novos cadastros no ambiente de testes deve ser solicitada diretamente à equipe do MercadoEditorial.org.

Quaisquer dúvidas, favor entrar em contato pelo endereço de e-mail [email protected].


Livros

Existem três possibilidades de interação com um documento de livro, que são de consulta, adição e atualização de informações.

#Requisição de livro único

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/requisitar_livro_unico

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/requisitar_livro_unico

Elemento Tipo Obrigatório Tamanho Descrição
isbn String Sim 10 ou 13 O campo deve ser numérico, sem pontos ou traços, contendo 10 ou 13 digitos (para livros mais antigos ou mais novos).

Resposta

Testar Requisição Única de Livro

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

Diversos parâmetros vêm codificados para facilitar seu tratamento nos sistemas. Abaixo, elencamos a tabela de todos eles, com seus respectivos valores:

Autores

Colaboradores

Classificação Indicativa

Status

Faixa Etária

Encadernação

#Requisição de livros a partir de data

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/requisitar_livros_desde_data

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/requisitar_livros_desde_data

Elemento Tipo Obrigatório Tamanho Descrição
chave_de_acesso String Sim Variável A chave_de_acesso é fornecida em seu painel de controle, na página de Configurar conta
date Numérico Sim 14 O campo deve conter a data no formato YYYYMMDDHHMMSS, obrigatoriamente contendo todos os os campos de ano, mês, dia, hora, minutos e segundos, a partir de quando deseja receber os dados de novos livros adicionados
date2 Numérico Não 14 O campo deve conter a data no formato YYYYMMDDHHMMSS, obrigatoriamente contendo todos os os campos de ano, mês, dia, hora, minutos e segundos, a partir de quando deseja receber os dados de novos livros adicionados

A requisição de livro por data requer uma chave de acesso para autenticação. Submetendo no POST uma data inicial e uma data final, a API devolve o JSON com informações dos livros adicionados nesse período. Caso nenhuma data final seja submetida, a API devolve o JSON com informações dos livros adicionados entre a data inicial e o dia de hoje.

Resposta

Testar Requisição de Livro por Data

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

Assim como na requisição de livro-único, alguns parâmetros vêm codificados para otimizar a integração.

Dependendo da extensão do período selecionado, o retorno da requisição pode levar alguns minutos para ser processado.

#Requisitar apenas novos livros para meu usuário

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/requisitar_novos_livros

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/requisitar_novos_livros

Elemento Tipo Obrigatório Tamanho Descrição
chave_de_acesso String Sim Variável A chave_de_acesso é fornecida em seu painel de controle, na página de Configurar conta

A requisição de novos livros é semelhante ao botão "baixar novos livros" da página principal dos usuários distribuidora e livraria. Ela serve para, desde o último download daquele usuário, baixar tudo que há de novo publicado desde então.

No caso de nossa API, é necessário que após a requisição seja enviada uma nova requisição correspondente ao item /confirmar_novos_livros, para confirmarmos que a resposta foi recebida com sucesso pela sua aplicação. Apenas após essa nova requisição de confirmação é que nosso sistema marca que os novos livros foram enviados.

Caso essa nova requisição não seja feita, o MercadoEditorial.org enviará novamente todos os mesmos livros na próxima vez que a requisição /requisitar_novos_livros for efetuada.

Resposta

Testar Requisição de novos livros para o usuário LivrariaABC

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

O resultado acima mostra todos os livros adicionados no MercadoEditorial.org desde o último download geral de metadados desse usuário de testes.

Repare que há a indicação de uma url_de_resposta, com um token_de_requisicao. Eles indicam para qual URL e com qual token deve ser feita a nova requisição de confirmação do recebimento dos metadados.

Para concluir o teste, insira esse token da resposta no campo abaixo. Após fazer isso, se efetuar novamente a mesma requisição acima, ela retornará uma Array vazia.

Confirmar recebimento de requisição

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

#Requisitar todos os livros por editora

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/requisitar_livros_de_editora

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/requisitar_livros_de_editora

Elemento Tipo Obrigatório Tamanho Descrição
chave_de_acesso Texto Sim Variável A chave_de_acesso é fornecida em seu painel de controle, na página de Configurar conta
editora Number Sim Variável Deve ser usado o ID da editora no MercadoEditorial.org. Esse valor só pode ser conseguido através de requisição pela API, pelo método requisitar_dados_de_editora (ver mais sobre esse método).

A requisição de todos os livros de uma editora requer uma chave de acesso para autenticação. Submetendo no POST o ID da editora no MercadoEditorial.org – esse valor só pode ser conseguido através de requisição pela API, pelo método requisitar_dados_de_editora (ver mais sobre esse método) –, a API devolve o JSON com informações de todos os livros de todos os selos editoriais de uma editora.

Resposta

Testar Requisição livros por ID de Editora

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

#Requisitar todos os livros por selo editorial

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/requisitar_todos_livros_de_selo_editorial

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/requisitar_todos_livros_de_selo_editorial

Elemento Tipo Obrigatório Tamanho Descrição
chave_de_acesso Texto Sim Variável A chave_de_acesso é fornecida em seu painel de controle, na página de Configurar conta
nome_limpo Texto Sim Variável Nome de sistema do selo editorial, informado na requisição a respeito da editora dona do selo.
editora Number Sim Variável Deve ser usado o ID da editora no MercadoEditorial.org. Esse valor só pode ser conseguido através de requisição pela API, pelo método requisitar_dados_de_editora (ver mais sobre esse método).

A requisição de todos os livros de um selo editorial requer uma chave de acesso para autenticação. Submetendo no POST o ID da editora no MercadoEditorial.org – esse valor só pode ser conseguido através de requisição pela API, pelo método requisitar_dados_de_editora (ver mais sobre esse método) –, a API devolve o JSON com informações de todos os livros do selo editorial especificado.

Resposta

Testar Requisição de livros por selo editorial

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

#Adicionar novo livro

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/adicionar_novo_livro

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/adicionar_novo_livro

Elemento Tipo Obrigatório Tamanho Descrição
chave_de_acesso String Sim Variável A chave_de_acesso é fornecida em seu painel de controle, na página de Configurar conta
editora Number Sim Variável Deve ser usado o ID da editora no MercadoEditorial.org. Esse valor só pode ser conseguido através de requisição pela API, pelo método requisitar_dados_de_editora (ver mais sobre esse método).
selo_editorial String Sim Variável Corresponde ao nome do selo editorial ao qual o livro faz parte. Toda editora, quando cadastrada no MercadoEditorial.org, recebe ao menos 1 selo editorial. Deve ser usado o mesmo encontrado na página Configurar Perfil do site.
formato String Sim Variável O tipo do livro a ser cadastrado deve ser LIVRO. Não é possível, no momento, realizar o cadastro de e-books via API. A opção está disponível somente no formulário online e na planilha de importação em lote.
isbn String Sim 10 ou 13 Adicionar o número do ISBN do livro a ser adicionado. O número deve ser único para cada livro ou edição. Caso o livro já tenha sido adicionado no MercadoEditorial.org, será devolvido um erro.
titulo String Sim Variável O título do livro (não incluir volume nem subtítulo). Deve-se utilizar letra maiúscula apenas na primeira letra da primeira palavra e nas iniciais de nomes próprios.
subtitulo String Não Variável Corresponde ao subtítulo do livro. Não é de preenchimento obrigatório. Não deve ser incluído volume. Deve-se utilizar letra maiúscula apenas na primeira letra da primeira palavra e nas iniciais de nomes próprios.
titulo_original String Não Variável Caso se trate de uma tradução, deve-se incluir aqui o título original do livro na sua lingua respectiva.
volume Number Não Variável Caso faça parte de uma coleção ou conjunto de livros, informar apenas com número qual o volume do livro em questão.
edicao Number Sim Variável Número da edição do livro. Deve ser informato apenas o número, sem qualquer sinal ou outra palavra junto a ela.
ano_edicao Number Sim 4 Ano da edição do livro.
detalhes_da_edicao String Não Variável Para detalhes específicos dessa edição, tais como "Edição de luxo", "Edição revisada e ampliada", etc, utilizar esse campo incluíndo qualquer texto desejado.
data_de_publicacao Date Sim DD/MM/YYYY Data de publicação da edição em questão do livro. Caso não saiba a data exata, utilize uma data aproximada. É necessário informar no formato DD/MM/YYYY
previsao_de_disponibilidade Date Não DD/MM/YYYY Data de previsão de disponibilidade do livro – somente quando o status for pré-lançamento ou indisponível. É necessário informar no formato DD/MM/YYYY.
colecao String Não Variável Se for o caso, a qual coleção/série pertence o título. Não deve ser incluído volume. Deve-se utilizar letra maiúscula apenas na primeira letra da primeira palavra e nas iniciais de nomes próprios.
volume_colecao String Não Variável Caso faça parte de uma coleção ou conjunto de livros, informar apenas com número qual o volume do livro em questão.
autor_nome[i] String Sim Variável Para cada autor (ou Coordenador, Organizador, Editor, Instituição) do livro, incluir um valor de autor_nome[i], com um valor para i. Exemplo:
'author_nome[1]':'Assis, Machado de',
'author_nome[2]':'Queiroz, Eça de'
É necessário seguir o formato Sobrenome, Nome; para todos os autores. Caso o autor não siga essa estrutura e identifique-se com apenas 1 nome (por exemplo: Ziraldo), insira esse nome dessa maneira mesmo.
author_tipo[i] Number Sim Variável Para cada autor adicionado a chave anterior, deve-se adicionar seu respectivo código de autor, identificando pelo mesmo número, conforme exemplo:
'autor_tipo[0]':1,
'autor_tipo[1]':3
Os valores para os tipos de autor são:
  • Autor = 1
  • Organizador = 2
  • Coordenador = 3
  • Instituição = 4
  • Editor = 5
  • Editor Técnico = 6
  • Editor Associado = 7
  • Espírito = 8
colaborador_nome[i] String Não Variável Funciona da mesma maneira que autor_nome.
colaborador_tipo[i] Number Não* Variável Funciona da mesma maneira que autor_tipo. A lista de tipos e valores são:
  • Colaborador = 1
  • Ilustrador = 2
  • Tradutor = 3
  • Apresentação = 4
  • Prefácio = 5
  • Posfácio = 6
  • Projeto Gráfico = 7
  • Diagramdor = 8
  • Capista = 9
  • Editor (colaborador) = 10
  • Revisor = 11
  • Revisor Técnico = 12
  • Orelha = 13
  • Fotografia = 14
  • Prólogo = 15
  • Comentários / Notas = 16
  • Epílogo = 17
  • Introdução = 18
  • Adaptação = 19
  • Atualização = 20
  • Psicografia = 21
* Obrigatório apenas em caso de preenchimento do campo colaborador_nome[i].
assuntos String Sim Variável Devem ser incluídas pelo menos 3 palavras ou expressões-chave que descrevam tematicamente o título a ser adicionado. Essas palavras ou expressões devem ser separadas por vírgula+espaço.
id_area Number Sim Até 2 Deve ser adicionado um ID de uma das áreas do MercadoEditorial.org, que são:
  • Artes = 1
  • Auto-ajuda = 2
  • Gastronomia = 3
  • Humanidades = 4
  • Saúde, esporte e lazer = 5
  • Infanto-juvenil = 6
  • Idiomas e referência = 7
  • Religião = 9
  • Técnicos = 10
  • Turismo = 11
  • Literatura estrangeira = 13
  • Literatura nacional = 14
  • Teoria e crítica literária = 15
  • Concurso público = 16
  • Religião / Espiritismo = 17
  • Didáticos / Ensino Fundamental = 18
  • Didáticos / Ensino Médio = 19
  • Paradidáticos / Referência = 20
  • Paradidáticos / Leitura = 21
  • Educação = 22
Caso a opção do id_area seja por id 18, 19, 20 e 21 pode-se realizar também a inserção dos seguintes parâmetros: grau_escolar, ano_escolar e materia_escolar.
cdd Number Não A partir de 3 digitos CDD do livro, número encontrado na fixa catalográfica do mesmo. O quarto dígito à direita, se houver, deve ser precedido de um ponto. Ex: 341.789987
bisac_codigo String Sim 9 Código BISAC (versão 2015) para seu livro.
bisac_category_code2 String Não 9 Código BISAC (versão 2015) adicional para seu livro (diferente do anterior).
bisac_codigo3 String Não 9 Código BISAC (versão 2015) adicional para seu livro (diferente do anterior).
idioma String Sim Variável Idioma principal do livro, escrito por extenso. Ex.: Português, Inglês, Espanhol, Alemão etc.
origem String Sim Variável Indicar nesse campo o país de origem do produto, e não da obra.
faixa_etaria Number Não 1 A faixa etária do livro deve ser informada utilizando numeros que referenciem à faixa adequada:
  • 0-3 anos = 1
  • 3-5 anos = 2
  • 5-8 anos = 3
  • 8-11 anos = 4
  • acima de 12 anos = 5
classificacao_indicativa Number Sim 1 Informar classificação indicativa através de respectivo dígito da lista:
  • Livre para todos os públicos = 1;
  • Não recomendado para menores de 10 anos = 2
  • Não recomendado para menores de 12 anos = 3
  • Não recomendado para menores de 14 anos = 4
  • Não recomendado para menores de 16 anos = 5
  • Não recomendado para menores de 18 anos = 6
  • Especialmente recomendado para crianças = 7
Se sua obra não possui caráter restritivo em função de eventuais conteúdos impróprios para menores, utilize 'Livre para todos os públicos'.
sinopse String Sim Até 1400 caracteres Sinopse do livro, com até 1400 caracteres (com espaços). Caso sejam inseridos mais de 1400 caracteres, o sistema cortará automaticamente o conteúdo após esse valor.
sumario String Não Até 6000 caracteres Sumário do livro, aceita formatação de HTML.
link String Não Variável Link principal do livro na web. Pode ser a página da editora, ou qualquer outro site que se deseje incluir.
book_trailer String Não Variável URL do booktrailer do livro na web.
paginas Number Sim Variável Número de páginas do livro, em formato de número apenas.
altura Number Sim Variável Altura do livro em Centímetros.
largura Number Sim Variável Largura do livro em Centímetros.
espessura Number Sim Variável Espessura do livro em Centímetros.
peso Number Sim Variável Peso do livro em Kilogramas.
encadernacao Number Sim Até 2 digitos Escolher tipo de encadernação, conforme valores da lista a seguire:
  • Brochura = 1
  • Brochura com Sobrecapa = 2
  • Encadernado = 3
  • Encadernado com Sobrecapa = 4
  • Capa Dura = 5
  • Capa Dura com sobre-capa = 6
  • Flexível = 7
  • Espiral = 8
  • Vinil = 9
  • Tecido = 10
  • Metal = 11
  • Plástico = 12
  • Jeans = 13
  • Camurça = 14
  • Couro = 15
  • Zíper = 16
  • Pop-up = 17
  • Toque-e-sinta = 18
  • Livro-brinquedo = 19
  • Vira-vira = 20
  • Livro para banho = 21
material_adicional Number Não Até 2 digitos Materiais que acompanham o livro. Utilizar um dos valores a seguir:
  • Audiobook = 1
  • Agenda = 2
  • Brinquedo = 3
  • Brinde = 4
  • Cd-audio = 5
  • Cartões De Acesso = 6
  • Cd-rom = 7
  • Calendario = 8
  • Cartas De Tarô = 9
  • Disquete = 10
  • Dvd = 11
  • Encarte = 12
  • Livro = 13
  • Livreto = 14
  • Mapa = 15
  • VCD = 16
grau_escolar Number Não Até 1 dígito Em caso de livro educacional, preencher com o valor correspondente à lista abaixo:
  • Ensino Fundamental = 1
  • Ensino Médio = 2
  • Ensino Superior = 3
  • Ensino Infantil = 4
  • Educação de Jovens e Adultos = 5
  • Educação Profissional = 6
  • Educação Especial = 7
ano_escolar Number Não Até 2 digitos Em caso de livro didático, informar a qual ano o livro se destina, seguindo os valores abaixo:
  • Primeiro (a) = 1
  • Segundo(a) = 2
  • Terceiro(a) = 3
  • Quarto(a) = 4
  • Quinto(a) = 5
  • Sexto(a) = 6
  • Sétimo(A) = 7
  • Oitavo(a) = 8
  • Nona = 9
  • Jardim = 10
  • Jardim I = 11
  • Jardim I I = 12
  • Jardim I I I = 13
  • Pré = 14
  • Pré I = 15
  • Pré I I = 16
  • Pré I I I = 17
  • Maternal = 18
  • Infantil = 19
  • Infantil I = 20
  • Infantil I I = 21
  • Infantil I I I = 22
  • Classe de Alfabetização = 23
materia_escolar String Não Variável Para livros de educação, a qual matéria ou disciplina se dedica.
status Number Sim 1 O status do livro deve ser informado por meio de um numeral, que corresponda a uma das opções:
  • Disponível = 1
  • Indisponível = 2
  • Pré-lançamento = 3
  • Fora de Catálogo = 4
preco Number Sim A partir de 3 dígitos Corresponde ao preço de capa do livro. A informação deve constar dos centavos, mesmo que zerados (ex. 14,00). Não deve ser incluído sinal de cifrão ou da moeda. Por enquanto, apenas é aceito valor em Reais (R$).
codigo_de_barras Number Sim 13 dígitos Deve ser utilizado necessariamente 13 dígitos ao código de barras.
codigo_fiscal Number Sim 8 dígitos Classificação fiscal do livro, podendo ser:
  • 49019900 : livros, brochuras e impressos semelhantes
  • 49019100 : dicionários, enciclopédias, fascículos
  • 49011000 : Folhas Soltas, livros, brochuras, impressos semelhantes, etc
  • 49029000 : outros jornais ou periódicos, impressos, mesmo ilustrados ou publicidade
  • 49030000 : álbuns ou livros de ilustrações e álbuns para desenhar ou colorir, para crianças
codigo_interno String Sim Variável Código do produto conforme o próprio sistema da Editora. Usado para integrações entre o MercadoEditorial.org e sistemas da editora e algumas livrarias. Caso não se aplique, utilize o ISBN do livro.
certificacao_inmetro String Não Variável Código da certificação Inmetro.
isbn_relacionado[i] String Não 10 ou 13 digitos Funciona da mesma maneira que autor_nome, mas refere-se a ISBN's relacionados ao título, tais como Edições anteriores, Edições Digitais, etc.
isbn_relacionado_tipo[i] String Não* Até 2 digitos Funciona da mesma maneira que autor_tipo, referindo-se ao tipo do ISBN adicionado no respectivo campo isbn_relacionado[i]. Dentre as opções aceitas, segue a lista com seus respectivos valores numéricos:
  • ISBN do Livro Impresso = 1
  • ISBN da Coedição = 2
  • ISBN da Edição anterior = 3
  • ISBN do e-book em ePUB = 4
  • ISBN do e-book em PDF = 5
  • ISBN do e-book em AZW = 6
  • ISBN do e-book em MOBI = 7
  • ISBN do e-book em LIT = 8
  • ISBN do e-book em ODF = 9
  • ISBN do e-book em outro formato = 10
  • ISBN do audiobook = 11
  • ISBN da coleção = 12
  • ISBN de outro volume da coleção = 13
  • ISBN de edição com capa dura = 14
  • ISBN de edição brochura = 15
  • ISBN de edição com capa de filme = 16
* Obrigatório apenas em caso de preenchimento do campo isbn_relacionado[i].
imagem_primeira_capa URL Sim Variável Inserir aqui a imagem da primeira capa de seu livro. Deve ser uma URL que o sistema do MercadoEditorial.org possa acessar automaticamente e capturar a imagem. Portanto, não pode depender de logins, ou qualquer tipo de autenticação. Deve-se utilizar, no MercadoEditorial.org, arquivos de imagem em boa qualidade (JPG ou PNG), com, no mínimo, 72 dpi de resolução. A região correspondente à primeira capa deve ter entre 700 pixels e 1000 pixels no seu lado menor.
imagem_lombada URL Não Variável Inserir aqui a imagem da lombada de seu livro. Deve ser uma URL que o sistema do MercadoEditorial.org possa acessar automaticamente e capturar a imagem. Portanto, não pode depender de logins, ou qualquer tipo de autenticação.
imagem_quarta_capa URL Não Variável Inserir aqui a imagem da quarta-capa de seu livro. Deve ser uma URL que o sistema do MercadoEditorial.org possa acessar automaticamente e capturar a imagem. Portanto, não pode depender de logins, ou qualquer tipo de autenticação. Deve-se utilizar, no MercadoEditorial.org, arquivos de imagem em boa qualidade (JPG ou PNG), com, no mínimo, 72 dpi de resolução. A região correspondente à primeira capa deve ter entre 700 pixels e 1000 pixels no seu lado menor.
imagens_internas[i] String Não Variável Inserir aqui imagens internas de seu livro. Deve ser uma URL que o sistema do MercadoEditorial.org possa acessar automaticamente e capturar a imagem. Portanto, não pode depender de logins, ou qualquer tipo de autenticação. Deve-se utilizar, no MercadoEditorial.org, arquivos de imagem em boa qualidade (JPG ou PNG), com, no mínimo, 72 dpi de resolução.
imagem_perspectiva[i] String Não Variável Inserir aqui a imagem em perspectiva (3D) de seu livro. Deve ser uma URL que o sistema do MercadoEditorial.org possa acessar automaticamente e capturar a imagem. Portanto, não pode depender de logins, ou qualquer tipo de autenticação. Deve-se utilizar, no MercadoEditorial.org, arquivos de imagem em boa qualidade (JPG ou PNG), com, no mínimo, 72 dpi de resolução.

Exemplo de Chamada

	
		$post_data = array(
			'chave_de_acesso' => '1234567890', // sua chave de acesso vai aqui
			'editora' => '135', // ID da Editora puxado pela API
			'selo_editorial' => 'Imprensa Régia',
			'formato' => 'LIVRO',
			'isbn' => '9781234567890',
			'titulo' => 'Marília de Dirceu',
			'subtitulo' => '',
			'titulo_original' => '',
			'edicao' => '1',
			'ano_edicao' => '1810',
			'detalhes_da_edicao' => 'Edição de luxo, Edição de bolso',
			'data_de_publicacao' => '05/10/1810',
			'volume' => '',
			'colecao' => 'Coleção Clássicos',
			'autor_nome[0]' => 'Gonzaga, Tomás Antônio',
			'author_tipo[0]' => 1,
			'colaborador_nome[0]' => 'Silva, José da',
			'colaborador_tipo[0]' => 1, // ilustrador
			'colaborador_nome[1]' => 'Bragança, João de',
			'colaborador_tipo[1]' => 8, // diagramador
			'assuntos' => 'Literatura portuguesa, Poesia, Arcadismo',
			'id_area' => 7, // literatura e fição
			'cdd' => '869.12',
			'bisac_codigo' => 'POE020000',
			'bisac_category_code2' => '',
			'idioma' => 'Português',
			'origem' => 'Brasil',
			'faixa_etaria' => 5, // acima de 12 anos
			'classificacao_indicativa' => 1, //Livre para todos os públicos
			'sinopse' => 'Um clássico da literatura em língua portuguêsa, Marília de Dirceu foi publicado em Lisboa, pela primeira vez, em 1792. Trata-se de um poema divido em três partes, uma declaração de amor que, mais de dois séculos depois de sua publicação, continua encantando gerações de leitores.',
			'sumario' => '-',
			'link' => 'http://www.2ab.com.br/pd-8d670-identidade-e-cultura.html',
			'paginas' => '176',
			'altura' => '24', // cm
			'largura' => '17', // cm
			'espessura' => '1', // cm
			'peso' => '0.120', // kg
			'encadernacao' => 1, // Brochura
			'material_adicional' => '',
			'status' => 1, // disponível
			'preco' => '25,00', // em Reais, sem R$
			'codigo_de_barras' => '9781234567890',
			'codigo_fiscal' => '49019900',
			'codigo_interno' => '123',
			'isbn_relacionado[0]' => '9781234567890',
			'isbn_relacionado_tipo[0]' => '5', // ISBN da versão em PDF
			'isbn_relacionado[1]' => '9781234567890',
			'isbn_relacionado_tipo[1]' => '12', // ISBN do Audiobook
			'imagem_primeira_capa' => 'https://www.bn.br/imagens/marilia_de_dirceu.jpg', // URL com a capa do livro
			'imagem_lombada' => '',
			'imagem_quarta_capa' => '',
			);
	

Resposta

Testar Requisição de livros por selo editorial

Não há teste disponível para adição de novo livro. Desculpe! Mas veja abaixo um exemplo de resposta de livro adicionado com sucesso.

	
		{
		"message":{
			"isbn":"9788586695424",
			"book_url":"https://www.mercadoeditorial.org\/book\/marilia-de-dirceu", //URL do livro
			"publishing_status":"pending publish", // status após submissão, será sempre 'pending publish' para sucesso
			"publishing_time":"2016-07-21 19:13:13" //horário que o livro será publicado
			},
			"status_code":"100",
			"status":"ok"
			}
	

#Atualizar livro

A atualização de campos de um livro requer autenticação, e só pode ser feita pela própria editora. Apenas uma parcela dos campos são atualizáveis, conforme listagem abaixo.

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/atualizar_livro

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/atualizar_livro

Elemento Tipo Obrigatório Tamanho Descrição
chave_de_acesso String Sim Variável A chave_de_acesso é fornecida em seu painel de controle, na página de Configurar conta
isbn Numérico Sim 10 ou 13 O campo, apenas numérico, serve para identificar qual é o livro a ser editado. Deve ser um livro da própria editora, de algum de seus selos.
assuntos String Não Variável Devem ser incluídos pelo menos 3 palavras-chave que descrevam o título a ser adicionado.
status Number Não 1 O status do livro deve ser informado por meio de um numeral, que corresponda a uma das opções:
  • Disponível = 1
  • Indisponível = 2
  • Pré-lançamento = 3
  • Fora de Catálogo = 4
preco Number Não A partir de 3 dígitos Corresponde ao preço de capa do livro. A informação deve constar dos centavos, mesmo que zerados (ex. 14,00). Não deve ser incluído sinal de cifrão ou da moeda. Por enquanto, apenas é aceito valor em Reais (R$).
link String Não Variável Link principal do livro na web. Pode ser a página da editora, ou qualquer outro site que se deseje incluir.
cdd Number Não A partir de 3 digitos CDD do livro, número encontrado na fixa catalográfica do mesmo. O quarto dígito à direita, se houver, deve ser precedido de um ponto. Ex: 341.789987
codigo_interno String Não Variável Código do produto conforme o próprio sistema da Editora. Usado para integrações entre o MercadoEditorial.org e sistemas da editora e algumas livrarias. Caso não se aplique, utilize o ISBN do livro.
sumario String Não Até 6000 caracteres Sumário do livro, aceita formatação de HTML.
sinopse String Não Até 1400 caracteres Sinopse do livro, com até 1400 caracteres (com espaços). Caso sejam inseridos mais de 1400 caracteres, o sistema cortará automaticamente o conteúdo após esse valor.
classificacao_indicativa Number Sim 1 Informar classificação indicativa através de respectivo dígito da lista:
  • Livre para todos os públicos = 1;
  • Não recomendado para menores de 10 anos = 2;
  • Não recomendado para menores de 12 anos = 3;
  • Não recomendado para menores de 14 anos = 4;
  • Não recomendado para menores de 16 anos = 5;
  • Não recomendado para menores de 18 anos = 6;
  • Especialmente recomendado para crianças = 7
Se sua obra não possui caráter restritivo em função de eventuais conteúdos impróprios para menores, utilize 'Livre para todos os públicos'.
faixa_etaria Number Não 1 A faixa etária do livro deve ser informada utilizando numeros que referenciem à faixa adequada:
  • 0-3 anos = 1
  • 3-5 anos = 2
  • 5-8 anos = 3
  • 8-11 anos = 4
  • acima de 12 anos = 5
espessura Number Não Variável Espessura do livro em Centímetros.
peso Number Não Variável Peso do livro em Kilogramas.
paginas Number Não Variável Número de páginas do livro, em formato de número apenas.
isbn_relacionado[i] String Não 10 ou 13 digitos Funciona da mesma maneira que autor_nome, mas refere-se a ISBN's relacionados ao título, tais como Edições anteriores, Edições Digitais, etc.
isbn_relacionado_tipo[i] String Não* Até 2 digitos Funciona da mesma maneira que autor_tipo, referindo-se ao tipo do ISBN adicionado no respectivo campo isbn_relacionado[i]. Dentre as opções aceitas, segue a lista com seus respectivos valores numéricos:
  • ISBN do Livro Impresso = 1
  • ISBN da Coedição = 2
  • ISBN da Edição anterior = 3
  • ISBN do e-book em ePUB = 4
  • ISBN do e-book em PDF = 5
  • ISBN do e-book em AZW = 6
  • ISBN do e-book em MOBI = 7
  • ISBN do e-book em LIT = 8
  • ISBN do e-book em ODF = 9
  • ISBN do e-book em outro formato = 10
  • ISBN do audiobook = 11
  • ISBN da coleção = 12
  • ISBN de outro volume da coleção = 13
  • ISBN de edição com capa dura = 14
  • ISBN de edição brochura = 15
  • ISBN de edição com capa de filme = 16
* Obrigatório apenas em caso de preenchimento do campo isbn_relacionado[i].
bisac_codigo String Sim 9 Código BISAC (versão 2015) para seu livro.
bisac_category_code2 String Não 9 Código BISAC (versão 2015) adicional para seu livro (diferente do anterior).
id_area Number Não Até 2 Deve ser adicionado um ID de uma das áreas do MercadoEditorial.org, que são:
  • Artes = 1
  • Auto-ajuda = 2
  • Gastronomia = 3
  • Humanidades = 4
  • Saúde, esporte e lazer = 5
  • Infanto-juvenil = 6
  • Idiomas e referência = 7
  • Religião = 8
  • Técnicos = 9
  • Turismo = 10
  • Literatura estrangeira = 11
  • Literatura nacional = 12
  • Teoria e crítica literária = 13
  • Concurso público = 14
  • Religião / Espiritismo = 15
  • Didáticos / Ensino Fundamental = 16
  • Didáticos / Ensino Médio = 17
  • Paradidáticos / Referência = 18
  • Paradidáticos / Leitura = 19
  • Educação = 20
Caso a alteração do id_area seja para id 18, 19, 20 e 21 pode-se realizar também a inserção dos seguintes parâmetros: grau_escolar, ano_escolar e materia_escolar.
grau_escolar Number Não Até 1 dígito Em caso de livro educacional, preencher com o valor correspondente à lista abaixo:
  • Ensino Fundamental = 1
  • Ensino Médio = 2
  • Ensino Superior = 3
  • Ensino Infantil = 4
  • Educação de Jovens e Adultos = 5
  • Educação Profissional = 6
  • Educação Especial = 7
ano_escolar Number Não Até 2 digitos Em caso de livro didático, informar a qual ano o livro se destina, seguindo os valores abaixo:
  • Primeiro (a) = 1
  • Segundo(a) = 2
  • Terceiro(a) = 3
  • Quarto(a) = 4
  • Quinto(a) = 5
  • Sexto(a) = 6
  • Sétimo(A) = 7
  • Oitavo(a) = 8
  • Nona = 9
  • Jardim = 10
  • Jardim I = 11
  • Jardim I I = 12
  • Jardim I I I = 13
  • Pré = 14
  • Pré I = 15
  • Pré I I = 16
  • Pré I I I = 17
  • Maternal = 18
  • Infantil = 19
  • Infantil I = 20
  • Infantil I I = 21
  • Infantil I I I = 22
  • Classe de Alfabetização = 23
materia_escolar String Não Variável Para livros de educação, a qual matéria ou disciplina se dedica.
data_de_publicacao Date Sim DD/MM/YYYY Data de publicação da edição em questão do livro. Caso não saiba a data exata, utilize uma data aproximada. É necessário informar no formato DD/MM/YYYY
previsao_de_disponibilidade Date Não DD/MM/YYYY Data de previsão de disponibilidade do livro – somente quando o status for pré-lançamento ou indisponível. É necessário informar no formato DD/MM/YYYY.
detalhes_da_edicao String Não Variável Para detalhes específicos dessa edição, tais como "Edição de luxo", "Edição revisada e ampliada", etc, utilizar esse campo incluíndo qualquer texto desejado.
material_adicional Number Não Até 2 digitos Materiais que acompanham o livro. Utilizar um dos valores a seguir:
  • Audiobook = 1;
  • Agenda = 2;
  • Brinquedo = 3;
  • Brinde = 4;
  • Cd-audio = 5;
  • Cartões De Acesso = 6;
  • Cd-rom = 7;
  • Calendario = 8;
  • Cartas De Tarô = 9;
  • Disquete = 10;
  • Dvd = 11;
  • Encarte = 12;
  • Livro = 13;
  • Livreto = 14;
  • Mapa = 15;
  • VCD = 16
imagem_lombada URL Não Variável Inserir aqui a imagem da lombada de seu livro. Deve ser uma URL que o sistema do MercadoEditorial.org possa acessar automaticamente e capturar a imagem. Portanto, não pode depender de logins, ou qualquer tipo de autenticação.
imagem_quarta_capa URL Não Variável Inserir aqui a imagem da quarta-capa de seu livro. Deve ser uma URL que o sistema do MercadoEditorial.org possa acessar automaticamente e capturar a imagem. Portanto, não pode depender de logins, ou qualquer tipo de autenticação. Deve-se utilizar, no MercadoEditorial.org, arquivos de imagem em boa qualidade (JPG ou PNG), com, no mínimo, 72 dpi de resolução. A região correspondente à primeira capa deve ter entre 700 pixels e 1000 pixels no seu lado menor.

Exemplo de chamada para id_area

Resposta

Resposta para atualização de livro

Mensagem que o sistema retorna ao atualizar um livro.

	
	{
		"isbn": "9788528617931",
		"book_url": "http://sandbox.mercadoeditorial.org/book/livro-dos-sith",
		"update_status": "Metadados atualizados com sucesso",
		"date": "2017-11-16 19:11:24",
		"status": "ok"
	}
	

Editoras

A requisição de informações de Editoras possui dois métodos: listar todas editoras e listar informações de uma editora.

#Requisitar lista de editoras

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/requisitar_lista_de_editoras

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/requisitar_lista_de_editoras

Elemento Tipo Obrigatório Tamanho Descrição
- - - - -

Resposta

Testar Requisição de lista de Editoras

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

#Requisitar dados de uma única Editora

Chamada

Produção: https://api.mercadoeditorial.org/api/v1/requisitar_informacoes_de_editora

Sandbox: https://sandbox.mercadoeditorial.org/api/v1/requisitar_informacoes_de_editora

Elemento Tipo Obrigatório Tamanho Descrição
cnpj Texto Sim Variável O campo deve conter os dados de CNPJ iguais aos cadastrados no MercadoEditorial.org, que podem ser conseguidos a partir do método /requisitar_lista_editoras

Para requisitar informações de uma única editora, não há necessidade de autenticação.

Resposta

Testar Requisição de dados de Editora única

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

                
            

Notificação Automática

A Notificação Automática é a maneira mais simples de receber em seu sistema os novos livros publicados no MercadoEditorial.org. Através do cadastro de uma URL no painel de controle do nosso site, enviaremos por método POST as informações de todo novo livro diretamente para aquela URL.

É necessário que essa URL esteja acessível ao MercadoEditorial.org, sem necessitar de Logins ou quaisquer outras autenticações.

Exemplo de dados enviados

Testar Requisição de dados de Editora única

Importante: a base de dados de sandbox contém informações diferentes da base de produção. Portanto, os resultados para ambas requisições possivelmente serão divergentes.

Os dados enviados para a URL informada foram: