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

De SEADE
Ir para: navegação, pesquisa
Linha 156: Linha 156:
 
     ]
 
     ]
 
  }
 
  }
−
 
−
 
−
== Publicações ==
 
−
'''GET'''
 
−
 
−
* '''Path''': /publicacao
 
−
* '''Parâmetros''': inicial e limite
 
−
 
−
Para buscar todas as publicações, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
 
−
 
−
* '''Path''': /publicacao/offset={inicial}/limit={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/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",
 
−
          },
 
−
          ...
 
−
      ]
 
−
  }
 
−
}
 
−
 
−
 
−
 
−
 
−
=== Perfil Municipal - informações do município ===
 
−
'''GET'''
 
−
 
−
Use o formato abaixo para buscar uma variável por requisição.
 
−
 
−
* '''Path''': /infmun
 
−
* '''Parâmetros''': código
 
−
 
−
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
 
−
 
−
* '''Path''': /infmun/{codigo}
 
−
 
−
 
−
=== Sintaxe de chamada ===
 
−
 
−
curl -X GET "http://api-imp.seade.gov.br/v1/infmun/{codigo}"
 
−
 
−
ou
 
−
 
−
curl -X GET "http://api-imp.seade.gov.br/v1/infmun/{codigo}"
 
−
 
−
 
−
=== Retorno JSON ===
 
−
 
−
Exemplo:
 
−
 
−
 
−
{
 
−
  "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 ==
 
−
'''GET'''
 
−
 
−
Use o formato abaixo para buscar uma variável por requisição.
 
−
 
−
* '''Path''': /perfil
 
−
* '''Parâmetros''': código
 
−
 
−
Para buscar todas as variáveis, é necessário informar os parâmetros de paginação, conforme a sintaxe abaixo.
 
−
 
−
* '''Path''': /perfil/{codigo}
 
−
 
−
 
−
=== Sintaxe de chamada ===
 
−
 
−
curl -X GET "http://api-imp.seade.gov.br/v1/perfil/{codigo}"
 
−
 
−
ou
 
−
 
−
curl -X GET "http://api-imp.seade.gov.br/v1/perfil/{codigo}"
 
−
 
−
 
−
=== Retorno JSON ===
 
−
 
−
Exemplo:
 
−
 
−
 
−
{
 
−
  "perfil": [
 
−
    {
 
−
      "codigo_localidade": "503",
 
−
      "localidade": "São Paulo",
 
−
      "codigo_localidade_pai": "681",
 
−
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
 
−
      "codigo_variavel": "1",
 
−
      "variavel": "Crédito Rural",
 
−
      "unidade": "(Em reais de 2015)",
 
−
      "periodo": "1985/1989-2011",
 
−
      "ano": {
 
−
        "2011": "2.339.704.690"
 
−
      }
 
−
    },
 
−
    {
 
−
      "codigo_localidade": "503",
 
−
      "localidade": "São Paulo",
 
−
      "codigo_localidade_pai": "681",
 
−
      "nome_localidade_pai": "Região Metropolitana de São Paulo",
 
−
      "codigo_variavel": "2",
 
−
      "variavel": "Crédito Rural Agricultura",
 
−
      "unidade": "(Em reais de 2015)",
 
−
      "periodo": "1985/1989-2011",
 
−
      "ano": {
 
−
        "2011": "1.605.918.449"
 
−
      }
 
−
    },
 
−
    {
 
−
      "codigo_localidade": "503",
 
−
      "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 das 19h39min de 17 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",
        },
      ...
   ]
}
Disponível em "http://doc.seade.gov.br/index.php?title=API-BIBLIOTECA-DIGITAL&oldid=367"