Si todavía no lo ha hecho, le recomendamos que lea Kotobee API Introduction.
El código de promoción API le permite controlar todos los aspectos de los códigos de promoción para su libro o biblioteca en la nube. Las posibles operaciones son Añadir , Editar y eliminar códigos.
Añadir códigos
https://www.kotobee.com/api/v1/promocode/add
Agregue un nuevo código promocional al sistema o agregue acceso adicional a un usuario existente. Las variables disponibles son las siguientes.
|
serial |
Contiene su número de serie |
|
codename |
El código de promoción que el usuario utilizará para iniciar sesión (opcional). Si no se especifica ningún código, se generará uno aleatorio |
|
uid |
ID del código promocional. Puede usar el ID si desea agregar acceso adicional a un código promocional ya existente. |
|
libid |
El ID de biblioteca, en caso de que el código sea un código global (tiene acceso sobre todo) |
|
catid |
El ID de categoría, en caso de que el código tenga permiso sobre una cierta categoría. Esta variable está disponible sólo para bibliotecas |
|
bid |
El ID del libro, en caso de que el código tenga permiso sobre un libro determinado. 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 código se activará inmediatamente después de la creación |
He aquí un ejemplo que agrega un código (SPECIALPROMO) 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/promocode/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POST => true
));
$data = array();
$data["serial"] = "1234-5678-9999-9999";
$data["codename"] = "SPECIALPROMO";
$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);
Si más adelante desea agregar permisos adicionales al mismo código promocional, realice una llamada de API separada para la operación add, utilizando el ID (uid) de ese código promocional.
Editar Código
https://www.kotobee.com/api/v1/promocode/edit
Editar un código promocional existente. Las variables disponibles son las siguientes.
|
serial |
Contiene su número de serie |
|
code |
El código promocional existente |
|
uid |
El ID del código promocional, que se utilizará como identificador en lugar del código (arriba) |
|
codename |
Un nuevo nombre de código se utiliza en lugar del existente |
|
libid |
El ID de biblioteca, en caso de que el usuario sea un usuario global (tiene acceso sobre todo) |
|
catid |
El 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 |
El ID del libro, en caso de que el usuario tenga permiso sobre un determinado libro. Esta variable está disponible sólo para bibliotecas |
|
cid |
La nube eBook ID 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 |
He aquí un ejemplo que desactiva un código promocional del sistema:
https://www.kotobee.com/api/v1/promocode/edit?serial=1234-5678-9999-9999&code=SPECIALPROMO&active=0
Eliminar Código
https://www.kotobee.com/api/v1/promocode/delete
Eliminar un código de promoción 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 |
|
code |
El código promocional existente |
|
uid |
El ID del código promocional, que se utilizará como identificador en lugar del código (arriba) |
|
libid |
El ID de biblioteca, en caso de que desee eliminar el acceso de la biblioteca (globalmente) |
|
catid |
El ID de categoría, en caso de que quiera eliminar el acceso de una categoría determinada |
|
bid |
El ID del libro, en caso de que quiera eliminar el acceso de un libro determinado |
|
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 valor es 1, entonces el código será borrado completamente del sistema (todo acceso) |
He aquí un ejemplo que elimina completamente el código de promoción:
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 libro electrónico en la nube que está intentando acceder mediante su número de serie |
|
|
s_codenameExists |
El código especificado ya se está utilizando |
|
|
s_codeIdMissing |
Ningún identificador de código (código o ID) proporcionado |
|
|
s_userNotRegistered |
Al solicitar una operación de edición o eliminación, el código de promoción 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 |