Mudanças entre as edições de "API-BIBLIOTECA-DIGITAL"

De SEADE
Ir para: navegação, pesquisa
(→‎Publicações por Coleção)
 
(7 edições intermediárias de 2 usuários não apresentadas)
Linha 5: Linha 5:
 
== URI ==
 
== URI ==
  
−
http://api-bibliotecadigital.seade.gov.br/v1
+
http://api-bibliotecadigital.seade.gov.br/v1
  
 
== Código HTTP de Retorno ==
 
== Código HTTP de Retorno ==
Linha 22: Linha 22:
 
* '''Path''': /tipo
 
* '''Path''': /tipo
 
* '''Parâmetros''': id
 
* '''Parâmetros''': id
 +
  
 
<nowiki>* Não é obrigatório a informação do id .</nowiki>
 
<nowiki>* Não é obrigatório a informação do id .</nowiki>
Linha 59: Linha 60:
 
* '''Path''': /colecao
 
* '''Path''': /colecao
 
* '''Parâmetros''': id
 
* '''Parâmetros''': id
 +
  
 
<nowiki>* Não é obrigatório a informação do id .</nowiki>
 
<nowiki>* Não é obrigatório a informação do id .</nowiki>
Linha 93: Linha 95:
 
* '''Path''': /autor
 
* '''Path''': /autor
 
* '''Parâmetros''': id
 
* '''Parâmetros''': id
 +
  
 
<nowiki>* Não é obrigatório a informação do id .</nowiki>
 
<nowiki>* Não é obrigatório a informação do id .</nowiki>
Linha 154: Linha 157:
 
         },
 
         },
 
       ...
 
       ...
 +
    ]
 +
}
 +
 +
 +
== Títulos das Publicações ==
 +
'''GET'''
 +
 +
 +
* '''Path''': /titulo/{id}/offset={inicial}/limit={limite}
 +
* '''Parâmetros''': id, inicial e limite
 +
 +
<nowiki>* Não é obrigatório a informação do id.</nowiki>
 +
 +
<nowiki>* Não coloque id se quiser ver todos os títulos das publicações por paginação.</nowiki>
 +
 +
<nowiki>* Limite máximo de publicações por página = 50</nowiki>
 +
 +
=== Sintaxe de chamada ===
 +
 +
curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/titulo/offset=0/limit=50"
 +
 +
ou
 +
 +
curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/titulo/10011143"
 +
 +
 +
=== Retorno JSON ===
 +
 +
Exemplo:
 +
 +
{
 +
    - header: {
 +
          publicacoes: "9153",
 +
          paginas: 184,
 +
          offset: "0",
 +
          limite: "50",
 +
      },
 +
    - publicacao: [
 +
        - {
 +
              id: "10021400",
 +
              parte: "1",
 +
              titulo: "20 anos no ano 2000: estudos sociodemográficos sobre a juventude paulista. São Paulo: 1998.",
 +
              tipo: "Monografia",
 +
          },
 +
          {
 +
              id: "10011561",
 +
              parte: "1",
 +
              titulo: "A Baixada de Sepetiba. Rio de Janeiro: Imprensa Nacional, 1942.",
 +
              tipo: "Monografia",
 +
          },
 +
          {
 +
              id: "10012946",
 +
              parte: "1",
 +
              titulo: "A Capital de S. Paulo em 1933. São Paulo: 1934.",
 +
              tipo: "Monografia",
 +
          },
 +
          ...
 
     ]
 
     ]
 
  }
 
  }
Linha 227: Linha 287:
 
* '''Path''': /publicacao/tipo/{id}/offset={inicial}/limit={limite}
 
* '''Path''': /publicacao/tipo/{id}/offset={inicial}/limit={limite}
 
* '''Parâmetros''': id, inicial e limite
 
* '''Parâmetros''': id, inicial e limite
 +
  
 
<nowiki>* Limite máximo de publicações por página = 20</nowiki>
 
<nowiki>* Limite máximo de publicações por página = 20</nowiki>

Edição atual tal como às 16h30min de 23 de maio de 2018

Índice

Apresentação

