API kuponkód-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 kuponkód API (Promo Code API) segítségével felügyelheti a felhő eBook vagy a felhő könyvtár kuponkódjait. A lehetséges műveletek: kuponkód hozzáadása, módosítása, törlése.



Kuponkód hozzáadása


API URL:

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


Leírás:

Add a new promo code into the system, or add additional access to an existing user. Available variables are as follows.


Változók:

serial

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

codename

Az a kuponkód, amit a felhasználó adhat meg belépéskor (nem kötelező). Ha nincs megadva, akkor véletlenszerű kódot generál a rendszer.

uid

A kuponkód azonosítója (ID). Használhatja az azonosítót, ha további hozzáféréseket akar hozzárendelni egy meglévő kuponkódhoz

libid

Könyvtárazonosító (ID), amennyiben a kód egy globális kód (mindenhez kap hozzáférést)

catid

Kategóriaazonosító (ID), amennyiben a kódot egy adott kategóriához való hozzáféréshez használja. A változót csak könyvtárak esetében lehet hasznáni

bid

Könyvazonosító (ID), amennyiben a kódot egy adott könyvhöz való hozzáféréshez használja. A változót csak könyvtárak esetében lehet hasznáni

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 kuponkód egyből aktív lesz a létrehozás után


A következő példában egy kódot (SPECIALPROMO) ad a rendszerhez, és a 42-es azonosítóval rendelkező könyvtárhoz ad  hozzáférést:

https://www.kotobee.com/api/v1/promocode/add?serial=123456789&codename=SPECIALPROMO&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/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;     //abban az esetben, ha látni akarja az eredményt

curl_close($curl);


Ha később további jogosultságot akar hozzárendelni ugyanahhoz a kódhoz, készítsen egy különálló API meghívást a hozzáadás (add) művelethez, az adott kuponkód azonosítójával (uid).



Kuponkód módosítása, szerkesztése


API URL:

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


Leírás:

Egy meglévő kuponkódot módosíthat, szerkeszthet.


Változók:

serial 

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

code

A meglévő kuponkód neve

uid

A kuponkód azonosítója, hogy a kuponkód neve helyett ezt használja azonosításra

codename

Egy új kuponkód név, hogy a meglévő helyett ezt lehessen használni

libid 

Könyvtárazonosító, amennyiben a kuponkód globális kuponkód lesz (az adott könyvtárban hozzáféréssel rendelkezik mindenhez)

catid 

Kategóriaazonosító (ID), amennyiben a kuponkód az adott kategóriához kap hozzáférést. A változót csak könyvtárak esetében lehet hasznáni

bid 

Könyvazonosító (ID), amennyiben a kuponkód az adott könyvhöz kap hozzáférést. A változót csak könyvtárak esetében lehet hasznáni

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 kuponkód aktiválásra kerül, ha 0, akkor inaktiválásra.


Itt egy példa, hogy egy meglévő kuponkódot hogyan inaktiválhat a rendszerben:

https://www.kotobee.com/api/v1/promocode/edit?serial=1234-5678-9999-9999&code=SPECIALPROMO&active=0



Kuponkód törlése


API URL:

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


Leírás:

Egy meglévő kuponkódot 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

code

Meglévő kuponkód neve

uid

A kuponkód azonosítója, hogy a kuponkód neve helyett ezt használja azonosításra

libid 

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

catid 

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

bid 

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

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

deleteall

If value is 1, then the code will be deleted entirely from the system (all access)


A következő példa eltávolítja a kuponkódot a rendszerből:

http://www.kotobee.com/api/v1/user/promocode?serial=1234-5678-9999-9999&code=SPECIALPROMO&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_codenameExists

A kuponkód már létezik

s_codeIdMissing

Nem adott meg kuponkód azonosítót (kuponkód nevet vagy azonosítót)

s_userNotRegistered

Módosítási vagy törlési művelet kérelem küldésekor az adott kuponkód nincs regisztrálva

s_userDontExist

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