Informations sur l'API revendeur - Aide ChimeraTool

Vous pouvez utiliser notre classe PHP pour communiquer avec les serveurs chimeratool.com.cn : transférer des crédits, révoquer des transferts de crédit, collecter des informations sur votre compte (par exemple, votre solde de crédit), lister vos transferts et identifier les utilisateurs de chimeratool.

Notre classe PHP communique via le protocole HTTPS et utilise la méthode GET pour récupérer les données au format JSON.

Vous pouvez télécharger l'appel PHP ici .

Codes d'erreur et messages

Les appels API peuvent répondre avec différents codes d'erreur, ce qui vous permet d'identifier facilement l'erreur.

Erreurs de connexion

Erreurs d'authentification

Erreurs de transfert

Erreurs de liste

Révoquer les erreurs

Vérifier les erreurs de l'utilisateur

Vérifiez les erreurs de ChimeraCard

Vérifier les erreurs de licences utilisateur

Erreurs de licence de vente

Erreurs de prolongation de licence

Erreurs de mise à niveau de la licence

Erreurs de révocation de licence

Fonctions API

Toutes les fonctions renvoient un tableau associatif, qui contient toujours un élément de type booléen appelé « success ». Si sa valeur est FALSE, l'appel d'API a échoué et vous pouvez également trouver les clés « code » et « message » dans le tableau de réponse. Les éléments « code » et « message » décrivent l'erreur. Les codes d'erreur sont répertoriés ci-dessus.

Dans le cas où il n'y a pas d'erreur, il peut y avoir plusieurs réponses. La liste ci-dessous explique chaque fonction ainsi que ses paramètres et ses valeurs de retour. La liste des valeurs de retour indique les clés du tableau associatif renvoyé.

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

Vous pouvez interroger/lister vos transactions avec cette méthode. Vous pouvez obtenir les identifiants des transactions que vous souhaitez révoquer. La liste générée est triée par date dans l'ordre décroissant.

Paramètres:

• $page - page du jeu de résultats (la première page est 1)
• $limit - nombre de résultats sur une page (ne peut pas être supérieur à 200)

Il s'agit d'une fonction de pagination standard. Si vous avez 500 transactions et que la limite $ est fixée à 50, la première page affichera les résultats des transactions 1 à 50, et la deuxième page affichera les transactions 51 à 100.

Retour:

• succès - indique si l'appel a réussi (booléen)
• virements - liste des virements de crédit (tableau associatif)
  • id - ID de transfert (int)
  • date - date de transfert (tableau associatif, objet DateTime sérialisé)
  • de - nom de l'utilisateur d'où proviennent les crédits (chaîne)
  • à - nom de l'utilisateur auquel les crédits ont été envoyés (chaîne)
  • montant - montant du crédit transféré (décimal)
  • révoqué - indique que la transaction a été révoquée (booléen)

ChimeraApi::getInfo()

Donne des informations sur votre compte.

Paramètres: -

Retour:

• succès - indique si l'appel a réussi (booléen)
• creditBalance - votre solde de crédit actuel
• transfertsCount - nombre de vos virements

ChimeraApi::transferCredit($userId, $amount)

Transfère le crédit « $amount » de votre compte vers « $userId ».

Paramètres:

• $userId - ID de l'utilisateur auquel vous souhaitez envoyer du crédit
• $amount - nombre de crédits que vous souhaitez transférer

Retour:

• succès - indique si l'appel a réussi (booléen)

• transferId - ID du virement (entier)

• message - message de réussite lisible par l'homme

ChimeraApi::revokeTransfer($transferId)

Révoquer le transfert identifié par '$transferId'.

Paramètres:

• $transferId - ID du virement que vous souhaitez révoquer (obtenez-le à partir de transferCredit)

Retour:

• succès - indique si l'appel a réussi (booléen)
• message - message de réussite lisible par l'homme

ChimeraApi::checkUser($nom d'utilisateur, $email)

Vous pouvez vérifier un utilisateur avec cette fonction. Elle répond avec l'ID de l'utilisateur donné.

Paramètres:

• $username - nom de l'utilisateur

Retour:

• succès - indique si l'appel a réussi (booléen)
• userId - ID de l'utilisateur donné

ChimeraApi::checkChimeraCard($numéro de série)

Vous pouvez vérifier une ChimeraCard avec cette fonction.

Paramètres:

• $serialnumber - numéro de série de la carte

Retour:

• succès - indique si l'appel a réussi (booléen)
• serialnumber - numéro de série de la ChimeraCard (chaîne)
• haslicence - indique si la ChimeraCard possède une licence (booléen)
• nom de la licence - si la ChimeraCard possède une licence, le nom de la licence (chaîne) est ici, sinon null

ChimeraApi::checkUserLicences($nom d'utilisateur, $email)

Vérifiez les licences des utilisateurs.

Paramètres:

• $username - nom de l'utilisateur

Retour:

• succès - indique si l'appel a réussi (booléen)
• userId - ID de l'utilisateur donné
• licences - licences d'utilisateur (tableau)

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

Vendre une licence.

Paramètres:

• $targetid - identifiant de la cible (userID ou numéro de série ChimeraCard)
• $targettype - soit « utilisateur » soit « chimeracard »
• $licencename - nom de la licence

Retour:

• succès - indique si l'appel a réussi (booléen)

• actionId - ID de l'action du revendeur (entier)

ChimeraApi::extendLicence($userlicenceid)

Prolonger une licence.

Paramètres:

• $userlicenceid - ID de la licence de l'utilisateur

Retour:

• succès - indique si l'appel a réussi (booléen)

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

Mettre à niveau une licence.

Paramètres:

• $userlicenceid - ID de la licence de l'utilisateur
• $licencename - soit « Pro » ou « Premium », la valeur par défaut est « Pro » (facultatif)

Retour:

• succès - indique si l'appel a réussi (booléen)

ChimeraApi::availableLicences()

Liste des licences disponibles

Paramètres:

• -

Retour:

• licences - licences disponibles (tableau)

ChimeraApi::buyLicencePrices($userId)

Calcule les prix des licences pour l'utilisateur

Paramètres:

• $userId

Retour:

• licences - licences disponibles (tableau)

ChimeraApi::getSoldLicenceList($page, $limit)

Renvoie la liste des licences vendues

Paramètres:

• $page - numéro de page
• $limit - résultats par page

Retour:

• succès
• Licences vendues - (tableau)
• pagination - informations pour la pagination

ChimeraApi::revokeLicence($actionId)

Révoque une licence vendue (si possible)

Paramètres:

• $actionId - ID de l'action (obtenu à partir de sellLicence et getSoldLicenceList)

Retour:

• succès