El punto de entrada al API de Mis Favoritos es la siguiente URL:
http://elpais.com/BKMK
id=<clave_api>
c=[comando]
(por defecto 'getfolder')f=[formato_respuesta]
(json o xml, por defecto 'json')Además, existen una serie de parámetros adicionales que se detallan junto a su comando asociado.
La respuesta a cada petición contiene los siguientes valores:
status=(ok|error)
errorCode=<codigo_error>
errorMsg=<descripcion_error>
lastUpdate=<ultima_actualizacion_favoritos>
data=<datos_generados>
Recupera los favoritos almacenados por el usuario, dando la posibilidad de obtener sólo los incluidos en una carpeta. Es el comando por defecto. Los parámetros que admite este comando son los siguientes:
fid=[id_carpeta]
(opcional, si no se especifica se obtiene la carpeta raíz)ftree=[flag_obtener_arbol_completo]
(1 = árbol completo de subcarpetas, 0 = solo primer nivel)Como repuesta, se devuelve un array por cada una de las carpetas y subcarpetas existentes en los favoritos del usuario. Por cada una de las carpetas, se indica su identificador, su nombre y el conjunto de favoritos y de subcarpetas que contiene.
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=getfolder
Respuesta:
{ "lastUpdate":1359371956, "errorCode":1, "errorMsg":"", "status":"ok", "data":[ { "id":"/ffffffffffffffffffffffffffffffff", "nombre":"Leer más tarde", "bookmarks":[ { "id":"7b16ced66c827c90692319aa0cffffff", "titulo":"El Banco de España da un vuelco al modelo de supervisión", "ts":1357684861, "url":"http://economia.elpais.com/economia/2013/01/08/actualidad/1357671452_575247.html", "frame":1 }, { "id":"3f1c71ab4ca4bd75e559059ec1ffffff", "titulo":"El Banco de España asume su fracaso", "ts":1357721372, "url":"http://economia.elpais.com/economia/2012/07/17/actualidad/1342518625_716114.html", "frame":1 } ], "subcarpetas":[] }, { "id":"/fffffffffffffffffffffffffffffffe", "nombre":"Favoritos sin clasificar", "bookmarks":[], "subcarpetas":[] }, { "id":"/aaaa793e57952abfe5fbdb5590e48d3", "nombre":"Programación", "bookmarks":[], "subcarpetas":[ { "id":"/aaaa793e57952abfe5fbdb5590e48d3/bbb44420f634493157ac8ae20443eb3e", "nombre":"JS" }, { "id":"/aaaa793e57952abfe5fbdb5590e48d3/cccca3e1880dda4fa1d73b15c10b568c", "nombre":"Sphinx" } ] }, { "id":"/aaaa793e57952abfe5fbdb5590e48d3/bbb44420f634493157ac8ae20443eb3e", "nombre":"JS", "bookmarks":[], "subcarpetas":[] }, { "id":"/aaaa793e57952abfe5fbdb5590e48d3/cccca3e1880dda4fa1d73b15c10b568c", "nombre":"Sphinx", "bookmarks":[], "subcarpetas":[] } ] }
Crea una nueva carpeta de favoritos, dando la opción de especificar una carpeta destino para posibilitar la creación de subcarpetas.
fname=<nombre_carpeta>
fdest=[id_carpeta_destino]
(opcional, si no se especifica el destino será la carpeta raíz)Como respuesta, devuelve el identificador de la nueva carpeta generado por el sistema.
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=addfolder&fname=Carpeta+de+prueba
Respuesta:
{ "lastUpdate": 1349101205, "errorCode": 1, "errorMsg": "", "status": "ok", "data": "0d990145e0a6ec2e9aada74b0cfedacc" }
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=addfolder&fname=Subcarpeta+de+prueba&fdest=0d990145e0a6ec2e9aada74b0cfedacc
Respuesta:
{ "lastUpdate": 1349101243, "errorCode": 1, "errorMsg": "", "status": "ok", "data": "f420d255cc1714c6a3e35c7e6fb29f6f" }
Modifica el nombre de una carpeta creada por el usuario.
fid=<id_carpeta>
fname=<nombre_carpeta>
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=modfolder&fid=f420d255cc1714c6a3e35c7e6fb29f6f&fname=Subcarpeta+de+prueba+MODIFICADO
Respuesta:
{ "lastUpdate": 1349101314, "errorCode": 1, "errorMsg": "", "status": "ok" }
Elimina una carpeta creada por el usuario junto a todos los favoritos contenidos en ella.
fid=<id_carpeta>
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=delfolder&fid=3ce16961dcb922e5ab37fe391d10b18d
Respuesta:
{ "lastUpdate": 1349101388, "errorCode": 1, "errorMsg": "", "status": "ok" }
Mueve una carpeta de posición dentro de su carpeta contenedora, o bien, otra subcarpeta.
fid=<id_carpeta>
fdest=[id_carpeta_destino]
(opcional, si no se especifica el destino será la carpeta raíz)fpos=<posicion_en_destino>
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=movefolder&fid=f420d255cc1714c6a3e35c7e6fb29f6f&fpos=3
Respuesta:
{ "lastUpdate": 1349101494, "errorCode": 1, "errorMsg": "", "status": "ok" }
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=movefolder&fid=f420d255cc1714c6a3e35c7e6fb29f6f&fpos=
1&fdest=ffffffffffffffffffffffffffffffff
Respuesta:
{ "lastUpdate": 1349101583, "errorCode": 1, "errorMsg": "", "status": "ok" }
Añade un nuevo favorito a una carpeta.
fid=<id_carpeta>
burl=<url_favorito>
btit=<titulo_favorito>
Como respuesta, devuelve el identificador generado por el sistema para el nuevo favorito.
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=addbookmark&fid=f420d255cc1714c6a3e35c7e6fb29f6f&btit=
Enlace+a+Google&burl=http://www.google.es
Respuesta:
{ "lastUpdate": 1349101780, "errorCode": 1, "errorMsg": "", "status": "ok", "data": "7ec3dec14a88a3b50bab9a2b2d8e9e83" }
Modifica el título asignado a un favorito.
fid=<id_carpeta>
bid=<id_favorito>
btit=<titulo_favorito>
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=modbookmark&fid=f420d255cc1714c6a3e35c7e6fb29f6f&bid=
7ec3dec14a88a3b50bab9a2b2d8e9e83&btit=Enlace+a+Google+MODIFICADO
Respuesta:
{ "lastUpdate": 1349101844, "errorCode": 1, "errorMsg": "", "status": "ok" }
Elimina un favorito.
fid=<id_carpeta>
bid=<id_favorito>
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=delbookmark&fid=f420d255cc1714c6a3e35c7e6fb29f6f&bid=
7ec3dec14a88a3b50bab9a2b2d8e9e83
Respuesta:
{ "lastUpdate": 1349101885, "errorCode": 1, "errorMsg": "", "status": "ok" }
Mueve un favorito de posición dentro de su carpeta contenedora, o bien, a otra subcarpeta.
fid=<id_carpeta>
bid=<id_favorito>
fdest=<id_carpeta_destino>
fpos=<posicion_en_destino>
Ejemplo de petición:
http://elpais.com/BKMK?id=<clave_API>&c=movebookmark&fid=f420d255cc1714c6a3e35c7e6fb29f6f&fdest=
ffffffffffffffffffffffffffffffff&bid=7ec3dec14a88a3b50bab9a2b2d8e9e83&bpos=1
Respuesta:
{ "lastUpdate": 1349101982, "errorCode": 1, "errorMsg": "", "status": "ok" }
Operación correcta | 1 |
Ok |
---|---|---|
Errores genéricos | -100 |
Error interno, pruebe unos minutos más tarde |
-104 |
Error interno, pruebe unos minutos más tarde | |
Identificación de usuario | -110 |
Error en clave pública |
-111 |
Usuario no autenticado | |
Verificación de parámetros | -120 |
Comando inexistente |
-150 |
Identificador de carpeta incorrecto | |
-151 |
Identificador de favorito incorrecto | |
-152 |
Posición incorrecta | |
Límites superados | -115 |
Se ha superado el número máximo de carpetas |
-116 |
Se ha superado el número máximo de favoritos | |
Carpetas | -101 |
No existe la carpeta en la lista del usuario - (get|del|move)folder |
-102 |
No existe la carpeta en la base de datos - (add|mod|del)folder | |
-103 |
Ya existe la carpeta en la base de datos - addfolder | |
-105 |
La carpeta tiene subcarpetas - delfolder | |
-108 |
No se puede borrar esa carpeta - delfolder | |
-109 |
No se puede mover esa carpeta a esa posición - movefolder | |
-121 |
No se especifica el nombre de la carpeta - (add|mod)folder | |
-122 |
No se especifica el identificador de la carpeta - (add|mod|del)folder | |
-123 |
No se especifica la posición de la carpeta en el destino - movefolder | |
-130 |
No se puede modificar esa carpeta - modfolder | |
-131 |
No se puede mover una carpeta a su subcarpeta - movefolder | |
Favoritos / Enlaces | -102 |
No existe la carpeta en la base de datos - (add|mod|del|move)bookmark |
-106 |
El enlace no se encuentra en la carpeta - (mod|del|move)bookmark | |
-107 |
Enlace repetido en la carpeta - addbookmark | |
-122 |
No se especifica el identificador de la carpeta - (add|mod|del|move)bookmark | |
-124 |
No se especifica la url del enlace - addbookmark | |
-125 |
No se especifica el titulo del enlace - (add|mod)bookmark | |
-126 |
No se especifica el identificador del enlace - (mod|del|move)bookmark | |
-127 |
No se especifica el identificador de la carpeta destino - movebookmark | |
-128 |
No se especifica la posición del enlace en el destino - movebookmark | |
Estado | -10000 |
Servicio en mantenimiento |