API XML-RPC

← Back

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

Jeni të detyruar të lidheni te secure.gravatar.com, dhe këtë ta bëni përmes HTTPS. Kjo bëhet për sigurinë e përdoruesave tanë të përbashkët. Parametri "email_hash GET" është hashi md5 i vendndodhjes email të përdoruesit, pasi të jetë kaluar në shkronja të vogla, dhe të jetë qethur paksa.

Krejt parametrat, për krejt metodat, duhet të jepen si një element i vetëm, brenda një vargu asociativ.

Mirëfilltësim
Mirëfilltësimi i përdoruesit kryhet në shkallë metode api. Thirrjes prej metodës do t’i jepni një parametër fjalëkalimi. Të dhënat për këta parametra do të jepen si tekst i thjeshtë. Parametrit të fjalëkalimit përherë i hiqen argumentet përpara se metoda të fillojë punën e vet. Për këtë arsye, duhet të prisni që të mos shihni ta risjellë nga metoda grav.test.

Gabime
Gabimet zakonisht njoftohen me një numër dhe tekst të lexueshëm nga njeriu. Përgjithësisht pason teksti, kurdo që kjo është e mundur, por një përshkrim i shkurtër i kodeve numerike për gabimet e gjeni më poshtë:

	-7	Përdor secure.gravatar.com 
	-8	Gabim i brendshëm 
	-9	Gabim mirëfilltësimi 
	-10	Mungon parametër metode 
	-11	Parametër metode i pasaktë 
	-100	Tjetër gabim (shihni tekstin) 

Metoda
grav.exists - kontrollo ka apo s’ka gravatar për një hash 
	@param  (array)$args['hashes'] një varg hashesh për kontroll 
	@param	(string)$args['password'] për mirëfilltësim 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - merr një listë vendndodhjesh për këtë llogari 
	@param  (string)$args['password'] për mirëfilltësim 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - përgjigju me një varg figurash përdoruesi për këtë llogari 
	@param  (string)$args['password'] për mirëfilltësim 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Ruaji të dhënat dyore për figurën si figurë përdoruesi për këtë llogari 
	@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'] për mirëfilltësim 
	@return (bool)false në rast dështimi, (string)userimage në rast suksesi 

grav.saveUrl - Lexo një figurë përmes URL-së së saj dhe përdore atë si figurë përdoruesi për këtë llogari 
	@param  (string)$args['url'] url e plotë për te një figurë 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] për mirëfilltësim 
	@return (bool)false në rast dështimi, (string)userimage në rast suksesi 

grav.useUserimage - përdor një figurë përdoruesi si gravatar për një ose më shumë vendndodhje të kësaj llogarie 
	@param  (string)$args['userimage'] Pamja e përdoruesit që doni të përdoret 
	@param  (array)$args['addresses'] Listë vendndodhjesh email për të cilat dëshironi të përdoret kjo figurë përdoruesi 
	@param  (string)$args['password'] për mirëfilltësim 
	@return array(
		address => (bool)status
	)

grav.removeImage - hiq figurën e përdoruesit përshoqëruar me një ose më tepër vendndodhje email 
	@param  (array)$args['addresses'] Listë vendndodhjesh email për të cilat dëshironi të përdoret kjo figurë përdoruesi 
	@param  (string)$args['password'] për mirëfilltësim 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - hiq figurë përdoruesi prej llogarisë dhe prej çfarëdo vendndodhjeje email të cilave u është përshoqëruar 
	@param  (string)$args['userimage'] Figura e përdoruesit që doni të hiqet prej kësaj llogarie 
	@param  (string)$args['password'] për mirëfilltësim 
	@return (bool)status

grav.test - a test function
	@param  (string)$args['password'] për mirëfilltësim 
	@return (mixed)$args