Learn how to add, edit and delete users using Kotobee API. The User API lets you control all of the user aspects for your cloud ebook or library, such as adding, editing, and deleting users.

Please make sure you read the Kotobee API Introduction before starting out here.

Get user

This URL base API (https://www.kotobee.com/api/v1/user/get) retrieves information about a specific user, including his full list of permissions. Available variables are as follows,         

This endpoint is useful to determine whether you will use the /user/add or /user/edit endpoint to update user's access to a specific book. If the permission is already existing, and you'll just need to update the permitted chapters, then you will just need to use the /user/edit endpoint.\

Here's an example of a URL that retrieves the information of a user with ID 100 in a library (ID 21), while testing his permissions against a book with ID 50:
https://www.kotobee.com/api/v1/user/get?serial=1234-5678-9999-9999&uid=100&libid=21&bid=50

Postman example

Add user

Using the URL base API (https://www.kotobee.com/api/v1/user/add) adds a new user to the system, or adds additional access to an existing user. Available variables are as follows,

Here's an example on how to add a user by email (newuser@gmail.com), set a password (mysecretpwd), activate the account, and assign permissions to the library with ID 42:

https://www.kotobee.com/api/v1/user/add?serial=1234-5678-9999-9999&email=newuser@gmail.com&pwd=mysecretpwd&libid=42&active=1

This is an example on how to do it using POST variables with 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"] = "newuser@gmail.com";
$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);

You may add multiple permissions to the same user across multiple API calls. Each request is considered as a separate "add" operation.

Postman example

Edit user

This URL base API (https://www.kotobee.com/api/v1/user/edit ) edits an existing user. Available variables are below.

To add book access to an existing user, the /user/add endpoint should be used instead.       

Here's an example of a URL that deactivates a user from the system:
https://www.kotobee.com/api/v1/user/edit?serial=1234-5678-9999-9999&email=existinguser@gmail.com&libid=10active=0

Postman example

List users

This URL base API (https://www.kotobee.com/api/v1/user/all) lists all users for a certain cloud ebook or library, along with their details. This endpoint has a limit of 1000 users. Available variables are as follows,

Here's an example of a URL that lists all users in a cloud ebook with ID 450:
https://www.kotobee.com/api/v1/user/all?serial=1234-5678-9999-9999&cid=450

Postman example

Delete user

 This URL base API ( https://www.kotobee.com/api/v1/user/delete ) deletes an existing user entirely, or removes access to an entity (library, category, or book). Available variables are as follows,

Here's an example of a URL that deletes the user entirely:
http://www.kotobee.com/api/v1/user/delete?serial=1234-5678-9999-9999&email=existinguser@gmail.com&deleteall=1

Postman example

Clear devices

 This URL base API ( https://www.kotobee.com/api/v1/user/cleardevices ) clears the device list of an existing user, such that he may login from a new set of devices, not surpassing the device (DRM) limit set by you. Available variables are as follows,

Here's an example of a URL that deletes the user entirely:
http://www.kotobee.com/api/v1/user/cleardevices?serial=1234-5678-9999-9999&email=existinguser@gmail.com&libid=98

Postman example

Error codes