API
Descripciones de las funciones del API. Todas ellas requieren autenticación mediante OAUth con estar URL's:
- Versión: OAuth 1.0
- Petición de token temporal: http://api.biblioeteca.com/biblioeteca.web/request_token
- Autorización: http://api.biblioeteca.com/biblioeteca.web/authorize
- Petición de toquen de acceso: http://api.biblioeteca.com/biblioeteca.web/access_token
El token de acceso es permanente (no caduca), puede ser anulado administrativamente al cancelar una cuenta de usuario o una aplicación.
- Versión: OAuth 2.0
- Autorización: http://api.biblioeteca.com/biblioeteca.web/oauth2/authorize
- Petición de token: http://api.biblioeteca.com/biblioeteca.web/oauth2/token
Funciones del API
NOTA: todas las operaciones paginadas pueden recibir como parámetros pagina=XX
NOTA: todas las operaciones que devuelven datos pueden recibir como parámetros format=XX para devolver los datos en formato xml o json
use : notifica el uso de la aplicación desde un movil (anónima)
- http://api.biblioeteca.com/biblioeteca.web/api/ios/use/XXXXXXXX : envía el id del teléfono para ios (sin OAUTH)
- http://api.biblioeteca.com/biblioeteca.web/api/android/use/XXXXXXXX : envía el id del teléfono para android (sin OAUTH)
Signin: devuelve el nick del usuario en texto plano
- http://api.biblioeteca.com/biblioeteca.web/api/signin
- http://api.biblioeteca.com/biblioeteca.web/api/signin/XXXXXXXX : envía el id del teléfono (ios)
- http://api.biblioeteca.com/biblioeteca.web/api/android/signin/XXXXXXXX : envía el id del teléfono (android)
Signoff: desasocia un identificador de teléfono con una cuenta
- http://api.biblioeteca.com/biblioeteca.web/api/signoff/XXXXXXXX : desasocia este id del teléfono (ios)
Mi Biblioeteca: Devuelve en formato XML BOOKS los libros de la biblioeteca personal del usuario
- http://api.biblioeteca.com/biblioeteca.web/api/libros/leidos : Libros leidos
- http://api.biblioeteca.com/biblioeteca.web/api/libros/deseados : Libros deseados
- http://api.biblioeteca.com/biblioeteca.web/api/libros/mios : Libros que tengo
- http://api.biblioeteca.com/biblioeteca.web/api/libros/listanegra : Libros en lista negra
- http://api.biblioeteca.com/biblioeteca.web/api/libros/leyendo : Libros leyendo
- http://api.biblioeteca.com/biblioeteca.web/api/libros/comprados : Libros comprados
- http://api.biblioeteca.com/biblioeteca.web/api/libros/regalados : Libros regalados
Recomendaciones: Devuelve en formato XML BOOKS los libros recomendados para el usuario
- http://api.biblioeteca.com/biblioeteca.web/api/recomendaciones : recomendaciones personalizadas para el usuario
- http://api.biblioeteca.com/biblioeteca.web/api/recomendaciones/amigos : recomendaciones según los amigos
- http://api.biblioeteca.com/biblioeteca.web/api/recomendaciones/generales : recomendaciones generales
- http://api.biblioeteca.com/biblioeteca.web/xml/recomendaciones/generales : Lo mismo que la anterior, pero sin utilizar OAUTH.
- http://api.biblioeteca.com/biblioeteca.web/json/recomendaciones/generales : Lo mismo que la anterior, pero en formato JSON.
Comentarios : Operaciones sobre comentarios
- http://api.biblioeteca.com/biblioeteca.web/xml/last : Devuelve en formato XML EXTENDED COMMENT los últimos comentarios [NO USA OAUTH]
- http://api.biblioeteca.com/biblioeteca.web/json/last : Lo mismo que la anterior, pero en formato JSON.
- http://api.biblioeteca.com/biblioeteca.web/xml/comentarios/<libroid> : Devuelve en formato XML EXTENDED COMMENT los comentarios para ese <libroid> [NO USA AUTH]
- http://api.biblioeteca.com/biblioeteca.web/json/comentarios/<libroid> : Lo mismo que la anterior, pero en formato JSON.
- http://api.biblioeteca.com/biblioeteca.web/rss/libro/<libroid> : Recupera los comentarios en formato RSS para ese <libroid> [NO USA AUTH]
- http://api.biblioeteca.com/biblioeteca.web/api/comentar : Añade un comentario a un libro
- El id del libro está en el parámetro idlibro.
- El comentario estará en el parámetro comentario enviado por POST
- Devuelve OK o KO según la operación se ha podido realizar o no.
Notas : Operaciones sobre notas
- http://api.biblioeteca.com/biblioeteca.web/api/notas/<libroid> : Recupera las notas en formato RSS (por defecto o incluyendo el parametro format=rss) para ese <libroid>. Lo devuelve en formato XML NOTES incluyendo el parametro format=xml y en formato JSON incluyendo el parametro format=json.
- http://api.biblioeteca.com/biblioeteca.web/api/addnota : Añade una nota a ese libro
- El id del libro está en el parámetro idlibro.
- El comentario estará en el parámetro comentario y la posición en el parámetro posicion enviado por POST
- Devuelve OK o KO según la operación se ha podido realizar o no.
- http://api.biblioeteca.com/biblioeteca.web/api/delnota : Borra una nota
- El id de la nota está en el parámetro idnota.
- Devuelve OK o KO según la operación se ha podido realizar o no.
Búsquedas : Se realizan búsquedas y devuelve en formato XML BOOKS los libros encontrados.
- http://api.biblioeteca.com/biblioeteca.web/xml/buscar/<cadena> : busca la <cadena> dada. Debe estar codificada en URL para no provocar error. [NO UTILIZA OAUTH]
- http://api.biblioeteca.com/biblioeteca.web/json/buscar/<cadena> : busca la <cadena> dada. Debe estar codificada en URL para no provocar error. Devuelve el resultado en formato JSON [NO UTILIZA OAUTH]
- http://api.biblioeteca.com/biblioeteca.web/api/buscar : Utiliza OAUTH para hacer la búsqueda y dar los datos completos del libro.
- busqueda : cadena de busqueda
- deep : busqueda profunda
- etiqueta : tag de filtro
- format: formato de los resultados (xml o json)
- http://api.biblioeteca.com/biblioeteca.web/api/buscaravanzado : Utiliza OAUTH para hacer la búsqueda avanzada y dar los datos completos del libro.
- titulo : titulo a buscar
- autor : autor
- isbn : isbn
- formato : formato del libro
- biblioetecaid : id de biblioeteca
- format: formato de los resultados (xml o json)
- http://api.biblioeteca.com/biblioeteca.web/xml/buscaravanzado : Búsqueda avanzada [NO UTILIZA OAUTH] y devuelve los datos completos del libro.
- titulo : titulo a buscar
- autor : autor
- isbn : isbn
- formato : formato de los libros
- biblioetecaid : id de biblioeteca
- http://api.biblioeteca.com/biblioeteca.web/json/buscaravanzado : Búsqueda avanzada [NO UTILIZA OAUTH] y devuelve los datos completos del libro en formato JSON.
- titulo : titulo a buscar
- autor : autor
- isbn : isbn
- formato : formato de los libros
- biblioetecaid : id de biblioeteca
- http://api.biblioeteca.com/biblioeteca.web/api/mibiblioeteca/buscar : (nuevo 2013) Utiliza OAUTH para hacer la búsqueda y dar los datos completos del libro dentro de los libros de la biblioeteca del usuario.
- busqueda : cadena de busqueda
- format: formato de los resultados (xml o json) (por defecto xml)
- tipo: [0(para mios),1(para deseados),2(para listanegra),3(para leyendo),4(para leidos)]
- http://api.biblioeteca.com/biblioeteca.web/api/libros/comprados : Utiliza OAUTH para hacer la búsqueda y dar los datos completos del libro dentro de los libros comprados
- busqueda : cadena de busqueda
- format: formato de los resultados (xml o json) (por defecto xml)
- http://api.biblioeteca.com/biblioeteca.web/api/libros/regalados : Utiliza OAUTH para hacer la búsqueda y dar los datos completos del libro dentro de los libros regalados
- busqueda : cadena de busqueda
- format: formato de los resultados (xml o json) (por defecto xml)
Valoraciones : Valorar un libro
- http://api.biblioeteca.com/biblioeteca.web/api/valorar/<libroid>/<valoracion> : Valora el libro <libroid> con la valoración <valoracion>
- Parámetros opcionales (valores 0 a 10 correspondiente a los sliders):
- complejo, divertido, riguroso, sorprende
- devuelve la nueva valoración global del libro.
Cambios de estado : Cambios de estado de un libro
- http://api.biblioeteca.com/biblioeteca.web/api/estado/<libroid> : Cambia el estado del libro según los parámetros:
- leyendo, leido, deseado, listanegra, mio
- Si aparece un parámetro con el valor 1 se activa ese estado, si aparece con valor 0 se desactiva, si no aparece, ese estado se deja como estaba.
Información detallada :
- http://api.biblioeteca.com/biblioeteca.web/api/libro/<libroid> : Devuelve en formato XML EXTENDED BOOK la información completa de un libro con respecto al usuario que la pide.
- http://api.biblioeteca.com/biblioeteca.web/xml/libro/<libroid> : Llamada sin OAUTH
- http://api.biblioeteca.com/biblioeteca.web/json/libro/<libroid> : Llamada sin OAUTH con resultado en formato JSON
Notificaciones y mensajería (disponible 16/01/2012)
- http://api.biblioeteca.com/biblioeteca.web/api/notificaciones/pendientes : Devuelve en formato XML NOTIFICATIONS la información sobre las notificaciones pendientes del usuario que las pide
- http://api.biblioeteca.com/biblioeteca.web/api/mensajes/inbox : Devuelve en formato XML MESSAGES los mensajes recibidos por el usuario que las pide
- http://api.biblioeteca.com/biblioeteca.web/api/mensajes/pendientes : Devuelve en formato XML MESSAGES la información sobre las notificaciones pendientes del usuario que las pide
- http://api.biblioeteca.com/biblioeteca.web/api/mensaje/get/XXXX : Devuelve en formato XML MESSAGES un mensaje en concreto para el usuario que lo pide
- http://api.biblioeteca.com/biblioeteca.web/api/mensaje/borra/XXXX : Borra el mensaje que se indica en la url (si pertenece al usuario concreto)
- devuelve OK o KO según el resultado de la operación
- http://api.biblioeteca.com/biblioeteca.web/api/mensaje/marca/XXXX : Marca el mensaje que se indica en la url (si pertenece al usuario concreto) según lo indicado en los parámetros:
- tipo : Cadena que indica el tipo de marca (nuevo,leido,draft)
- devuelve OK o KO según el resultado de la operación
- http://api.biblioeteca.com/biblioeteca.web/api/mensaje/nuevo : Envía un nuevo mensaje (si pertenece al usuario concreto) según lo indicado en los parámetros:
- para : Cadena con los nicks separados por punto y coma de los destinatarios
- asunto : Cadena con el asunto del mensaje
- contenido : Cadena con el mensaje
- devuelve OK o KO según el resultado de la operación
Trofeos (nueva web 2012)
- http://api.biblioeteca.com/biblioeteca.web/api/trofeos/mios : Devuelve en formato XML BADGES la información sobre los trofeos conseguidos por el usuario que las pide
- http://api.biblioeteca.com/biblioeteca.web/api/trofeos/XXXXXXX : Devuelve en formato XML BADGES la información sobre los trofeos conseguidos por el usuario XXXXXXX, solo se puede pedir si estás autenticado
- http://api.biblioeteca.com/biblioeteca.web/api/trofeos/desde/YYYYMMDDHHMM : Devuelve en formato XML BADGES la información sobre los trofeos conseguidos por el usuario que las pide desde la fecha en formato YYYYMMDDHHMM
Usuarios (nuevas funciones 2013)
- http://api.biblioeteca.com/biblioeteca.web/api/usuarios/info : Devuelve en formato XML USERS la información del usuario que las pide
- http://api.biblioeteca.com/biblioeteca.web/api/log : Incluye datos externos al log para las puntuaciones en aplicaciones externas
- Los puntos estarán en el parámetro puntos enviado por POST
- Devuelve OK o KO según la operación se ha podido realizar o no.
- http://api.biblioeteca.com/biblioeteca.web/api/usuarios/modificar : modifica los datos del usuario recibiendo como parámetros los siguientes:
- nick : Nick del usuario
- nombre: Nombre del usuario
- apellido1: Primer apellido del usuario
- apellido2: Segundo apellido del usuario
- fechanacimiento: fecha de nacimiento del usuario en formato: dd/mm/aaaa
- email: Email del usuario
- direccion: Dirección del domicilio del usuario
- ciudad: Ciudad del domicilio del usuario
- provincia: Provincia del domicilio del usuario
- codpostal: Código Postal del domicilio del usuario
- pais: País del domicilio del usuario
- password: Contraseña del usuario
- password2: Contraseña del usuario (la misma que el anterior)
- telefono1: Teléfono de contacto con el usuario
- telefono2: Teléfono de contacto con el usuario
- http://api.biblioeteca.com/biblioeteca.web/api/usuarios/nuevafoto : cambia la foto por la que se envía por post con los siguientes parámetros:
- imagen: Fichero con la foto del usuario
Actividades de los amigos (nuevas funciones 2013)
- http://api.biblioeteca.com/biblioeteca.web/api/actividad : Devuelve en formato XML ACTIVITY la actividad de los amigos del usuario que lo pide
Dedicatorias (nuevas funciones 2013)
- http://api.biblioeteca.com/biblioeteca.web/api/dedicatorias/lista : Devuelve en formato XML DEDICATORIAS? la lista de dedicatorias del usuario que las pide
- http://api.biblioeteca.com/biblioeteca.web/api/dedicatorias/dedicatoria/<iddedicatoria>/<usernick>/<libroid> : Devuelve en formato XML DEDICATORIAS? la dedicatoria indicada
- http://api.biblioeteca.com/biblioeteca.web/api/dedicatorias/subedatos : modifica/crea los datos de la dedicatoria recibiendo como parámetros los siguientes:
- idlibro: Id del libro
- idautor: Id del autor
- fecha: Fecha de la dedicatoria
- latitud: Latitud de la dedicatoria
- longitud: Longitud de la dedicatoria
- http://api.biblioeteca.com/biblioeteca.web/api/dedicatorias/subefoto : cambia la foto por la que se envía por post con los siguientes parámetros:
- imagen: Fichero con la foto del usuario
- http://api.biblioeteca.com/biblioeteca.web/api/dedicatorias/subefirma : cambia la firma por la que se envía por post con los siguientes parámetros:
- imagen: Fichero con la foto del usuario
Publicaciones (nuevas funciones 2013)
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/add : crea los datos de la publicación recibiendo como parámetros los siguientes:
- titulo: Título del libro
- nombres: Nombres de los autores del libro (en correlación a apellidos)
- apellidos: Apellidos de los autores del libro (en correlación a nombres)
- descripcion: Sinopsis del libro
- isbn: ISBN de la edición
- idioma: Idioma de la edición
- trailer: Url del booktrailer
- serie: Se debe poner a valor true, si se quiere que el libro sea parte de una serie
- nombreserie: Nombre de la serie del libro (requiere serie a valor true)
- numserie: Número de la serie que ocupa el libro (requiere serie a valor true)
- precio: Precio del libro
- siMeGusta: Se debe poner a valor true, si se quiere que el libro esté en paga si te gusta
- venta: Se debe poner a valor true, si se quiere que el libro esté en venta
- tipoderechos: Tipo de derechos del libro
- porcentaje: Porcentaje sobre los derechos del libro
- porcentajecop: Porcentaje de coproducción del libro
- comentarios: Comentarios sobre el libro
- licencia: Licencias del libro
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/modify/<idpublicacion> : modifica los datos de la publicación recibiendo como parámetros los siguientes:
- titulo: Título del libro
- nombres: Nombres de los autores del libro (en correlación a apellidos)
- apellidos: Apellidos de los autores del libro (en correlación a nombres)
- descripcion: Sinopsis del libro
- isbn: ISBN de la edición
- idioma: Idioma de la edición
- trailer: Url del booktrailer
- serie: Se debe poner a valor true, si se quiere que el libro sea parte de una serie
- nombreserie: Nombre de la serie del libro (requiere serie a valor true)
- numserie: Número de la serie que ocupa el libro (requiere serie a valor true)
- precio: Precio del libro
- siMeGusta: Se debe poner a valor true, si se quiere que el libro esté en paga si te gusta
- venta: Se debe poner a valor true, si se quiere que el libro esté en venta
- tipoderechos: Tipo de derechos del libro
- porcentaje: Porcentaje sobre los derechos del libro
- porcentajecop: Porcentaje de coproducción del libro
- comentarios: Comentarios sobre el libro
- licencia: Licencias del libro
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/subelibro : sube el fichero del libro con los siguientes parámetros:
- idpublicacion: Id de la publicación del libro
- previa: Un valor a 1 indica que el fichero es una vista previa.
- archivo: Fichero con el libro
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/subeportada : cambia la portada con los siguientes parámetros:
- idpublicacion: Id de la publicación del libro
- imagen: Fichero con la portada
Sólo en OAUTH 2.0:
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/get/XXX : Descarga el archivo con id XXX debe pertenecer a una publicación del usuario
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/venta/XXX : Pone a la venta la publicación con id XXX
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/retiraventa/XXX : Retira de la venta la publicación con id XXX
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/elimina/XXX : Elimina la publicación con id XXX
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/info/XXX : Devuelve la información de una publicación dada en formato XML PUBLICACIONES. XXX es el id de publicación
- http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/publicaciones : Devuelve la información de todas las publicaciones de un usuario en formato XML PUBLICACIONES.
Estadísticas
* http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/ventasfecha/desde/hasta : Devuelve la información de las ventas de libros del usuario entre dos fechas con el formato XML VENTAS. desde y hasta tienen el formato YYYYMMDDHHMM. Si no se quiere indicar alguna de las fechas se pondrá todo relleno a ceros (000000000000)
* http://api.biblioeteca.com/biblioeteca.web/api/publicaciones/ventaslibro/idlibro/desde/hasta : Devuelve la información de las ventas de libros del usuario entre dos fechas con el formato XML VENTAS desde y hasta tienen el formato YYYYMMDDHHMM (000000000000)
URL obsoletas
Se mantienen por compatibilidad con versiones anteriores, pero serán descontinuadas en breve:
- http://api.biblioeteca.com/biblioeteca.web/libros/xml/listanegra/<usuario>
- http://api.biblioeteca.com/biblioeteca.web/libros/xml/deseados/<usuario>
- http://api.biblioeteca.com/biblioeteca.web/libros/xml/leyendo/<usuario>
- http://api.biblioeteca.com/biblioeteca.web/reco/<usuario>