API felhasználókezelés
Previous Topic  Next Topic 

Ha még nem tette meg, célszerű a Bevezetés a Kotobee API-ba részt elolvasni először.


A felhasználó API (User API) segítségével felügyelheti a felhő eBook vagy a felhő könyvtár felhasználóit. A lehetséges műveletek: felhasználó hozzáadása, módosítása, törlése.


Felhasználó hozzáadása


API URL:

https://www.kotobee.com/api/v1/user/add


Leírás:

A rendszerhez egy új felhasználót hozzáadni, vagy további hozzáféréseket adni meglévő felhasználónak.


Változók:

serial

Az Ön regisztrációs kódját tartalmazza

email

Az új felhasználó e-mail címe

pwd

Jelszó beállítása az új felhasználó részére (nem köteleztő)

uid

Felhasználó azonosítója. Használhatja az azonosítót az e-mail helyett, ha további hozzáféréseket akar hozzárendelni egy meglévő felhasználóhoz

libid

Könyvtárazonosító (ID), amennyiben a felhasználó globális felhasználó lesz (mindenhez hozzáférhet)

catid

Kategóriaazonosító (ID), ha a felhasználónak egy adott kategóriában lesz jogosultsága. Ez a változó csak könyvtárak esetén használható

bid

Könyvazonosító (ID), ha a felhasználónak egy adott könyvhöz lesz jogosultsága. Ez a változó csak könyvtárak esetén használható

cid

Felhőazonosító (ID) felhő eBookok kezeléséhez, könyvtárak helyett. Ha ez a változó kerül továbbításra, az előző három változó (libid, bid, catid) hatástalan marad

active

Ha az értéke 1, akkor a felhasználó egyből aktív lesz a létrehozás után

noemail

Ha az érték 1, akkor a rendszer nem küld e-mailt a felhasználónak. Ezt nem lehet alkalmazni, ha az active változó értéke 0.

activationemail

Ha az érték 1, akkor a felhasználónak egy e-mailt küld a rendszer az aktiváló linkkel. Ezt nem lehet alkalmazni, ha az active változó értéke 1.


Itt egy példa, amelyik egy felhasználót ad a rendszerhez e-mail (newuser@gmail.com) alapján, beállítja a jelszavát (mysecretpwd), aktiválja a fiókját, és jogosultságot ad a 42 azonosítóval rendelkező könyvtárhoz:

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


Egy minta, hogy a POST változót hogyan lehet használni PHP-ban:


(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";   //legalább 6 karakterből kell állnia

$data["libid"] = "42";

$data["active"] = "1";

curl_setopt($curl, CURLOPT_POSTFIELDS, $data);


$resp = curl_exec($curl);

//echo $resp;     //abban az esetben, ha látni akarja az eredményt

curl_close($curl);


Több jogosultságot adhat ugyanannak a felhasználónak többszörös API meghívással. Minden kérelmet különálló hozzáadás (add) műveletként kezeli a rendszer.


Felhasználó módosítása (szerkesztése)


API URL:

https://www.kotobee.com/api/v1/user/edit


Leírás:

Egy meglévő felhasználó adatait módosítja.


Változók:

serial 

Az Ön regisztrációs kódját tartalmazza

email 

A meglévő felhasználó e-mail címe

pwd 

Új jelszó a meglévő felülírásához (reset) (nem kötelező) 

uid

Felhasználó azonosítója, ami azonosítja a felhasználót az e-mail helyett

libid 

Könyvtárazonosító (ID), amennyiben a felhasználó globális felhasználó lesz (mindenhez hozzáférhet)

catid 

Kategóriaazonosító (ID), ha a felhasználónak egy adott kategóriában lesz jogosultsága. Ez a változó csak könyvtárak esetén használható

bid 

Könyvazonosító (ID), ha a felhasználónak egy adott könyvhöz lesz jogosultsága. Ez a változó csak könyvtárak esetén használható

cid 

Felhőazonosító (ID) felhő eBookok kezeléséhez, könyvtárak helyett. Ha ez a változó kerül továbbításra, az előző három változó (libid, bid, catid) hatástalan marad

active 

Ha az értéke 1, akkor a felhasználó aktiválásra kerül, ha 0, akkor inaktiválásra.

noemail 

Ha az érték 1, akkor a rendszer nem küld e-mailt a felhasználónak. Ezt nem lehet alkalmazni, ha az active változó értéke 0.

activationemail 

Ha az érték 1, akkor a felhasználónak egy e-mailt küld a rendszer az aktiváló linkkel. Ezt nem lehet alkalmazni, ha az active változó értéke 1.


Itt egy példa, hogy egy meglévő felhasználót hogyan inaktiválhat a rendszerben:

https://www.kotobee.com/api/v1/user/edit?serial=1234-5678-9999-9999&email=existinguser@gmail.com&active=0 



Felhasználó törlése


API URL:

https://www.kotobee.com/api/v1/user/delete 


Leírás:

Egy meglévő felhasználót teljesen töröl a rendszerből, vagy hozzáférést távolít el egy entitástól (könyvtáratól, kategóriától vagy könyvtől). 


Változók:

serial 

Az Ön regisztrációs kódját tartalmazza

email 

A meglévő felhasználó e-mail címe

libid 

Könyvtárazonosító (ID), amennyiben a felhasználót el akarja távolítani a könyvtár hozzáférésétől (globálisan)

catid 

Kategóriaazonosító (ID), amennyiben a felhasználót el akarja távolítani egy adott kategória hozzáférésétől

bid 

Könyvazonosító (ID), amennyiben a felhasználót el akarja távolítani egy adott könyv hozzáférésétől

cid

Felhőazonosító (ID)amennyiben a felhasználót el akarja távolítani egy adott felhő könyv hozzáférésétől

deleteall

Ha az értéke 1, akkor a felhasználót teljesen törli a rendszerből


Itt egy példa, hogy egy meglévő felhasználót hogyan távolíthat el a rendszerből:

http://www.kotobee.com/api/v1/user/delete?serial=1234-5678-9999-9999&email=existinguser@gmail.com&deleteall=1



Hibakódok


A következő hibakódokat küldheti vissza az API rendszer, különböző okokból

s_authError

A regisztrációs kód nincs regisztrálva a Kotobee Cloudban

s_wrongUser

Az elérni kívánt könyvtár vagy felhő eBook nem hozzáférhető az Ön regisztrációs kódjával

s_emailBlank

Egy új felhasználó hozzáadásakor nem adott meg e-mail címet

s_userIdMissing

Nem adott meg e-mailt vagy felhasználóazonosítót, hogy egy meglévő felhasználót azonosítson

s_emailAlreadyRegistered

Új felhasználó hozzáadásakor az e-mail már regisztrálva van

s_userNotRegistered

Egy módosítási vagy törlési művelet kérelemnél a felhasználó e-mailje nincs regisztrálva

s_userDontExist

Egy felhasználó adott entitás (könyvtár, könyv, kategória) hozzáférésének törlési műveletének kérelmekor a felhasználó hozzáférése nem létezik

pwdCharacterMin

A választott jelszó hosszának legalább 6 karakternek kell lennie