Información avanzada
La versión beta de la API está restringida a usuarios registrados. Cada usuario tiene una clave de identificación, la cual debe ser informada en el encabezado de autenticación de cada solicitud.
Solicite su clave de identificación utilizando nuestro formulario.
Ejemplo de solicitud a la API usando el utilitario curl:
curl "https://api.bvsalud.org/references/v1/search/portal/?q=cancer" -H 'apikey:<TU CLAVE DE API>'
A continuación se muestran los parámetros que puede utilizar en su solicitud:
q: expresión de búsqueda. La tabla Campos de búsqueda muestra los campos que se pueden usar en la expresión de búsqueda.
?q=ti:malaria
from: registro inicial para la exportación. Este parámetro es útil para realizar la cosecha en varias llamadas, por ejemplo, cosechando 1000 registros a la vez.
?q=ti:malaria&from=0
count: cantidad de registros que se devolverán en la cosecha.
?q=ti:malaria&from=0&count=100
output: formato de exportación que se devolverá. Opciones disponibles: xml, json, csv, ris.
?q=ti:malaria&from=0&count=100&output=json
output_as_file: para formatos ris y csv indica si se debe generar un archivo para descargar (true) o si el resultado debe devolverse directamente (false). (default=true).
?q=ti:malaria&from=0&count=100&output=csv&output_as_file=true
Ver detalles de los formatos de exportación
Campos de búsqueda
| Código | Nombre del campo | Descripción | Ejemplo |
| TW | Palabras | Palabras de título, resumen, descriptores de asunto y otros campos de descripción bibliográfica de publicaciones, como palabras clave de autor, tipo de estudio, etc. | tw:aids |
| TI | Título | Palabras del título original de las publicaciones y sus traducciones. | ti:aids ti:"doencas geneticas" |
| MH | Asunto | Descriptores DeCS/MeSH que representan los asunto cubiertos en las publicaciones | mh:Colera |
| MJ | Asunto principal | Principales descriptores DeCS/MeSH de los asuntos tratados en las publicaciones | mj:Colera |
| PT | Tipo de estudio | Asignado automáticamente a la publicación cuando cumple los criterios de recuperación de las respectivas estrategias de búsqueda por tipo de estudio | pt:Revisão pt:"Relatos de casos" pt:"Guia de pratica clinica" |
| AU | Autor | Nombres y apellidos de autores de publicaciones. La forma de representación de los nombres de los autores es diferente en la base de datos MEDLINE y en las bases de datos producidas por BIREME que siguen la metodología LILACS. MEDLINE – apellido seguido de las iniciales del nombre, por ejemplo, Jatene AD. LILACS – apellido y nombres completos o abreviados, como en la publicación, y separados por una coma, por ejemplo, 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 de la revista en su forma abreviada | ta:Jama |
| LA | Idioma | Idioma del objeto digital de la publicación en el formato (ISO 639-1) | la:es la:en la:pt la:fr |
| AB | Resumen | Palabras del resumen de publicaciones, en los idiomas en los que se presenta el resumen. En Medline, todos los resúmenes están en inglés, independientemente del idioma del texto. | ab:"doencas geneticas" ab:Chikungunya |
| DA | Año de publicacion | Representa el año y mes de publicación y debe estar representado por el año de 4 dígitos y el mes de dos dígitos (AAAAMM). Puede truncar usando $ o * para incluir un período superior a un mes en la búsqueda. | 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 datos | Acrónimo de la base de datos donde se indexó la publicación | db:"LILACS" (para todos os registros da base LILACS) |
| CP | País de publicación | País donde se publicó el documento. Ingrese el nombre del país entre comillas y en mayúsculas o el código (ISO 3166-1 alpha-2) | cp:"BRASIL" cp:"COSTA RICA" |
| SH | Calificador de asunto | Define aspectos de un asunto. Ingrese el calificador entre comillas. | sh:"Prevencao & Controle" sh:"Diagnostico" |
| ID | identificador único | Identificador asignado a cada documento según la Base de Datos a la que pertenece. | id:sigla da base-identificador id:mdl-27077095 id:lil-779656 id:biblio-984509 |
| JD | Asunto de revista | Define el asunto principal de la revista. Escribe el asunto entre comillas en mayúsculas. | jd:"CARDIOLOGIA" jd:"ALERGIA E IMUNOLOGIA" |
| AI | Autor institucional | Cuando la institución es la autora del 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 | Fecha de entrada del documento | Fecha de creación del registro bibliográfico en la base de datos en formato AAAAMMDD | entry_date:20190816 entry_date:201908* |
| AID | Identificador de artículo | Identificador único global de objetos digitales como DOI | aid:"10.1016/j.vaccine.2020.01.093" |
| AUID | Identificador de autor | identificador único global del autor, como ORCID | auid:"0000-0003-3504-118X" |
| AFP | País de afiliación | País de afiliación del autor de la publicación. Ingrese el país entre comillas. | afp:"brasil" afp:"costa rica" |
| CC | Código del Centro Cooperante | Código del Centro Colaborador de la BVS responsable de catalogar y/o indexar la publicación | cc:"BR1.1" |