XML-RPC API
Connecting
Authentification
Erreurs
Méthodes
Point de sortie API : https://secure.gravatar.com/xmlrpc?user=[email_hash]
Il est impératif que vous vous connectiez à secure.gravatar.com, et que vous le fassiez en passant par le protocole HTTPS. C'est pour la sécurité de nos utilisateurs communs. Le paramètre email_hash GET est le hachage MD5 de l'adresse email des utilisateurs après qu'elle ait été convertie en minuscules et coupée.
Il est impératif que vous vous connectiez à secure.gravatar.com, et que vous le fassiez en passant par le protocole HTTPS. C'est pour la sécurité de nos utilisateurs communs. Le paramètre email_hash GET est le hachage MD5 de l'adresse email des utilisateurs après qu'elle ait été convertie en minuscules et coupée.
Authentification
L''authentification des utilisateurs se déroule au niveau de la méthode API. Vous passerez à la méthode appelée une apikey (clé API) ou paramètre de mot de passe. Les données de ces paramètres seront passés en texte brut. Une seule forme valable d'authentification est nécessaire. Les paramètres d'apikey et de mot de passe sont toujours effacés des arguments avant que les méthodes ne commencent leur traitement. Pour cette raison, vous devriez vous attendre à ne pas voir une de ces valeurs retournées par la méthode grav.test.
Erreurs
Les erreurs viennent généralement avec un numéro et un texte lisible. En général, le texte doit être suivi à chaque fois que c'est possible, mais une brève description des numéros de codes d'erreur est disponible ici :
-7 Utilisez secure.gravatar.com -8 Erreur interne -9 Erreur d'authentification -10 Paramètre de méthode manquant -11 Paramètre de méthode incorrecte -100 Erreur diverse (voir texte)
Méthodes
grav.exists - vérifier si une table de hachage a un gravatar @param $args['hashes'] un tableau de hachages à vérifier @param $args['apikey'] || $args['password'] pour authentification @return array ( hash => (bool)exists, ) grav.addresses - obtenir une liste d'adresses pour ce compte @param $args['apikey'] || $args['password'] pour authentification @return array ( address => array ( rating => (int)rating, userimage => (int)userimage, userimage_url => (int)userimage_url ) ) grav.userimages - donne un aperçu des images utilisateur pour ce compte @param $args['apikey'] || $args['password'] pour authentification @return array ( userimage => array( (int)rating, // 0:g, 1:pg, 2:r, 3:x (string)url, ) ) grav.saveData - Sauvegarder les données binaires d'image comme une image utilisateur pour ce compte @param (string)$args['data'] a base64_encode()d image @param (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x @param $args['apikey'] || $args['password'] pour authentification @return (bool)false en cas d'échec, (string)userimage en cas de succès grav.saveUrl - Lire une image par son adresse URL et la sauvegarder comme image utilisateur pour ce compte @param (string)$args['url'] une adresse URL complète vers une image @param (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x @param $args['apikey'] || $args['password'] pour authentification @return (bool)false en cas d'échec, (string)userimage en cas de succès grav.useUserimage - utiliser une image utilisateur comme gravatar pour l'une ou plusieurs des adresses sur ce compte @param (string)$args['userimage'] L'image utilisateur que vous souhaitez utiliser @param (array)$args['addresses'] Une liste des adresses email pour lesquelles vous souhaitez utiliser cette image utilisateur @param $args['apikey'] || $args['password'] pour authentification @return array( address => (bool)status ) grav.removeImage - supprimer l'image utilisateur associée à une ou plusieurs adresses e-mail @param (array)$args['addresses'] Une liste des adresses email pour lesquelles vous souhaitez utiliser cette image utilisateur @param $args['apikey'] || $args['password'] pour authentification @return array( address => (bool)status ) grav.deleteUserimage - supprimer une image utilisateur du compte et toutes les adresses e-mail avec laquelle elle est associée @param (string)$args['userimage'] L'image utilisateur que vous souhaitez supprimer du compte @param $args['apikey'] || $args['password'] pour authentification @return (bool)status grav.test - a test function @param $args['apikey'] || $args['password'] pour authentification @return (mixed)$args