INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES API
La API (Application Program Interface) de INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES
permite a cualquier persona interactuar programaticamente con INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES.
En uso de la API de INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES
es gratuito, y devuelve datos generados por
INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES en un formato que es facilmente integrado con una aplicación o página web.
Esta es la primera versión de la API de INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES. Actualmente ofrece un grupo de
llamadas básicas, pero muy pronto iremos añadiendo mayores funcionalidades.
En este momento, la API de INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES acepta llamadas tipo "REST" y devuelve los resultados
en formato XML.
Más adelante es posible que ofrezcamos otras maneras de acceder a la API así como otros formatos
a usar en los resultados.
Las llamadas actuales se pueden agrupar en tres clases: Sitio, Noticias y Usuarios
<corank siteid="437">
<title>Título de este sitio</title>
<descr>Descripción de este stio</descr>
<locale>es</locale>
<ownerid>2735</ownerid>
<vup>Interestante</vup>
<vdown>Aburrido</vdown>
<sword>fuente</sword>
<swords>fuentes</swords>
</corank>
Detalles de la respuesta::
vup y vdown son
las palabras definidas para las acciones de votar positiva y negativamente.
sword es la palabra definida para referirse a "fuente" (fuente/amigo/contacto, etc).
swords es la misma palabra pero en plural.
coRank.Site.GetCategories
Devuelve una lista de las categorías defindas en el sitio.
idname es el nombre usado en las URLs para esa categoría,
por ejemplo http://civilinfra.corank.com/tech/all/cat/arts
El valor entre las etiquetas <cat>...</cat> es el nombre que describe la categoría.
La respuesta contiene todas las categorías definidas en el sitio.
coRank.Site.GetTotalStats
Devuelve:
El número total de usuarios registrados en el sitio.
Este número no es el total de personas que han visitado el sitio. Solo
se cuentan usuarios registrados.
Devuelve casi todo lo que puedas necesitar sobre una noticia.
Posiblemente sea la función más usada de toda la API.
Parámetros:
Puede tomar bien 'id' o 'url' pero no ámbas.
id
El ID numérico de la noticia.
url
El path identificador de la noticia.
Ejemplo de llamada:
Con el ID numérico: http://civilinfra.corank.com/api/coRank.News.GetItem/id=771
Con el path: http://civilinfra.corank.com/api/coRank.News.GetItem/url=todo-pasa-y-todo-queda
En el segundo ejemplo estamos pidiendo información sobre la entrada que puede ser
accedida directamente visitando
http://civilinfra.corank.com/tech/story/todo-pasa-y-todo-queda
La etiqueta item incluye siempre los valores siguientes:
id: El ID numérico de la noticia
pvotes: Número total de votos positivos en este momento
nvotes: Número total de votos negativos en este momento
comments: Número total de comentarios en este momento
catid: El ID numérico de la categoría de esta noticia
senderid: El ID numérico de la persona que envió la noticia.
Si se permiten envíos anónimos, el valor será cero (0).
sendernick: El nombre del usuario (alias) que envió la
noticia. Si se permiten envíos anónimos, el valor será "Desconocido"
(sin las comillas).
urlname:
El path para esta noticia. Por ejemplo, si la URL para aceder esta noticia es
http://civilinfra.corank.com/tech/story/todo-pasa-y-todo-queda, el valor de "urlname"
será "todo-pasa-y-todo-queda" (sin las comillas).
sdate:
La fecha en la que se publicó la noticia (PST/PDT).
El valor es el número de segundos desde las 00:00:00 del 1 de Enero de 1970 (Epoch).
El valor entre las etiquetas <link>...</link> es
la URL completa de la noticia original.
El valor de title y description
son el título y la descripción de la noticia.
Observa que el contenido de description
podría usar varias líneas, como por ejemplo:
<description>Esta noticia no trata nada
interesante.</description>
El contenido entre las etiquetas
tag son las "tags" o etiquedas asignadas a la noticia. Si no
se asignó ninguna "tag", el resultado no incluirá
la sección <tags>...</tags>
coRank.News.GetItemFromUrl
Esta función es idéntica a la anterior, excepto que el único parámetro que toma,
en lugar de ser el ID de la noticia o el "path" identificador, toma
la URL de la página original.
Es por tanto la función ideal para saber si una página ha sido ya
enviada o no.
La etiqueta item incluye siempre los valores siguientes:
id: El ID numérico de la noticia
pvotes: Número total de votos positivos en este momento
nvotes: Número total de votos negativos en este momento
comments: Número total de comentarios en este momento
catid: El ID numérico de la categoría de esta noticia
senderid: El ID numérico de la persona que envió la noticia.
Si se permiten envíos anónimos, el valor será cero (0).
sendernick: El nombre del usuario (alias) que envió la
noticia. Si se permiten envíos anónimos, el valor será "Desconocido"
(sin las comillas).
urlname:
El path para esta noticia. Por ejemplo, si la URL para aceder esta noticia es
http://civilinfra.corank.com/tech/story/todo-pasa-y-todo-queda, el valor de "urlname"
será "todo-pasa-y-todo-queda" (sin las comillas).
sdate:
La fecha en la que se publicó la noticia (PST/PDT).
El valor es el número de segundos desde las 00:00:00 del 1 de Enero de 1970 (Epoch).
El valor entre las etiquetas <link>...</link> es
la URL completa de la noticia original.
El valor de title y description
son el título y la descripción de la noticia.
Observa que el contenido de description
podría usar varias líneas, como por ejemplo:
<description>Esta noticia no trata nada
interesante.</description>
El contenido entre las etiquetas
tag son las "tags" o etiquedas asignadas a la noticia. Si no
se asignó ninguna "tag", el resultado no incluirá
la sección <tags>...</tags>
coRank.News.GetCatItems
Devuelve el listado de noticias bajo una categoría determinada.
El número máximo de noticias que pueden aparecer en los resultados es 100.
Para obtener noticias más allá de la posición 100, deberás utilizar los parámetros
"start" y "end".
Si la diferencia "end" menos "start" es mayor de 100, el valor de "end" se ignorará,
y solo se incluirá en los resultados las primeras 100 noticias, empezando por la
que esté en la posición "start".
Parámetros:
id
ID de la cagegoría.
start
Indice inicial. Si no se incluye, se asume que es 1.
end
Indice final. Debe ser un número mayor de "start". Si no se incluye,
se asume que será start+100
Ejemplo de llamada:
Para obtener los primeros 100 resultados: http://civilinfra.corank.com/api/coRank.News.GetCatItems/id=16&start=1&end=100
Para obtener los resultados desde el 100 al 150: http://civilinfra.corank.com/api/coRank.News.GetCatItems/id=16&start=100&end=150
El valor de total dentro de la etiqueta cat indica
el número total de noticias bajo la categoría indicada.
Las etiquetas item (una por noticia) contienen los siguientes valores:
id: El ID numérico de la noticia.
index: La posición en los resultados.
coRank.News.GetComments
Devuelve todos los comentarios publicados sobre una noticia.
Parámetros:
Puede tomar bien 'id' o 'url' pero no ámbas.
id
El ID numérico de la noticia.
url
El path the la noticia.
Ejemplo de llamada:
Con el ID numérico: http://civilinfra.corank.com/api/coRank.News.GetComments/id=771
Con el path de la URL: http://civilinfra.corank.com/api/coRank.News.GetComments/url=todo-pasa-y-todo-queda
En el segundo ejemplo estamos pidiendo los comentarios enviados a la entrada que se peude
leer directamente visitando
http://civilinfra.corank.com/tech/story/todo-pasa-y-todo-queda
La etiqueta item siempre incluirá estos dos valores.
id: El ID numérico de la noticia.
comments: El número total de comentarios a esta noticia.
La etiqueta comment incluye varios valores. Todos ellos
aparecen siempre, excepto por el valor "replyto" que solo aparecerá si el comentario es una
respuesta a otro comentario:
id: El ID numérico del comentario.
nick: El nombre de usuario o alias de la persona que envió el comentario.
sdate: Fecha en la que el comentario se publicó (PST/PDT). El valor es el número de segundos desde las 00:00:00 del 1 de Enero de 1970 (Epoch).
rank: Las cinco diferentes valoraciones que se le pueden dar a un comentario, en este órden:
De acuerdo, discrepo, aburrido, irrelevante y troll.
replyto: Si el comentario es una respuesta a otro comentario,
aquí se indica el ID numérico del comentario al que se respondió.
Cada etiqueta comment también contiene, por supuesto, el comentario
propiamente dicho, dentro de una sección CDATA (lo que va entre los códigos <![CDATA[ ... ]]>).
El texto del comentario podría ocupar varias líneas:
...
<comments>
<comment ...><![CDATA[Esta noticia es
la mar de maja]]></comment>
</comments>
...
Estas llamadas devuelven las últimas noticias destacadas (coRank.News.GetFeatured), enviadas
(coRank.News.GetUpcoming), o más votadas (coRank.News.GetTop).
Los resultados se devuelven ordenados de la siguiente manera:
coRank.News.GetFeatured: Por fecha, primero las últimas noticias destacadas.
coRank.News.GetUpcoming: Por fecha, primero las últimas noticias enviadas.
coRank.News.GetTop: Las noticias más votadas primero.
El número máximo de noticias que pueden aparecer en los resultados es 100.
Para obtener noticias más allá de la posición 100, deberás utilizar los parámetros
"start" y "end".
Si la diferencia "end" menos "start" es mayor de 100, el valor de "end" se ignorará,
y solo se incluirá en los resultados las primeras 100 noticias, empezando por la
que esté en la posición "start".
Observa que INGENIERIA CIVIL, CONCESIONES, CONSTRUCCION, ENERGÍA Y RENOVABLES solo mantiene un total de 300 noticias destacadas, por lo que
intentar obtener noticias destacadas más allá de la posición 300 no devolverá ninguna noticias.
Parámetros:
start
Indice inicial. Si no se incluye, se asume que es 1.
end
Indice final. Debe ser un número mayor de "start". Si no se incluye,
se asume que será start+100
Ejemplo de llamada:
Para obtener las últimas noticias destacadas (hasta un total de 100): http://civilinfra.corank.com/api/coRank.News.GetFeatured
Para obtener las últimas noticias enviadas, pero de la 20 a la 40 : http://civilinfra.corank.com/api/coRank.News.GetUpcoming/start=20&end=40
Para obtener las 30 noticias más votadas: http://civilinfra.corank.com/api/coRank.News.GetTop/end=30
Las respuestas a las tres llamadas son identicas, excepto por la etiqueta
identificadora: featured (destacadas), upcoming (últimas enviadas) y top (más votadas).
La etiqueta item (una por noticia) contiene siempre los
valores siguientes:
id: El ID numérico de la noticia.
index: La posición en los resultados.
Llamadas relacionadas con los Usuarios
Todas las llamadas relacionadas con los usuarios ofrecen
información de los usuarios, en relación con el sitio en concreto.
Esto es importante porque un mismo usuario puede tener cuenta en más
de un sitio en coRank, pero la mayoría de los datos en cada sitio son diferentes.
coRank.User.GetProfile
Devuelve información general sobre cualquier usuario.
Parámetros:
Puede tomar bien 'id' o 'nick' pero no ámbos.
id
El ID numérico del usuario.
nick
El nombre de usuario (nick, alias).
Ejemplo de llamadas:
Con el ID numérico del usuario: http://civilinfra.corank.com/api/coRank.User.GetProfile/id=771
Con el nombre de usuario: http://civilinfra.corank.com/api/coRank.User.GetProfile/nick=pepeluis
Ejemplo de respuesta:
<corank siteid="437">
<user id="3345" nick="pepeluis" sources="12" fans="34" pviews="67" grank="3" mrank="2">
<name>Pepe Luis</name>
<location>US</location>
<blog>http://mibloguete.example.com/</blog>
<about><![CDATA[Me gusta lo que me gusta]]></about>
<stories submitted="22" vup="3344" vdown="11" fav="12" />
</user>
</corank>
Detalles de la respuesta::
La etiqueta user siempre incluye estos valores.
id: El ID numérico del usuario
nick: El nombre del usuario (nick o alias)
sources: Número defuentes que tiene este usuario
fans: Número de fans
pviews: Número de visitas realizadas al perfíl de este usuario
grank: Posición en el ranking global
mrank: Posición en el ranking mensual
La etiqueta stories siempre se incluye en los resultados,
incluso si su valor es cero. Incluirá
submitted: Número de noticias enviadas
vup: Número de votos positivos
vdown: Número de votos negativos
fav: Número de noticias que el usuario ha guardado en sus favoritos
Los valores siguientes aparecerán solo si el usuario los ha indicado:
name: El nombre del usuario
location: El código de país ISO 3161 de dos letras
blog: La URL del blog del usuario
about: El texto "Sobre mí". Va incluído en una sección CDATA y
puede ocupar más de una línea:
...
<about><![CDATA[Me gusta lo
que me gusta]]></about>
...
coRank.User.GetSubmitted, coRank.User.GetVoted
Estas llamadas devuelven el listado de noticias que un usuario ha enviado (coRank.User.GetSubmitted)
o votado (coRank.User.GetVoted).
El número máximo de noticias que pueden aparecer en los resultados es 100.
Para obtener noticias más allá de la posición 100, deberás utilizar los parámetros
"start" y "end".
Si la diferencia "end" menos "start" es mayor de 100, el valor de "end" se ignorará,
y solo se incluirá en los resultados las primeras 100 noticias, empezando por la
que esté en la posición "start".
Los resultados aparecen ordenados por fecha, apareciendo en primera posición
las últimas noticias enviadas o votadas. Más adelante posiblemente ofrezcamos
la posibilidad de elegir diferentes criterios en cuanto al órden.
Parámetros:
Para identificar al usuarios, debes incluir bien el
'id' o 'nick' pero no ámbos.
id
El ID numérico del usuario.
nick
El nombre de usuario (nick, alias).
start
Indice inicial. Si no se incluye, se asume que es 1.
end
Indice final. Debe ser un número mayor de "start". Si no se incluye,
se asume que será start+100
Ejemplo de llamada:
Para obtener las últimas 100 noticias enviadas por el usuario con ID 16: http://civilinfra.corank.com/api/coRank.User.GetSubmitted/id=16&start=1&end=100
Para obtener, de las últimas noticias votadas por pepeluis, las que caen
en los puestos 100 al 150 : http://civilinfra.corank.com/api/coRank.User.GetVoted/nick=pepeluis&start=100&end=150
La etiqueta user (solo una en cada resultado) contiene siempre los valores siguientes:
total: El número total de noticias enviadas/votadas por este usuario.
id: El ID numérico del usuario.
nick: El nombre de usuario (nick/alias).
La etiqueta item (una por noticia) contiene los valores siguientes:
id: El ID numérico de la noticia.
index: La posición en los resultados.
vote: (Solo en coRank.User.GetVoted) El voto. + si fué un voto positivo, o - si fué negativo
coRank.User.GetSources
Esta llamada devuelve el listado de fuentes de un usuario.
El número máximo de usuarios (fuentes) que pueden aparecer en los resultados es 100.
Para obtener fuentes más allá de la posición 100, deberás utilizar los parámetros
"start" y "end".
Si la diferencia "end" menos "start" es mayor de 100, el valor de "end" se ignorará,
y solo se incluirá en los resultados los primeros 100 usuarios, empezando por el
que esté en la posición "start".
Los resultados aparecen por el órden en que los usuarios fueron añadidos como fuentes.
Parámetros:
Puede tomar bien 'id' o 'nick' pero no ámbos.
id
El ID numérico del usuario.
nick
El nombre de usuario (nick, alias).
start
Indice inicial. Si no se incluye, se asume que es 1.
end
Indice final. Debe ser un número mayor de "start". Si no se incluye,
se asume que será start+100
Ejemplo de llamada:
Para obtener los primeros 100 usuarios añadidos como fuente por el usuario con ID 16: http://civilinfra.corank.com/api/coRank.User.GetSources/id=16&start=1&end=100
Para obtener los usuarios 100 a 105 añadidos como fuente por el usuario Pepeluis:
http://civilinfra.corank.com/api/coRank.User.GetSources/nick=pepeluis&start=100&end=150
La etiqueta user (una por resultados) siempre contiene los valores siguientes:
total: El número total de fuentes que tiene este usuario.
id: El ID numérico del usuario.
nick: El nombre del usuario (nick/alias).
La etiqueta source (una por fuente) contiene los valores siguientes:
id: El ID numérico de la persona que es fuente del usuario.
weight: El peso o influencia como fuente dada por el usuario.
index: La posición en los resultados.
coRank.User.GetFans
Devuelve la lista de fans de un usuario en particular.
El número máximo de fans que pueden aparecer en los resultados es 100.
Para obtener fans más allá de la posición 100, deberás utilizar los parámetros
"start" y "end".
Si la diferencia "end" menos "start" es mayor de 100, el valor de "end" se ignorará,
y solo se incluirá en los resultados los primeros 100 usuarios, empezando por el
que esté en la posición "start".
Los resultados aparecen por el órden en que los fansf añadieron a este usuario como su fuentes.
Parámetros:
Puede tomar bien 'id' o 'nick' pero no ámbos.
id
El ID numérico del usuario.
nick
El nombre de usuario (nick, alias).
start
Indice inicial. Si no se incluye, se asume que es 1.
end
Indice final. Debe ser un número mayor de "start". Si no se incluye,
se asume que será start+100
Ejemplo de llamada:
Para obtener los primeros 100 fans del usuario con ID 16: http://civilinfra.corank.com/api/coRank.User.GetFans/id=16&start=1&end=100
Para obtener los primeros 100 a 150 fans de Pepeluis: http://civilinfra.corank.com/api/coRank.User.GetFans/nick=joe&start=100&end=150
La etiqueta user (aparece solo una vez en los resultado) contiene siempre los valores siguientes:
total: El número total de fans que tiene este usuario.
id: El ID numérico del usuario.
nick: El nombre (nick/alias) del usuario.
La etiqueta fan (una por fan) contendrá los valores siguientes:
id: El ID numérico del fan.
index: La posición en los resultados.
coRank.User.GetLikeMinded
Esta llamada devuelve el listado de los usuarios afines de un usuario en particular.
Los resultados aparecen ordenados por afinidad. Es decir, los usuarios más afines
aparecerán al principio. El número máximo de usuarios afines es 50.
No puedes obtener usuarios afines más allá del puesto 50.
NOTA: El listado de usuarios afines suele incluir otros datos
(número de noticias votadas de la misma manera que el usuario, etc).
Dicha información todavía no es devuelta en esta llamada, pero lo será en una futura
versión de la API.
Detalles de la respuesta::
La etiqueta user (una sola en cada resultado) contiene siempre los valores siguientes:
total: El número total de usuarios afines.
id: El ID numérico del usuario.
nick: El nombre (nick/alias) del usuario.
Las etiquetas match (una por cada usuario afín) contendrán los valores siguientes:
id: El ID numérico del usuario afín.
index: La posición en los resultados.
Códigos de error
Cuando una llamada a la API no puede completarse o es incapaz
de devolver los resultados esperados, genera en su lugar un error.