Si todavía no lo ha hecho, le recomendamos que lea Kotobee API Introducción.
La API de usuario le permite controlar todos los aspectos de los usuarios para su libro o biblioteca en la nube. Las operaciones posibles son agregar, editar y eliminar usuarios.
Agregar Usuario
https://www.kotobee.com/api/v1/user/add
Agregue un nuevo usuario al sistema o agregue acceso adicional a un usuario existente. Las variables disponibles son las siguientes.
|
serial |
Contiene su número de serie |
|
email |
El correo electrónico del nuevo usuario |
|
pwd |
Una contraseña para establecer para el nuevo usuario (opcional) |
|
uid |
ID de usuario. Puede utilizar el ID de usuario en lugar del correo electrónico, si desea agregar acceso adicional a un usuario existente |
|
libid |
ID de biblioteca, en caso de que el usuario sea un usuario global (tiene acceso sobre todo) |
|
catid |
ID de categoría, en caso de que el usuario tenga permiso sobre una determinada categoría. Esta variable está disponible sólo para bibliotecas |
|
bid |
ID del libro, en caso de que el usuario tenga permiso sobre un determinado libro. Esta variable está disponible sólo para bibliotecas |
|
cid |
ID del eBook en la nube para administrar los eBooks en la nube en lugar de las bibliotecas. En caso de que se envíe, ninguna de las tres últimas variables (libid, bid, catid) tendrá efecto |
|
active |
Si el valor es 1, el usuario se activará inmediatamente después de la creación |
|
noemail |
Si el valor es 1, no se enviará ningún correo electrónico al usuario. Esto no se puede utilizar si la variable activa es 0 |
|
activationemail |
Si el valor es 1, se enviará al usuario un correo electrónico con el enlace de activación después de la creación. Esto no se puede usar si la variable activa es 1 |
Aquí hay un ejemplo que agrega un usuario por correo electrónico ([email protected]), establece una contraseña (mysecretpwd), activa la cuenta y asigna permisos a la biblioteca con ID 42:
Un ejemplo de cómo hacerlo usando variables POST con PHP:
PHP
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => 1,
CURLOPT_URL => "https://www.kotobee.com/api/v1/user/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POST => true
));
$data = array();
$data["serial"] = "1234-5678-9999-9999";
$data["email"] = "[email protected]";
$data["pwd"] = "mysecretpwd"; //must be at least 6 characters
$data["libid"] = "42";
$data["active"] = "1";
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
$resp = curl_exec($curl);
//echo $resp; //in case you want to view the result
curl_close($curl);Puede agregar varios permisos al mismo usuario a través de varias llamadas de API. Cada solicitud se considera como una operación "add" separada.
Editar usuario
https://www.kotobee.com/api/v1/user/edit
Edit an existing user. Available variables are as follows.
|
serial |
Contiene su número de serie |
|
email |
El correo electrónico del usuario existente |
|
pwd |
Una contraseña para reiniciar para el nuevo usuario (opcional) |
|
uid |
ID de usuario para identificar al usuario en lugar del correo electrónico |
|
libid |
ID de biblioteca, en caso de que el usuario sea un usuario global (tiene acceso sobre todo) |
|
catid |
ID de categoría, en caso de que el usuario tenga permiso sobre una determinada categoría. Esta variable está disponible sólo para bibliotecas |
|
bid |
ID del libro, en caso de que el usuario tenga permiso sobre un determinado libro. Esta variable está disponible sólo para bibliotecas |
|
cid |
ID de eBook en la nube para administrar los eBooks en la nube en lugar de las bibliotecas. En caso de que se envíe, ninguna de las tres últimas variables (libid, bid, catid) tendrá efecto |
|
active |
Si el valor es 1, el usuario se activará inmediatamente después de la creación |
|
noemail |
Si el valor es 1, no se enviará ningún correo electrónico al usuario. Esto no se puede utilizar si la variable activa es 0 |
|
activationemail |
Si el valor es 1, se enviará al usuario un correo electrónico con el enlace de activación después de la creación. Esto no se puede usar si la variable activa es 1 |
He aquí un ejemplo que desactiva un usuario del sistema:
https://www.kotobee.com/api/v1/user/edit?serial=1234-5678-9999-9999&[email protected]&active=0
Eliminar usuario
https://www.kotobee.com/api/v1/user/delete
Eliminar un usuario existente por completo o eliminar el acceso a una entidad (biblioteca, categoría o libro). Las variables disponibles son las siguientes.
|
serial |
Contiene su número de serie |
|
email |
El correo electrónico del usuario existente |
|
libid |
ID de biblioteca, en caso de que desee eliminar el acceso de usuario de la biblioteca (globalmente) |
|
catid |
ID de categoría, en caso de que desee eliminar el acceso de usuario de una categoría determinada |
|
bid |
ID del libro, en caso de que desee eliminar el acceso de un determinado libro |
|
cid |
ID del eBook en la nube para administrar los eBooks en la nube en lugar de las bibliotecas. En caso de que se envíe, ninguna de las tres últimas variables (libid, bid, catid) tendrá efecto |
|
deleteall |
Si el valor es 1, el usuario será borrado completamente del sistema |
He aquí un ejemplo que elimina completamente al usuario:
http://www.kotobee.com/api/v1/user/delete?serial=1234-5678-9999-9999&[email protected]&deleteall=1
Códigos de Error
Los siguientes códigos de error pueden ser devueltos por el API que representa varios significados
|
s_authError |
El número de serie utilizado no está registrado con Kotobee Cloud |
|
|
s_wrongUser |
No se puede acceder a la biblioteca o el eBook en la nube que está intentando acceder mediante su número de serie |
|
|
s_emailBlank |
No se proporcionó correo electrónico al agregar un nuevo usuario |
|
|
s_userIdMissing |
No se proporcionó ningún correo electrónico o ID de usuario para identificar un usuario existente |
|
|
s_emailAlreadyRegistered |
Al agregar un nuevo usuario, el correo electrónico ya está registrado |
|
|
s_userNotRegistered |
Al solicitar una operación de edición o eliminación, el correo electrónico del usuario no está registrado |
|
|
s_userDontExist |
Cuando se solicita eliminar el acceso de un usuario a una entidad en particular, este acceso de usuario puede no existir |
|
|
pwdCharacterMin |
The password chosen should be at least 6 characters long |