XML-RPC API

← Back

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

Se on pakollinen, kun käytät secure.gravatar.com ja yhteys on silloin suojattu HTTPS:llä. Tämän tarkoitus on suojata peruskäyttäjiämme. Email_hash GET -parametri on md5-tarkiste käyttäjien sähköpostiosoitteiden jälkeen. Se on kirjoitettu pienillä kirjaimilla ja lyhyt.

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

Tunnistus
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.

Virheet
Virheet näytetään yleensä numeerisina virhekoodeina, joita seuraa tekstimuotoinen kuvaus. Yleensä virheen tekstimuotoinen kuvaus pitäisi aina liittää mukaan, mutta lyhyet kuvaukset virhekoodeille ovat seuraavat:

	-7	Käytä osoitetta secure.gravatar.com 
	-8	Sisäinen virhe 
	-9	Tunnistusvirhe 
	-10	Menetelmä-parametri puuttuu. 
	-11	Menetelmä-parametri on virheellinen. 
	-100	Muu virhe (ks. teksti) 

Keinot
grav.exists - tarkista gravatarin tunniste 
	@param  (array)$args['hashes'] ryhmä tarkisteita tarkistettavaksi 
	@param	(string)$args['password'] tunnistukseen 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - näytä lista osoitteista tässä tilissä 
	@param  (string)$args['password'] tunnistukseen 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - palaa tämän tilin käyttäjäkuvaryhmään 
	@param  (string)$args['password'] tunnistukseen 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Tallenna binäärikuva ja käytä sitä käyttäjäkuvana tälle käyttäjätunnukselle 
	@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'] tunnistukseen 
	@return (bool)false epäonnistui, (string)userimage onnistui 

grav.saveUrl - Lue kuva sen URL-osoitteen kautta ja tallenna se käyttäjäkuvana tähän tiliin. 
	@param  (string)$args['url'] täysi url-osoite kuvaan 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] tunnistukseen 
	@return (bool)false epäonnistui, (string)userimage onnistui 

grav.useUserimage - käytä käyttäjäkuvaa gravatarina yhdelle tai useammalle sähköpostiosoitteelle tässä tilissä. 
	@param  (string)$args['userimage'] Käyttäjäkuva, jota haluaisit käyttää. 
	@param  (array)$args['addresses'] Luettelo niistä sähköpostiosoitteista, joita haluaisit käyttää tämän käyttäjäkuvan kanssa. 
	@param  (string)$args['password'] tunnistukseen 
	@return array(
		address => (bool)status
	)

grav.removeImage - poista käyttäjäkuva, joka on liitetty yhteen tai useampaan sähköpostiosoitteeseen. 
	@param  (array)$args['addresses'] Luettelo niistä sähköpostiosoitteista, joita haluaisit käyttää tämän käyttäjäkuvan kanssa. 
	@param  (string)$args['password'] tunnistukseen 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - poista käyttäjäkuva tilistä ja kaikista siihen liitetyistä sähköpostiosoitteista. 
	@param  (string)$args['userimage'] Käyttäjäkuva, jonka halusit poistaa tilistäsi 
	@param  (string)$args['password'] tunnistukseen 
	@return (bool)status

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