Viszonteladói API-információk - ChimeraTool súgó

PHP osztályunk segítségével kommunikálhat a chimeratool.com.cn szerverekkel: jóváírásokat utalhat át, átutalásokat vonhat vissza, információkat gyűjthet számlájáról (pl. hitelegyenlegéről), átutalásait listázhatja és azonosíthatja a chimeratool felhasználókat.

PHP osztályunk a HTTPS protokollon keresztül kommunikál, és a GET metódust használja az adatok JSON formátumban való lekéréséhez.

A PHP-hívást innen töltheti le.

Hibakódok és üzenetek

Az API-hívások különböző hibakódokkal válaszolhatnak, így könnyen azonosítható a hiba.

Csatlakozási hibák

Hitelesítési hibák

Átviteli hibák

Felsorolási hibák

Hibák visszavonása

Ellenőrizze a felhasználói hibákat

Ellenőrizze a ChimeraCard hibákat

Ellenőrizze a felhasználói licencek hibáit

Licenchibák értékesítése

Licenchibák kiterjesztése

Frissítési licenc hibák

Licenchibák visszavonása

API függvények

Minden függvény egy asszociatív tömbbel tér vissza, amely mindig tartalmaz egy logikai típusú elemet, amelyet "siker"-nek neveznek. Ha az értéke FALSE, akkor az API-hívás sikertelen volt, és a választömbben megtalálhatók a 'code' és az 'message' kulcsok is. A „code” és „message” elemek a hibát írják le. A hibakódok fent vannak felsorolva.

Abban az esetben, ha nincs hiba, többféle válasz is lehetséges. Az alábbi lista ismerteti az összes függvényt a paraméterekkel és a visszatérési értékekkel együtt. A visszatérési értékek listája a visszaadott asszociatív tömb kulcsait jelöli.

ChimeraApi::getTransferList($oldal = 1, $limit = 50)

Ezzel a módszerrel lekérdezheti/listázhatja tranzakcióit. Megszerezheti a visszavonni kívánt tranzakciók azonosítóit. Az elkészített lista dátum szerint, csökkenő sorrendben van rendezve.

Paraméterek:

• $oldal – az eredményhalmaz oldala (az első oldal 1)
• $limit - találatok száma egy oldalon (nem lehet nagyobb 200-nál)

Ez olyan, mint egy szabványos lapozó funkció. Ha 500 tranzakciója van, és a $limit 50-re van állítva, akkor az első oldalon az 1-50. tranzakciók eredményei, a második oldalon pedig az 51-100. tranzakciók láthatók.

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)
• átutalások - átutalások listája (asszociatív tömb)
  • azonosító - átviteli azonosító (int)
  • dátum - átvitel dátuma (asszociatív tömb, szerializált DateTime objektum)
  • from - felhasználó neve, ahonnan a kreditek származnak (karakterlánc)
  • címzett - a felhasználó neve, ahová a krediteket küldték (karakterlánc)
  • összeg - átutalt jóváírás összege (tizedes)
  • visszavonva – azt jelzi, hogy a tranzakciókat visszavonták (logikai érték)

ChimeraApi::getInfo()

Információkat ad a fiókjáról.

Paraméterek: -

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)
• creditBalance – aktuális hitelegyenlege
• transfersCount – átutalásainak száma

ChimeraApi::transferCredit($userId, $amount)

„$amount” jóváírást utal át fiókjából a „$userId” címre.

Paraméterek:

• $userId – annak a felhasználónak az azonosítója, akinek jóváírást szeretne küldeni
• $összeg – az átutalni kívánt kreditek száma

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)

• transferId – az átutalás azonosítója (egész szám)

• üzenet – ember által olvasható sikerüzenet

ChimeraApi::revokeTransfer($transferId)

A „$transferId” által azonosított átutalás visszavonása.

Paraméterek:

• $transferId – a visszavonni kívánt átutalás azonosítója (átvételből hitel)

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)
• üzenet – ember által olvasható sikerüzenet

ChimeraApi::checkUser($felhasználónév, $e-mail)

Ezzel a funkcióval ellenőrizheti a felhasználót. Az adott felhasználó azonosítójával válaszol.

Paraméterek:

• $felhasználónév - a felhasználó neve

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)
• userId - az adott felhasználó azonosítója

ChimeraApi::checkChimeraCard($sorozatszám)

Ezzel a funkcióval ellenőrizheti a ChimeraCard kártyát.

Paraméterek:

• $sorozatszám - a kártya sorozatszáma

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)
• sorozatszám - a ChimeraCard sorozatszáma (karakterlánc)
• haslicence – jelzi, hogy a ChimeraCard rendelkezik-e licenccel (boolean)
• licencnév - ha a ChimeraCard rendelkezik licenccel, akkor itt van a licenc neve (karakterlánc), egyébként null

ChimeraApi::checkUserLicences($felhasználónév, $e-mail)

Ellenőrizze a felhasználói licenceket.

Paraméterek:

• $felhasználónév - a felhasználó neve

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)
• userId - az adott felhasználó azonosítója
• licencek - felhasználói licencek (tömb)

ChimeraApi::sellLicence($targetid, $targettype, $licencename)

Adjon el egy engedélyt.

Paraméterek:

• $targetid - a cél azonosítója (felhasználói azonosító vagy ChimeraCard sorozatszám)
• $targettype – 'felhasználó' vagy 'chimeracard'
• $licencename - a licenc neve

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)

• actionId – a viszonteladói művelet azonosítója (egész szám)

ChimeraApi::extendLicence($userlicenceid)

Az engedély meghosszabbítása.

Paraméterek:

• $userlicenceid - A felhasználói licenc azonosítója

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)

ChimeraApi::upgradeLicence($userlicenceid, $licencename = 'Pro')

Frissítsen egy licencet.

Paraméterek:

• $userlicenceid - A felhasználói licenc azonosítója
• $licencename – „Pro” vagy „Prémium”, alapértelmezés szerint „Pro” (nem kötelező)

Visszatérés:

• siker – jelzi, hogy a hívás sikeres volt-e (logikai érték)

ChimeraApi::availableLicences()

Felsorolja az elérhető licenceket

Paraméterek:

• -

Visszatérés:

• licencek – elérhető licencek (tömb)

ChimeraApi::buyLicencePrices($userId)

Kiszámítja a felhasználói licencárakat

Paraméterek:

• $userId

Visszatérés:

• licencek – elérhető licencek (tömb)

ChimeraApi::getSoldLicenceList($oldal, $limit)

Visszaadja az eladott licencek listáját

Paraméterek:

• $oldal - oldalszám
• $limit – oldalankénti eredmények

Visszatérés:

• siker
• értékesített licencek - (tömb)
• lapozás – lapozáshoz szükséges információk

ChimeraApi::revokeLicence($actionId)

Visszavonja az eladott licencet (ha lehetséges)

Paraméterek:

• $actionId – a művelet azonosítója (lekérése a sellLicence-ből és a getSoldLicenceListből)

Visszatérés:

• siker