API XML-RPC

← Back

Connecting
Punt final API: https://secure.gravatar.com/xmlrpc?user=[email_hash]

És obligatori que connecteu a secure.gravatar.com, i per això cal que utilitzeu HTTPS. Això es fa per la seguretat dels nostres usuaris mutus. El paràmetre GET email_hash és el codi md5 de l'adreça electrònica de l'usuari, un cop s'ha passat tot a minúscules i retallat.

Tots els paràmetres per tots els mètodes haurien de passar-se amb un única cadena, mitjançant una matriu associativa.

Autenticació
La autenticació succeeix en el nivell del mètode api. Vostè passarà a la crida del mètode un paràmetre de contrasenya. La informació d'aquests paràmetres es passaran en text pla. El paràmetre de contrasenya sempre es treu dels arguments abans de que el mètode iniciï el el seu procés. Per aquesta raó és normal que vostè no el vegi retornar del mètode grav.test.

Errors
Els errors normalment apareixen amb un número i un text que es pot llegir. Generalment s'hauria de seguir el text quan sigui possible, però per si els pot ajudar els oferim a continuació una breu descripció dels codis numèrics d'error:

	-7	Utilitza secure.gravatar.com 
	-8	Error intern 
	-9	Error d'autenticació 
	-10	Manca un paràmetre del mètode 
	-11	Paràmetre del mètode incorrecte 
	-100	Error general (mireu text) 

Mètodes
grav.exists - comprova si un codi resum (hash) té un gravatar 
	@param  (array)$args['hashes'] una matriu de codis resum (hash) a comprovar 
	@param	(string)$args['password'] per autenticació 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - obté una llista d'adreces per a aquest compte 
	@param  (string)$args['password'] per autenticació 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - retorna una matriu d'imatges d'usuari per aquest compte 
	@param  (string)$args['password'] per autenticació 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Desa dades binàries d'imatge com a una imatge d'usuari per a aquest compte 
	@param  (string)$args['data'] a base64_encode()d image
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] per autenticació 
	@return (bool)false en cas d'error, (string)userimage en cas d'èxit 

grav.saveUrl - Llegeix una imatge mitjançant la seva URL i desa-la com a imatge d'usuari d'aquest compte 
	@param  (string)$args['url'] URL completa que apunta a una imatge 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] per autenticació 
	@return (bool)false en cas d'error, (string)userimage en cas d'èxit 

grav.useUserimage - Utilitza una imatge com a gravatar per un o més adreces d'aquest compte 
	@param  (string)$args['userimage'] Imatge d'usuari que voleu utilitzar 
	@param  (array)$args['addresses'] Llista de les adreces electròniques a on voleu utilitzar aquesta imatge d'usuari 
	@param  (string)$args['password'] per autenticació 
	@return array(
		address => (bool)status
	)

grav.removeImage - suprimeix una imatge d'usuari associada a una o a més adreces electròniques 
	@param  (array)$args['addresses'] Llista de les adreces electròniques a on voleu utilitzar aquesta imatge d'usuari 
	@param  (string)$args['password'] per autenticació 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - suprimeix una imatge d'usuari del compte i per a totes les adreces electròniques amb les que estava associada 
	@param  (string)$args['userimage'] Imatge d'usuari que voleu suprimir del compte 
	@param  (string)$args['password'] per autenticació 
	@return (bool)status

grav.test - a test function
	@param  (string)$args['password'] per autenticació 
	@return (mixed)$args