A API, sigla em inglês para Interface de Programação de Aplicativos, foi desenvolvida para permitir a criação de aplicações, que tornem possível a visualização de informações das obras antigas e raras e acervo de estatísticas do Seade desde o século XIX, em outros sítios ou a reutilização em sistemas desenvolvidos por usuários, mediante acesso direto à base de informações, sempre atualizadas da Biblioteca Digital. O formato, em código aberto, é o JSON e não há necessidade de cadastro ou qualquer outro procedimento para o acesso.

URI

http://api-bibliotecadigital.seade.gov.br/v1

Código HTTP de Retorno

  • Sucesso: 200.
  • Erro: 404.

Recursos Disponíveis

Tipos de Documentos

GET


  • Path: /tipo
  • Parâmetros: id


* Não é obrigatório a informação do id .

* Não coloque o id se quiser ver todos os tipos de documentos.

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/tipo"

ou 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/tipo/1"


Retorno JSON

Exemplo: 

{
   - tipo: [
       - {
           id: "1",
           tipo: "Periódico",
         },
       - {
           "id: "2",
           tipo: "Monografia",
       },
   ]
}

Coleções

GET


  • Path: /colecao
  • Parâmetros: id


* Não é obrigatório a informação do id .

* Não coloque o id se quiser ver todas as coleções.

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/colecao"

ou 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/colecao/24"


Retorno JSON

Exemplo: 

{
   - colecao: [
       - {
           id: "24",
           nome: "Perfil Municipal",
           dt_atualizacao: "2017-10-02 15:08:26",
       }
   ]
}

Autores

GET


  • Path: /autor
  • Parâmetros: id


* Não é obrigatório a informação do id .

* Não coloque o id se quiser ver todos os autores.

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/autor"

ou 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/autor/543"


Retorno JSON

Exemplo: 

{
   - autor: [
       - {
           id: "543",
           nome: "AFTALION, Albert",
           dt_atualizacao: "2014-09-08 15:26:04",
       }
   ]
}

Ano da publicação

GET


  • Path: /anopublicacao


* Lista todos os anos e quantidades de publicações

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/anopublicacao"


Retorno JSON

Exemplo: 

{
   - periodo: [
       - {
           ano_publicacao: "1864",
           qtde_publicacoes: "1",
        },
      - {
           ano_publicacao: "1865",
           qtde_publicacoes: "7",
        },
      - {
           ano_publicacao: "1867",
           qtde_publicacoes: "1",
        },
      ...
   ]
}


Títulos das Publicações

GET


  • Path: /titulo/{id}/offset={inicial}/limit={limite}
  • Parâmetros: id, inicial e limite

* Não é obrigatório a informação do id.

* Não coloque id se quiser ver todos os títulos das publicações por paginação.

* Limite máximo de publicações por página = 50

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/titulo/offset=0/limit=50"

ou 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/titulo/10011143"


Retorno JSON

Exemplo: 

{
   - header: {
          publicacoes: "9153",
          paginas: 184,
          offset: "0",
          limite: "50",
     },
   - publicacao: [
       - {
             id: "10021400",
             parte: "1",
             titulo: "20 anos no ano 2000: estudos sociodemográficos sobre a juventude paulista. São Paulo: 1998.",
             tipo: "Monografia",
          },
          {
             id: "10011561",
             parte: "1",
             titulo: "A Baixada de Sepetiba. Rio de Janeiro: Imprensa Nacional, 1942.",
             tipo: "Monografia",
          },
          {
             id: "10012946",
             parte: "1",
             titulo: "A Capital de S. Paulo em 1933. São Paulo: 1934.",
             tipo: "Monografia",
          },
          ...
   ]
}

Publicações

GET


  • Path: /publicacao/{busca}/offset={inicial}/limit={limite}
  • Parâmetros: busca, inicial e limite
  • busca: palavra(s) de qualquer parte da referência bibliográfica da publicação


* Não é obrigatório a informação da busca .

* Não coloque a busca se quiser ver todas as publicações por paginação.

* Limite máximo de publicações por página = 20

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/offset=0/limit=20"

ou 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/anuário/offset=0/limit=20"


Retorno JSON

Exemplo: 

