Alentamos a los desarrolladores a visitar nuestro sitio. Pueden hacerlo copiando el enlace URL en la barra de direcciones o creando su propia API / URL (vea más adelante). Les pedimos que creen enlaces directos a nuestro sitio y no incorporen la página del Banco en el marco de su propio sitio.
Ahora contamos con una nueva y mejor manera de establecer enlaces con las páginas de resultados y las páginas que contienen detalles de los documentos. Consulte la documentación y los ejemplos a continuación.
Documentos e informes - API invariante
Documentos e informes admitirá los enlaces URL simplificados para dos tipos de páginas: las de resultados y las que contienen detalles de los documentos. Nos aseguraremos de admitir la API invariante aun cuando Documentos e informes se traslade a una nueva plataforma en el futuro, de modo que los usuarios no necesiten cambiar sus URL que los enlazan a nuestros documentos.
Los URL de estas páginas tienen tres partes, que en conjunto determinan: 1) con qué aplicación se abordará la solicitud, 2) qué tipo de página se obtendrá, y 3) qué documento o conjunto de documentos se presentarán en esa página.
Estas tres partes juntas adoptan la siguiente forma.
http:///?
Nombre del anfitrión
En términos técnicos, la primera parte del URL contiene el nombre del anfitrión (host). Este será "www.documentos.bancomundial.org".
Tipo de solicitud
La segunda parte del URL, es decir el tipo de página que se obtendrá, está determinada por el tipo de solicitud, que puede ser "registro" o "pregunta". Con una solicitud de "registro", se obtendrán los detalles (o el registro de datos) relativos a un documento en particular. Con una solicitud de "pregunta", se recibirá un conjunto de documentos que es adecuado a dicha consulta.
| Tipo de solicitud | Página que se obtiene |
|---|---|
| record | Todos los detalles de un documento en particular, con uno o más enlaces al propio documento. |
| query | Un conjunto de documentos que se corresponden con la pregunta y se presentan en forma de lista o cuadro. |
Lista de parámetros
La tercera y última parte del URL consiste en uno o más parámetros y sus respectivos valores. Estos especifican el documento o conjunto de documentos que se presentarán en la página. La lista de parámetros y sus valores está separada del tipo de solicitud que la precede mediante el carácter "?".
Para las solicitudes de "registro" se exige un solo parámetro, "docid", cuyo valor es el número de identificación que se le da en ImageBank o en Documentos e informes al documento que se mostrará en la página. El nombre del parámetro, "docid", está separado de su valor mediante el signo "=".
Además del “docid”, las solicitudes de registro también admiten un parámetro opcional, el “pageLanguage”. Este determina el idioma de la página en la que se muestra el registro y permite a los sitios que no estén en inglés presentar documentos del ImageBank en su mismo idioma. En la actualidad, se admiten solicitudes en francés y español.
| Nombre del parámetro | Uso |
|---|---|
| docid | Número de identificación que se le da en Documentos e informes al documento cuyos detalles aparecerán en la página. |
| pageLanguage | El idioma de la página en la que se muestra el registro. No disponible aún. |
Vea un ejemplo:
documentos.bancomundial.org/record?docid=000160016_20040929135419
En las solicitudes de “pregunta” se pide un conjunto de documentos presentados como una lista en la página que se obtiene. Las consultas pueden tener uno o más parámetros. Cada parámetro adicional especifica más estrictamente o restringe lo que será recibido. Estos parámetros corresponden a un atributo en el registro o en los detalles del documento. El nombre de cada parámetro está separado de su valor mediante un signo "=". Cuando se utiliza más de un par de parámetros/valores, cada nuevo par está separado del anterior mediante el carácter "&". No se coloca el carácter "&" antes del primer par. Para realizar una consulta sobre más de un valor para un atributo, se puede incluir pares adicionales de parámetros/valores para ese atributo (cada uno con un valor único), o bien utilizar el nombre del parámetro una vez y enumerar los valores, separando los valores con un espacio. Hacer una consulta sobre varios valores para un atributo aumenta el número de documentos obtenidos ya que se pueden incluir en los resultados los documentos para cada valor.
Al igual que las solicitudes de registros, las “preguntas” también pueden especificar el idioma de la página en la que se mostrarán los resultados. Actualmente, se admiten el francés y el español.
| Nombre del parámetro | Valor | Uso |
|---|---|---|
| text | text | Una o más palabras. |
| title | text | Título del documento. |
| collection | text | Título de la colección a la que pertenece el documento. |
| sourceCitation | Text | Cita de la fuente. |
| author | text | Un autor del documento. |
| region | text or ID | Región a la que pertenece el documento. |
| country | text or ID | País al que pertenece el documento. |
| sector | text or ID | Sector al que pertenece el documento. |
| subsector | text or ID | Subsector al que pertenece el documento. |
| topic | text or ID | Un tema abordado por el documento. |
| majorDocType | text or ID | Tipo principal de documento al que pertenece el documento. |
| docType | text or ID | El documento |
| language | text or ID | Idioma de redacción o traducción del documento. |
| date | yyyy/mm/dd | Fecha de envío o publicación del documento. |
| startDate | yyyy/mm/dd | Comienzo de un rango de fechas. Los documentos obtenidos deben presentarse o publicarse en esa fecha o después. Puede utilizarse con o sin endDate. Cuando no se usa endDate, el rango termina con la fecha presente. |
| endDate | yyyy/mm/dd | Fin de un rango de fechas. Los documentos obtenidos deben presentarse o publicarse en esa fecha o antes. Puede utilizarse con o sin startDate. Cuando no se usa startDate, el rango incluye todas las fechas anteriores a la presente. |
| report | ID | Número de informe asignado a este documento. |
| loan | ID | Número del préstamo al que pertenece este documento. |
| credit | ID | Número del crédito asociado con este documento. |
| project | text or ID | Nombre o número de identificación del proyecto al que pertenece este documento. |
| trustFund | ID | Fondo fiduciario asociado con este documento. |
| pageSize | number | Número de resultados que se mostrarán por página (hasta 50). |
| pageLanguage | ID | Idioma de la página en que muestra el registro. Actualmente se admiten el francés y el español. |
| sortBy | Atributo (“fecha”, “título”, “informe” o “tipo de documento”) según el cual deben clasificarse los resultados. La clasificación es en orden ascendente excepto para la fecha, que es en orden descendente. |
Vea algunos ejemplos:
Hacer una lista de documentos sobre un solo tema...
documentos.bancomundial.org/query?topic=Education
Hacer una lista de documentos relacionados con un solo tema y país…
documentos.bancomundial.org/query?country=China9&topic=Education
Obtener todos los documentos publicados o dados a conocer en una fecha exacta…
documentos.bancomundial.org/query?date=2004/2/4
Obtener todos los documentos publicados o dados a conocer sobre un tema publicado o dado a conocer entre dos fechas...
documentos.bancomundial.org/query?startDate=2004/1/1&endDate=2004/2/1&topic=Agriculture
Obtener todos los documentos en árabe...
documentos.bancomundial.org/query?language=Arabic