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

De SEADE
Ir para: navegação, pesquisa
(→‎Dados)
 
(29 edições intermediárias de 2 usuários não apresentadas)
Linha 1: Linha 1:
 
= Apresentação =
 
= 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.
+
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 ==
 
== 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 53: Linha 54:
 
  }
 
  }
  
−
== Fonte ==
+
== Coleções ==
 
'''GET'''
 
'''GET'''
  
  
−
* '''Path''': /fonte
+
* '''Path''': /colecao
 +
* '''Parâmetros''': id
  
−
* '''Parâmetros''': código
 
  
−
Caso o código não seja passado, a busca trará todas as fontes.
+
<nowiki>* Não é obrigatório a informação do id .</nowiki>
  
 +
<nowiki>* Não coloque o id se quiser ver todas as coleções.</nowiki>
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/fonte"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/colecao"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/fonte/{codigo}"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/colecao/24"
  
  
Linha 78: Linha 80:
  
 
  {
 
  {
−
     "fonte": {
+
     - colecao: [
−
         "codigo": "10",
+
         - {
−
        "nome": "Companhia Energética de São Paulo  –  CESP."
+
            id: "24",
−
    }
+
            nome: "Perfil Municipal",
 +
            dt_atualizacao: "2017-10-02 15:08:26",
 +
        }
 +
    ]
 
  }
 
  }
  
−
 
+
== Autores ==
−
== Localidade ==
+
 
'''GET'''
 
'''GET'''
  
  
−
* '''Path''': /localidade
+
* '''Path''': /autor
 +
* '''Parâmetros''': id
  
−
* '''Parâmetros''': código
 
  
−
Caso o código não seja passado, a busca trará todas as localidades.
+
<nowiki>* Não é obrigatório a informação do id .</nowiki>
  
 +
<nowiki>* Não coloque o id se quiser ver todos os autores.</nowiki>
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/localidade"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/autor"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/localidade/{codigo}"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/autor/543"
  
  
Linha 110: Linha 115:
  
 
  {
 
  {
−
     "localidade": {
+
     - autor: [
−
         "codigo": "10",
+
         - {
−
        "nome": "Altinópolis",
+
            id: "543",
−
         "nivel": "Altinópolis",
+
            nome: "AFTALION, Albert",
−
        "codigo_pai": "731",
+
            dt_atualizacao: "2014-09-08 15:26:04",
−
        "nome_pai": "Região de Governo de Ribeirão Preto"
+
        }
−
    }
+
    ]
 +
}
 +
 
 +
== Ano da publicação ==
 +
'''GET'''
 +
 
 +
 
 +
* '''Path''': /anopublicacao
 +
 
 +
 
 +
<nowiki>* Lista todos os anos e quantidades de publicações</nowiki>
 +
 
 +
=== 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",
 +
        },
 +
      ...
 +
    ]
 
  }
 
  }
  
  
−
== Nota ==
+
== Títulos das Publicações ==
 
'''GET'''
 
'''GET'''
  
  
−
* '''Path''': /nota
+
* '''Path''': /titulo/{id}/offset={inicial}/limit={limite}
 +
* '''Parâmetros''': id, inicial e limite
  
−
* '''Parâmetros''': código
+
<nowiki>* Não é obrigatório a informação do id.</nowiki>
  
−
Caso o código não seja passado, a busca trará todas as notas cadastradas.
+
<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 ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/nota"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/titulo/offset=0/limit=50"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/nota/{codigo}"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/titulo/10011143"
  
  
Linha 145: Linha 188:
  
 
  {
 
  {
−
     "nota": {
+
     - header: {
−
        "codigo": "100",
+
          publicacoes: "9153",
−
         "descricao": "No modelo de projeção utilizado, ou seja para os anos de 1997 e 1998, foi considerado um ajuste na ..."
+
          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",
 +
          },
 +
          ...
 +
    ]
 
  }
 
  }
  
−
== Variável ==
+
== Publicações ==
 
'''GET'''
 
'''GET'''
  
−
Use o formato abaixo para buscar uma variável por requisição.
 
  
−
* '''Path''': /variavel
+
* '''Path''': /publicacao/{busca}/offset={inicial}/limit={limite}
−
* '''Parâmetros''': código
+
* '''Parâmetros''': busca, inicial e limite
 +