{
   - header: {
          publicacoes: "9153",
          paginas: 458,
          offset: "0",
          limite: "20",
     },
   - publicacao: [
       - {
             publicacao_id: "10021400",
             publicacao_titulo: "20 anos no ano 2000",
             colecao_id: "0",
             colecao_nome: null,
             tipo_id: "2",
             tipo_descricao: "Monografia",
             periodo_prefixo: null,
             periodo: "1998",
             periodo_sufixo: null,
             complemento: ": estudos sociodemográficos sobre a juventude paulista",
             dt_informação: null,
             volume: null,
             serie_id: null,
             serie_numero: null,
             numero_paginas: "282",
             dt_atualizacao: "2015-09-01 16:54:20",
             editora: null,
             edicao: null,
             infoEspecificas: null,
             local: "São Paulo:",
             autor_nome: "FUNDAÇÃO SISTEMA ESTADUAL DE ANÁLISE DE DADOS",
             publicacao_pdf: "//produtos.seade.gov.br/produtos/bibliotecadigital/view/linkPdf.php?pdf=10021400-1.pdf",
         },
         ...
   ]
}

Publicações por Tipo de Documento

GET


  • Path: /publicacao/tipo/{id}/offset={inicial}/limit={limite}
  • Parâmetros: id, inicial e limite


* Limite máximo de publicações por página = 20

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/tipo/1/offset=0/limit=20"


Retorno JSON

Exemplo: 

{
   - header: {
          publicacoes: "7660",
          paginas: 383,
          offset: "0",
          limite: "20",
     },
   - publicacao: [
       - {
             publicacao_id: "10011174",
             publicacao_titulo: "A Estatística Policial-criminal do Estado",
             colecao_id: "20",
             colecao_nome: "Estatística Policial Criminal",
             tipo_id: "1",
             tipo_descricao: "Periódico",
             periodo_prefixo: null,
             periodo: "1939",
             periodo_sufixo: null,
             complemento: "",
             dt_informação: ", 1938"
             volume: "v.1",
             serie_id: "",
             serie_numero: "",
             numero_paginas: "442",
             dt_atualizacao: "2012-11-22 16:40:14",
             editora: "",
             edicao: "",
             infoEspecificas: "",
             local: "São Paulo:",
             autor_nome: "Serviço de Estatística Policial do Estado de São Paulo",
             publicacao_pdf: "//produtos.seade.gov.br/produtos/bibliotecadigital/view/linkPdf.php?pdf=10011174-1.pdf",
         },
         ...
   ]
}

Publicações por Coleção

GET


  • Path: /publicacao/colecao/{id}/offset={inicial}/limit={limite}
  • Parâmetros: id, inicial e limite


* Limite máximo de publicações por página = 20

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/colecao/1/offset=0/limit=20"


Retorno JSON

Exemplo: 

{
   - header: {
          publicacoes: "257",
          paginas: 13,
          offset: "0",
          limite: "20",
     },
   - publicacao: [
       - {
             publicacao_id: "10030045",
             publicacao_titulo: "Annuario de Estatistica Demographo-Sanitaria",
             colecao_id: "1",
             colecao_nome: "Anuário de Estatística Demógrafo-Sanitária",
             tipo_id: "1",
             tipo_descricao: "Periódico",
             periodo_prefixo: null,
             periodo: "1903",
             periodo_sufixo: null,
             complemento: null,
             dt_informação: null,
             volume: null,
             serie_id: null
             serie_numero: null
             numero_paginas: "302",
             dt_atualizacao: "2016-10-11 16:09:42",
             editora: "Imprensa Nacional",
             edicao: null,
             infoEspecificas: null,
             local: "Rio de Janeiro:",
             autor_nome: "***",
             publicacao_pdf: "//produtos.seade.gov.br/produtos/bibliotecadigital/view/linkPdf.php?pdf=10030045-1.pdf",
         },
         ...
   ]
}

Publicações por Ano

GET


  • Path: /publicacao/ano/{anodapublicacao}/offset={inicial}/limit={limite}
  • Parâmetros: anodapublicacao, inicial e limite

* Limite máximo de publicações por página = 20

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/ano/1970/offset=0/limit=20"


