Clase21 APILa API (Application Program Interface) de Clase21 permite a cualquier persona interactuar programaticamente con Clase21.
En uso de la API de Clase21 es gratuito, y devuelve datos generados por Clase21 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 Clase21. Actualmente ofrece un grupo de llamadas básicas, pero muy pronto iremos añadiendo mayores funcionalidades.
En este momento, la API de Clase21 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
Parámetros:
<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>
Parámetros:
<corank siteid="437"> <cat id="1" idname="arte">Arte y Diseño</cat> <cat id="2" idname="negocios">Negocios</cat> <cat id="4" idname="actualidad">Actualidad</cat> ... </corank>
Parámetros:
<corank siteid="437"> <users>2455</users> <votes>12447</votes> <stories>821</stories> </corank>
Parámetros:
Puede tomar bien 'id' o 'url' pero no ámbas.
Con el path: http://clase21.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://clase21.corank.com/tech/story/todo-pasa-y-todo-queda
<corank siteid="437"> <items> <item id="4478" pvotes="221" nvotes="17" comments="12" catid="16" senderid="2234" sendernick="pepeluis" urlname="noticia-sobre-nada" sdate="1170668942"> <title>Noticia sobre nada de nada</title> <link>http://www.example.com/</link> <description>Esta noticia no trata nada interesante.</description> <tags> <tag>party</tag> <tag>love</tag> </tags> </item> </items> </corank>
Detalles de la respuesta::
<description>Esta noticia no trata nada interesante.</description>
Es por tanto la función ideal para saber si una página ha sido ya enviada o no.
Parámetros:
IMPORTANTE: Si la URL contiene el sÃmbolo de interrogación ? deberás URL-codificarlo primero, es decir utilizando %3F en lugar de ?
Aquà estamos pidiendo información sobre la entrada que apunte a la URL http://www.example.com/art/757.html
Ejemplo de respuesta:
<corank siteid="437"> <items> <item id="4478" pvotes="221" nvotes="17" comments="12" catid="16" senderid="2234" sendernick="pepeluis" urlname="noticia-sobre-nada" sdate="1170668942"> <title>Noticia sobre nada de nada</title> <link>http://www.example.com/</link> <description>Esta noticia no trata nada interesante.</description> <tags> <tag>party</tag> <tag>love</tag> </tags> </item> </items> </corank>
Detalles de la respuesta::
<description>Esta noticia no trata nada interesante.</description>
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:
<corank siteid="437">
<cat id="2" total="300">
<item id="231" index="1" />
<item id="237" index="2" />
<item id="295" index="3" />
...
</cat>
</corank>
Detalles de la respuesta::
Parámetros:
Puede tomar bien 'id' o 'url' pero no ámbas.
Con el path de la URL: http://clase21.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://clase21.corank.com/tech/story/todo-pasa-y-todo-queda
<corank siteid="437">
<item id="4478" comments="12">
<comments>
<comment id="1" nick="pepeluis"
sdate="1170668942" rank="1,0,0,3,8"><![CDATA[Gran noticia]]></comment>
<comment id="2" nick="pepeluis"
sdate="1170698547" rank="5,1,0,2,0" replyto="1"><![CDATA[De grande nada]]></comment>
...
</comments>
</item>
</corank>
Detalles de la respuesta::
...
<comments>
<comment ...><![CDATA[Esta noticia es
la mar de maja]]></comment>
</comments>
...
Los resultados se devuelven ordenados de la siguiente manera:
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 Clase21 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:
<corank siteid="437">
<featured>
<item id="231" index="1" />
<item id="237" index="2" />
<item id="295" index="3" />
...
</featured>
</corank>
Para coRank.News.GetUpcoming:
<corank siteid="437">
<upcoming>
<item id="231" index="1" />
<item id="237" index="2" />
<item id="295" index="3" />
...
</upcoming>
</corank>
Para coRank.News.GetTop:
<corank siteid="437">
<top>
<item id="231" index="1" />
<item id="237" index="2" />
<item id="295" index="3" />
...
</top>
</corank>
Detalles de la respuesta::
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.
Parámetros: Puede tomar bien 'id' o 'nick' pero no ámbos.
Con el nombre de usuario: http://clase21.corank.com/api/coRank.User.GetProfile/nick=pepeluis
<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>
... <about><![CDATA[Me gusta lo que me gusta]]></about> ...
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:
<corank siteid="437"> <user id="16" nick="joe" total="300"> <item id="231" index="1" /> <item id="237" index="2" /> <item id="295" index="3" /> ... </user> </corank>
Para coRank.User.GetVoted:
<corank siteid="437"> <user id="16" nick="joe" total="300"> <item id="231" vote="+" index="1" /> <item id="237" vote="+" index="2" /> <item id="295" vote="-" index="3" /> ... </user> </corank>
Detalles de la respuesta::
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:
<corank siteid="437"> <user id="16" nick="joe" total="98"> <source id="231" weight="100" index="1" /> <source id="237" weight="100" index="2" /> <source id="295" weight="50" index="3" /> ... </user> </corank>
Detalles de la respuesta::
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:
<corank siteid="437"> <user id="16" nick="joe" total="98"> <fan id="231" index="1" /> <fan id="237" index="2" /> <fan id="295" index="3" /> ... </user> </corank>
Detalles de la respuesta::
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.
Parámetros:
<corank siteid="437"> <user id="16" nick="joe" total="23"> <match id="231" index="1" /> <match id="237" index="2" /> <match id="295" index="3" /> ... </user> </corank>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::
Cuando una llamada a la API no puede completarse o es incapaz de devolver los resultados esperados, genera en su lugar un error.
Ejemplo de respuesta:
<rsp stat="fail"> <err code="1" msg="Method missing" /> </rsp>
Detalles de la respuesta::
Los códigos numéricos de error actuales, sus mensajes, y su significado en español son:
© Clase21 2007