Alentamos a los administradores de páginas web a crear enlaces a nuestro sitio. Para esto, usted puede copiar la URL de la barra de direcciones o bien construir su propia API/URL (ver más adelante). Tenga a bien crear enlaces directos a nuestro sitio y no introducir los contenidos de la página del Banco en el marco de su propio sitio. |
Ahora contamos con una forma nueva y mejor de establecer enlaces con las páginas de resultados y las páginas que contienen los detalles de los documentos. Vea la documentación y los ejemplos que se brindan más adelante.
Documentos e informes: API invariable La sección “Documentos e informes” admite URL simplificadas para dos tipos de páginas: páginas de resultados y páginas con los detalles de los documentos. Nos cercioraremos de que se admita la API invariable aun cuando la sección “Documentos e informes” se traslade a una nueva plataforma en el futuro. De este modo, no hará falta que los usuarios modifiquen las URL que conducen a nuestros documentos. Las URL correspondientes a estas páginas constan de 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á en dicha página. Estas tres partes juntas adoptan la siguiente forma: http:///? Nombre del host En términos técnicos, la primera parte de la URL contiene el nombre del host. Éste será “www-wds.worldbank.org”. Tipo de solicitud La segunda parte de la URL, es decir, el tipo de página que se obtendrá, está determinada por el tipo de solicitud, que puede ser de “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 en forma de “pregunta”, se obtendrá un conjunto de documentos que se corresponden con dicha pregunta.
Tipo de solicitud | Página que se obtiene | Registro | Todos los detalles de un documento en particular, con uno o más enlaces al propio documento. | Pregunta | 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 de la URL consiste en uno o más parámetros y sus respectivos valores. Éstos 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 signo “?”. Para las solicitudes de “registro” se exige un solo parámetro, el “docid” (identificación del proyecto), cuyo valor es el número de identificación que se le da en ImageBank o en la sección “Documentos e informes” al documento que se mostrará en la página. El nombre del parámetro, “docid”, se separa de su valor mediante el signo “=”. Además del docid, las solicitudes de registro también admiten un parámetro opcional, el pageLanguage. Este parámetro determina el idioma de la página en la que se muestra el registro y permite a los sitios cuya lengua no sea el inglés presentar documentos del ImageBank en su mismo idioma. En la actualidad, se admiten solicitudes de 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 (idioma de la página) | El idioma de la página en la que se muestra el registro. No disponible aún. |
Aquí presentamos un ejemplo: www-wds.worldbank.org/record?docid=000160016_20040929135419 Con las solicitudes en forma de “preguntas” se obtiene un conjunto de documentos que se presentan en la página en forma de lista. Las solicitudes en forma de “preguntas” pueden tener uno o más parámetros. Cada parámetro adicional especifica o restringe con más precisión los resultados que se obtendrán y corresponde a un atributo del registro o de los detalles de un documento. El nombre del parámetro se separa de su valor mediante el signo “=”. Cuando se utiliza más de una combinación parámetro / valor, se separan entre sí con el signo “&”. No se utiliza este signo antes de la primera combinación. Para “preguntar” acerca de más de un valor correspondiente a un atributo, incluya combinaciones adicionales de parámetro / valor para dicho atributo (cada una con un solo valor) o bien utilice una vez el nombre del parámetro e incluya la lista de los valores correspondientes, separados por un espacio. Al preguntar acerca de varios valores para un atributo se incrementa el número de documentos que se obtienen, puesto que en los resultados se pueden incluir documentos relativos a cada valor especificado. Al igual que las solicitudes de registro, las “preguntas” también pueden especificar el idioma de la página en la que se mostrarán los resultados. En la actualidad se admiten el francés y el español.
Nombre del parámetro | Valor | Uso | text (texto) | Texto | Una o más palabras. | title (título) | Texto | El título del documento. | collection (colección) | Texto | El título de la colección a la que pertenece el documento. | sourceCitation (cita de la fuente) | Texto | Cita de la fuente. | author (autor) | Texto | El autor del documento. | region (región) | Texto o número de identificación | La región a la que se refiere el documento. | country (país) | Texto o número de identificación | El país al que se refiere el documento. | sector | Texto o número de identificación | El sector al que se refiere el documento. | subsector | Texto o número de identificación | El subsector al que se refiere el documento. | topic (tema) | Texto o número de identificación | El tema al que se refiere el documento. | majorDocType (principal tipo de documento) | Texto o número de identificación | El principal tipo de documento al que pertenece el documento. | docType (tipo de documento) | Texto o número de identificación | El documento. | language (idioma) | Texto o número de identificación | El idioma en el que está escrito el documento o al que fue traducido. | date (fecha) | aaaa/mm/dd | La fecha en que se presentó o se publicó el documento. | startDate (fecha de inicio) | aaaa/mm/dd | El comienzo de un período. Los documentos que se obtienen deben haber sido presentados o publicados en esta fecha o después. Se puede utilizar con fecha de finalización o sin ella. Cuando no se especifica la fecha de finalización, el período concluye el día en curso. | endDate (fecha de finalización) | aaaa/mm/dd | El fin de un período. Los documentos que se obtienen deben haber sido presentados o publicados en esta fecha o antes. Se puede utilizar con fecha de inicio o sin ella. Cuando no se especifica la fecha de inicio, el período incluye todas las fechas anteriores al día en curso. | report (informe) | Número de identificación | El número de informe asignado a este documento. | loan (préstamo) | Número de identificación | El número del préstamo al que corresponde el documento. | credit (crédito) | Número de identificación | El número del crédito asociado a este documento. | project (proyecto) | Texto o número de identificación | El nombre o número de identificación del proyecto al que corresponde este documento. | trustFund (fondo fiduciario) | Número de identificación | El fondo fiduciario al que se asocia este documento. | pageSize (tamaño de la página) | Número | El número de resultados que se exhiben por página (hasta 50). | pageLanguage (idioma de la página) | Número de identificación | El idioma de la página en la que se muestra el registro. En la actualidad se ofrecen el francés y el español. | sortBy (ordenar por) | | El atributo (“fecha”, “título”, “informe” o “tipo de documento”) que se utilizará como criterio para ordenar los resultados. Los resultados aparecen en orden ascendente, salvo en el caso de la fecha, que aparece en orden descendiente. |
A continuación se presentan algunos ejemplos. Para obtener la lista de documentos referidos a un solo tema: www-wds.worldbank.org/query?topic=123090 Para obtener la lista de documentos referidos a un solo tema y un país: www-wds.worldbank.org/query?country=392849& topic=123090 Para obtener todos los documentos publicados o presentados en una fecha determinada: www-wds.worldbank.org/query?date=2004/2/4 Para obtener todos los documentos relacionados con un tema y que fueron publicados o presentados entre dos fechas: www-wds.worldbank.org/query?startDate=2004/1/1&endDate=2004/2/1&topic=909203 Para obtener todos los documentos en árabe: www-wds.worldbank.org/query?language=Arabic
|