XML-RPC API

← Back

Connecting
Críoch API: https://secure.gravatar.com/xmlrpc?user=[email_hash]

It is mandatory that you connect to secure.gravatar.com, and that you do so over HTTPS. This is for the safety of our mutual users. The email_hash GET parameter is the md5 hash of the users email address after it has been lowercased, and trimmed.

All parameters for all methods should be passed as a single item, within an associative array.

Fíordheimhniú
User authentication happens at the api method level. You will pass to the method call a password parameter. The data for these parameters will be passed in plain text. The password param is always stripped from the arguments before the methods begin their processing. For this reason you should expect not to see it returned from the grav.test method.

Botúin
Errors usually come with a number and human readable text. Generally the text should be followed whenever possible, but a brief description of the numeric error codes are as follows:

	-7	Bain feidhm as secure.gravatar.com 
	-8	Botún inmheánach 
	-9	Botún fíordheimhnithe 
	-10	Paraiméadar modha ar iarraidh 
	-11	Paraiméadar modha mícheart 
	-100	Botún ilchineálach (breathnaigh ar an téacs) 

Modhanna
grav.exists - fiafraigh an bhfuil gravatar ag heais 
	@param  (array)$args['hashes'] sraith heaiseanna le seiceáil 
	@param	(string)$args['password'] chun fíordheimhnithe 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - faigh liosta seoltaí le haghaidh an chuntais seo 
	@param  (string)$args['password'] chun fíordheimhnithe 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - taispeáin sraith íomhánna úsáideora le haghaidh an chuntais seo 
	@param  (string)$args['password'] chun fíordheimhnithe 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Sábháil sonraí íomhá dénártha mar íomhá úsáideora le haghaidh an chuntais seo 
	@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'] chun fíordheimhnithe 
	@return (bool)false ar loiceadh dhó, (string)userimage ar éirí dhó 

grav.saveUrl - Aimsigh íomhá de réir a URL agus sábháil mar íomhá úsáideora í le haghaidh an chuntais seo 
	@param  (string)$args['url'] url iomlán chuig íomhá 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] chun fíordheimhnithe 
	@return (bool)false ar loiceadh dhó, (string)userimage ar éirí dhó 

grav.useUserimage - bíodh íomhá úsáideora mar gravatar le haghaidh cinn amháin de sheoltaí an chuntais seo. 
	@param  (string)$args['userimage'] An íomhá úsáideora ar mhian leat a úsáid 
	@param  (array)$args['addresses'] Liosta na seoltaí ríomhphoist lena gcuirfeá an íomhá úsáideora seo 
	@param  (string)$args['password'] chun fíordheimhnithe 
	@return array(
		address => (bool)status
	)

grav.removeImage - bain an íomhá úsáideora a bhaineas le seoladh ríomhphoist amháin nó níos mó 
	@param  (array)$args['addresses'] Liosta na seoltaí ríomhphoist lena gcuirfeá an íomhá úsáideora seo 
	@param  (string)$args['password'] chun fíordheimhnithe 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - bain íomhá úsáideora den chuntas agus bain seoladh ríomhphoist ar bith a bhaineas léi 
	@param  (string)$args['userimage'] An íomhá úsáideora ar mhian leat a bhaint den chuntas 
	@param  (string)$args['password'] chun fíordheimhnithe 
	@return (bool)status

grav.test - a test function
	@param  (string)$args['password'] chun fíordheimhnithe 
	@return (mixed)$args