* '''busca''': palavra(s) de qualquer parte da referência bibliográfica da publicação
  
−
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
 
  
−
* '''Path''': /variavel?offset={inicial}&limit={limite}
+
<nowiki>* Não é obrigatório a informação da busca .</nowiki>
  
 +
<nowiki>* Não coloque a busca se quiser ver todas as publicações por paginação.</nowiki>
 +
 +
<nowiki>* Limite máximo de publicações por página = 20</nowiki>
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/variavel/{codigo}"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/offset=0/limit=20"
  
 
ou
 
ou
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/variavel?offset=0&limit=10"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/anuário/offset=0/limit=20"
  
  
Linha 176: Linha 244:
  
 
Exemplo:
 
Exemplo:
−
 
  
 
  {
 
  {
−
  "variavel": {
+
    - header: {
−
      "codigo": "55",
+
          publicacoes: "9153",
−
      "nome": "População",
+
          paginas: 458,
−
      "unidade": "Não possui unidade",
+
          offset: "0",
−
      "periodo": "1980-2013",
+
          limite: "20",
−
       "definicao": "Não possui definicao",
+
       },
−
      "fonte": [
+
    - publicacao: [
−
        "Instituto Brasileiro de Geografia e Estatística – IBGE.",
+
        - {
−
        "Fundação Seade."
+
              publicacao_id: "10021400",
−
      ],
+
              publicacao_titulo: "20 anos no ano 2000",
−
      "nota": [
+
              colecao_id: "0",
−
        "Os dados referem-se aos municípios de acordo com a divisão administrativa do Estado de São Paulo vigente no respectivo período:
+
              colecao_nome: null,
−
          - até 1982, 571 municípios;         
+
              tipo_id: "2",
−
          - de 1983 a 1992, 572 municípios;
+
              tipo_descricao: "Monografia",
−
          - de 1993 a 1996, 625 municípios;
+
              periodo_prefixo: null,
−
          - a partir 1997, 645 municípios.",
+
              periodo: "1998",
−
        "As populações aqui apresentadas resultam de projeções elaboradas pelo método dos componentes demográficos. Este método considera as tendências de fecundidade,  
+
              periodo_sufixo: null,
−
        mortalidade e migração, a partir das estatísticas vitais processadas na Fundação Seade, e a formulação de hipóteses de comportamento futuro para estes
+
              complemento: ": estudos sociodemográficos sobre a juventude paulista",
−
        componentes. A população de base, por idade e sexo, considera os resultados correspondentes aos diversos Censos Demográficos realizados pelo IBGE. As
+
              dt_informação: null,
−
        populações projetadas referem-se a 1º de julho de cada ano. Para maiores informações, ver
+
              volume: null,
−
        <a href="http://www.seade.gov.br/produtos/projpop/pdfs/projpop_metodologia.pdf" target="_blank">Metodologia</a>."
+
              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
  
−
== Perfil Municipal - informações do município ==
 
−
'''GET'''
 
  
−
Use o formato abaixo para buscar uma variável por requisição.
+
<nowiki>* Limite máximo de publicações por página = 20</nowiki>
  
−
* '''Path''': /infmun
+
=== Sintaxe de chamada ===
−
* '''Parâmetros''': código
+
  
−
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
+
curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/tipo/1/offset=0/limit=20"
  
−
* '''Path''': /infmun/{codigo}
 
  
 +
=== 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
 +
 +
 +
<nowiki>* Limite máximo de publicações por página = 20</nowiki>
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/infmun/{codigo}"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/colecao/1/offset=0/limit=20"
  
−
ou
 
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/infmun/{codigo}"
+
=== 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
 +
 
 +
<nowiki>* Limite máximo de publicações por página = 20</nowiki>
 +
 
 +
=== Sintaxe de chamada ===
 +
 
 +
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/ano/1970/offset=0/limit=20"
  
  
Linha 233: Linha 409:
 
Exemplo:
 
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",
 +
          },
 +
          ...
 +
    ]
 +
}
  
−
{
 
−
  "infmun": [
 
−
    {
 
−
      "codigo_localidade": "503",
 
−
      "localidade": "São Paulo",
 
−
      "loc_pai": "Região Metropolitana de São Paulo",
 
−
      "loc_pai2": "Total do Estado de São Paulo",
 
−
      "aniversario": "25 de janeiro",
 
−
      "link_historico": "http://www.seade.gov.br/produtos/perfil/hist/hist_503.pdf",
 
−
      "santo_padroeiro": "Nossa Senhora da Penha de Franca"
 
−
    }
 
−
  ]
 
−
}
 
  
−
== Perfil Municipal - dados ==
+
== Publicações por Título==
 
'''GET'''
 
'''GET'''
  
−
Use o formato abaixo para buscar uma variável por requisição.
 
  
−
* '''Path''': /perfil
+
* '''Path''': /publicacao/titulo/{busca}/offset={inicial}/limit={limite}
−
* '''Parâmetros''': código
+
* '''Parâmetros''': busca, inicial e limite
 +
* '''busca''': titulo ou palavra(s) do título
  
−
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
 
−
 
−
* '''Path''': /perfil/{codigo}
 
  
 +
<nowiki>* Limite máximo de publicações por página = 20</nowiki>
  
 
=== Sintaxe de chamada ===
 
=== Sintaxe de chamada ===
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/perfil/{codigo}"
+
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/titulo/demográfico/offset=0/limit=20"
  
−
ou
 
  
−
  curl -X GET "http://api-imp.seade.gov.br/v1/perfil/{codigo}"
+
=== 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
 +
 
 +
 
 +
<nowiki>* Limite máximo de publicações por página = 20</nowiki>
 +
 
 +
=== Sintaxe de chamada ===
 +
 
 +
  curl -X GET "http://api-bibliotecadigital.seade.gov.br/v1/publicacao/autor/José/offset=0/limit=20"
  
  
Linha 274: Linha 522:
 
Exemplo:
 
Exemplo:
  
−
 
+
{
−
{
+
    - header: {
−
  "perfil": [
+
          publicacoes: "39",
−
    {
+
          paginas: 2,
−
      "codigo_localidade": "503",
+
          offset: "0",
−
      "localidade": "São Paulo",
+
          limite: "20",
−
      "codigo_localidade_pai": "681",
+
       },
−
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
+
    - publicacao: [
−
       "codigo_variavel": "1",
+
        - {
−
      "variavel": "Crédito Rural",
+
              publicacao_id: "10013853",
−
      "unidade": "(Em reais de 2015)",
+
              publicacao_titulo: "Biguassú",
−
      "periodo": "1985/1989-2011",
+
              colecao_id: "0",
−
      "ano": {
+
              colecao_nome: null,
−
        "2011": "2.339.704.690"
+
              tipo_id: "2",
−
      }
+
              tipo_descricao: "Monografia",
−
    },
+
              periodo_prefixo: "",
−
    {
+
              periodo: "1942",
−
      "codigo_localidade": "503",
+
              periodo_sufixo: "",
−
      "localidade": "São Paulo",
+
              complemento: ": notícia estatístico-descritiva",
−
      "codigo_localidade_pai": "681",
+
              dt_informação: "",
−
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
+
              volume: "",
−
      "codigo_variavel": "2",
+
              serie_id: "Publicação",
−
      "variavel": "Crédito Rural Agricultura",
+
              serie_numero: "24",
−
      "unidade": "(Em reais de 2015)",
+
              numero_paginas: "62",
−
      "periodo": "1985/1989-2011",
+
              dt_atualizacao: "2012-11-22 16:40:14",
−
      "ano": {
+
              editora: "D.E.E",
−
        "2011": "1.605.918.449"
+
              edicao: "",
−
      }
+
              infoEspecificas: "",
−
    },
+
              local: "Florianópolis:",
−
    {
+
              autor_nome: "BORN, José N.",
−
      "codigo_localidade": "503",
+
              publicacao_pdf: "//produtos.seade.gov.br/produtos/bibliotecadigital/view/linkPdf.php?pdf=10013853-1.pdf",
−
      "localidade": "São Paulo",
+
          },
−
      "codigo_localidade_pai": "681",
+
          ...
−
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
+
    ]
−
      "codigo_variavel": "3",
+
}
−
      "variavel": "Crédito Rural Pecuária",
+
−
      "unidade": "(Em reais de 2015)",
+
−
      "periodo": "1985/1989-2011",
+
−
      "ano": {
+
−
        "2011": "733.786.243"
+
−
      }
+
−
    },
+
−
...
+

Edição atual tal como às 15h30min 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"