Informações avançadas
A versão beta da API é restrita aos usuários cadastrados. Cada usuário possui uma chave de identificação, que deve ser informado no cabeçalho de autenticação de cada requisição.
Peça sua chave de identificação através do nosso formulário.
Exemplo de solicitação para a API usando o utilitário curl:
curl "https://api.bvsalud.org/references/v1/search/portal/?q=cancer" -H 'apikey:<SUA CHAVE DE API>'
Abaixo estão os parâmetros que você pode usar na sua requisição:
q: informa a busca a ser processada. A tabela Campos de pesquisa mostra os campos que podem ser usados na expressão de pesquisa.
?q=ti:malaria
from: indica o registro inicial a ser considerado na exportação, este parâmetro é útil para realizar a coleta em diversas chamadas, por exemplo, coletando 1000 registros de cada vez.
?q=ti:malaria&from=0
count: indica a quantidade de registros a ser retornado na coleta.
?q=ti:malaria&from=0&count=100
output: informa o formato de exportação a ser retornado. Opções disponíveis: xml, json, csv, ris.
?q=ti:malaria&from=0&count=100&output=json
output_as_file:para os formatos ris e csv indica se deve ser gerado um arquivo para download (true) ou se o resultado deve ser retornado diretamente (false). (default=true).
?q=ti:malaria&from=0&count=100&output=csv&output_as_file=true
Ver detalhes dos formatos de exportação
Campos de pesquisa
| Código | Nome do campo | Descrição | Exemplo |
|---|---|---|---|
| TW | Palavras | Palavras do título, resumo, descritores de assunto e outros campos de descrição bibliográfica das publicações, tais como palavras-chave de autores, tipo de estudo etc | tw:aids |
| TI | Título | Palavras do título original das publicacções e suas traduções | ti:aids ti:“doencas geneticas” |
| MH | Assunto | Descritores DeCS/MeSH que representam os assuntos abordados nas publicações | mh:Colera |
| MJ | Assunto principal | Descritores DeCS/MeSH principais dos assuntos abordados nas publicações | mj:Colera |
| PT | Tipo de Estudo | Designado automaticamente para a publicação, quando a mesma cumpre com os critérios de recuperação das respectivas estratégias de busca por tipo de estudo | pt:Revisão pt:“Relatos de casos” pt:“Guia de pratica clinica” |
| AU | Autor | Nomes e sobrenomes dos autores das publicações. A forma de representação dos nomes dos autores é diferente na base MEDLINE e bases produzidas pela BIREME que seguem a metodologia LILACS. MEDLINE – sobrenome seguido de iniciais do nome, por exemplo, Jatene AD. LILACS – sobrenome e nomes completos ou abreviados, como está na publicação, e separados por vírgula, por exemplo, Jatene, Adib Domingues Jatene, Adib D Jatene, Adib | au:“Jatene AD” au:“Jatene, Adib D” au:“Jatene, Adib” au:“Jatene, AD” |
| TA | Revista | Título da Revista em sua forma abreviada | ta:Jama |
| LA | Idioma | Idioma do objeto digital da publicação no formato (ISO 639-1) | la:es la:en la:pt la:fr |
| AB | Resumo | Palavras do resumo das publicações, nos idiomas que o resumo é apresentado. Na Medline todos os resumos estão em inglês, independente do idioma do texto. | ab:“doencas geneticas” ab:Chikungunya |
| DA | Ano de publicação | Representa o ano e mês de publicação e deve ser representado pelos 4 dígitos do ano e dois dígitos do mês (YYYYMM). Pode-se truncar usando $ ou * para incluir na busca um período maior que um mês. | da:2014$ (para todos os meses de 2014) da:201$ (recupera docs a partir do ano 2000) da:201402 (recupera documentos de fevereiro de 2014) |
| DB | Base de dados | Sigla da base de dados onde a publicação foi indexada | db:“LILACS” (para todos os registros da base LILACS) |
| CP | País de publicação | País em que o documento foi publicado. Digitar o nome do país entre aspas e em caixa alta ou o código (ISO 3166-1 alpha-2) | cp:“BRASIL” cp:“COSTA RICA” |
| SH | Qualificador de assunto | Define aspectos de um assunto. Digitar o qualificador entre aspas. | sh:“Prevencao & Controle” sh:“Diagnostico” |
| ID | Identificador único | Identificador atribuído a cada documento de acordo com a Base de Dados que pertence. | id:sigla da base-identificador id:mdl-27077095 id:lil-779656 id:biblio-984509 |
| JD | Assunto de revista | Define o assunto principal da revista. Digitar o assunto entre aspas em caixa alta. | jd:“CARDIOLOGIA” jd:“ALERGIA E IMUNOLOGIA” |
| AI | Autor institucional | Quando a instituição é autora do documento | ai:“University of Kansas Medical Center” ai:“Centro Latino-Americano e do Caribe de Informação em Ciências da Saúde” |
| ENTRY_DATE | Data de entrada do documento | Data de criação do registro bibliográfico na base de dados no formato YYYYMMDD | entry_date:20190816 entry_date:201908* |
| AID | Identificador de artigo | Identificador globalmente único de objetos digitais, como o DOI | aid:“10.1016/j.vaccine.2020.01.093” |
| AUID | Identificador de autor | identificador globalmente único do autor, como o ORCID | auid:“0000-0003-3504-118X” |
| AFP | País de afiliação | País de afiliação do autor da publicação. Digitar o país entre aspas. | afp:“brasil” afp:“costa rica” |
| CC | Código do Centro Cooperante | Código do Centro Cooperante da BVS responsável pela catalogação e/ou indexação da publicação | cc:“BR1.1” |