Retorno JSON

Exemplo: 

{
   - header: {
          publicacoes: "45",
          paginas: 3,
          offset: "0",
          limite: "20",
     },
   - publicacao: [
       - {
             publicacao_id: "10011115",
             publicacao_titulo: "Anuário Estatístico de São Paulo",
             colecao_id: "2",
             colecao_nome: "Anuário  Estatístico do Estado de São Paulo",
             tipo_id: "1",
             tipo_descricao: "Periódico",
             periodo_prefixo: "",
             periodo: "1970",
             periodo_sufixo: "",
             complemento: "",
             dt_informação: ", 1969",
             volume: "",
             serie_id: "",
             serie_numero: "",
             numero_paginas: "331",
             dt_atualizacao: "2012-11-22 16:40:14",
             editora: "",
             edicao: "",
             infoEspecificas: "",
             local: "São Paulo:",
             autor_nome: "D.E.E.",
             publicacao_pdf: "//produtos.seade.gov.br/produtos/bibliotecadigital/view/linkPdf.php?pdf=10011115-1.pdf",
         },
         ...
   ]
}


Publicações por Título

GET


  • Path: /publicacao/titulo/{busca}/offset={inicial}/limit={limite}
  • Parâmetros: busca, inicial e limite
  • busca: titulo ou palavra(s) do título


* Limite máximo de publicações por página = 20

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/titulo/demográfico/offset=0/limit=20"


Retorno JSON

Exemplo: 

{
   - header: {
          publicacoes: "337",
          paginas: 17,
          offset: "0",
          limite: "20",
     },
   - publicacao: [
       - {
             publicacao_id: "10021400",
             publicacao_titulo: "20 anos no ano 2000",
             colecao_id: "0",
             colecao_nome: null,
             tipo_id: "2",
             tipo_descricao: "Monografia",
             periodo_prefixo: null,
             periodo: "1998",
             periodo_sufixo: null,
             complemento: ": estudos sociodemográficos sobre a juventude paulista",
             dt_informação: null,
             volume: null,
             serie_id: null,
             serie_numero: null,
             numero_paginas: "282",
             dt_atualizacao: "2015-09-01 16:54:20",
             editora: null,
             edicao: null,
             infoEspecificas: null,
             local: "São Paulo:",
             autor_nome: "FUNDAÇÃO SISTEMA ESTADUAL DE ANÁLISE DE DADOS",
             publicacao_pdf: "//produtos.seade.gov.br/produtos/bibliotecadigital/view/linkPdf.php?pdf=10021400-1.pdf",
         },
         ...
   ]
}

Publicações por Autor

GET


  • Path: /publicacao/autor/{busca}/offset={inicial}/limit={limite}
  • Parâmetros: busca, inicial e limite
  • busca: nome do autor ou partes(s) do nome do autor


* Limite máximo de publicações por página = 20

Sintaxe de chamada 

curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/autor/José/offset=0/limit=20"


Retorno JSON

Exemplo: 

{
   - header: {
          publicacoes: "39",
          paginas: 2,
          offset: "0",
          limite: "20",
     },
   - publicacao: [
       - {
             publicacao_id: "10013853",
             publicacao_titulo: "Biguassú",
             colecao_id: "0",
             colecao_nome: null,
             tipo_id: "2",
             tipo_descricao: "Monografia",
             periodo_prefixo: "",
             periodo: "1942",
             periodo_sufixo: "",
             complemento: ": notícia estatístico-descritiva",
             dt_informação: "",
             volume: "",
             serie_id: "Publicação",
             serie_numero: "24",
             numero_paginas: "62",
             dt_atualizacao: "2012-11-22 16:40:14",
             editora: "D.E.E",
             edicao: "",
             infoEspecificas: "",
             local: "Florianópolis:",
             autor_nome: "BORN, José N.",
             publicacao_pdf: "//produtos.seade.gov.br/produtos/bibliotecadigital/view/linkPdf.php?pdf=10013853-1.pdf",
         },
         ...
   ]
}
Disponível em "http://doc.seade.gov.br/index.php?title=API-BIBLIOTECA-DIGITAL&oldid=406"