API-BIBLIOTECA-DIGITAL

De SEADE
Edição feita às 18h39min de 17 de maio de 2018 por Luiza (disc | contribs)

Ir para: navegação, pesquisa

Í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",
        },
      ...
   ]
}