XML-RPC API

← Back

Connecting
API-anslutningspunkt (endpoint): https://secure.gravatar.com/xmlrpc?user=[email_hash]

Det är obligatoriskt att du ansluter till secure.gravatar.com och att du gör det via HTTPS. Detta för våra användares säkerhet. GET-parametern email_hash är MD5-hashen av användaren e-postadress efter det att den har skrivits om till gemener och trimmats.

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

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

Fel
Felmeddelanden kommer vanligtvis med ett nummer och en text läsbar för människor. Generellt så bör texten följas när möjligt, men en kortfattad beskrivning av felmeddelandenummer är som följer:

	-7	Använd secure.gravatar.com 
	-8	Internt fel 
	-9	Autentiseringsfel 
	-10	Metodparameter saknas 
	-11	Metodparameter felaktig 
	-100	Övriga fel (se text) 

Metoder
grav.exists - kolla om en hash har en gravatar 
	@param  (array)$args['hashes'] en array av hashar att kolla 
	@param	(string)$args['password'] för autentisering 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - få en lista av adresser för detta konto 
	@param  (string)$args['password'] för autentisering 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - returnera en array av användarbilder för detta konto 
	@param  (string)$args['password'] för autentisering 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Spara binär bilddata som en användarbild för detta konto 
	@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'] för autentisering 
	@return (bool)false vid misslyckande, (string)userimage vid framgång 

grav.saveUrl - Läs in en bild via dess URL och använd den som en användarbild för detta konto 
	@param  (string)$args['url'] en fullständig URL till en bild 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] för autentisering 
	@return (bool)false vid misslyckande, (string)userimage vid framgång 

grav.useUserimage - använd en användarbild som en gravatar för en eller fler adresser för detta konto 
	@param  (string)$args['userimage'] Användarbilden du önskar använda 
	@param  (array)$args['addresses'] En lista av de e-postadresser du vill använda denna användarbild för 
	@param  (string)$args['password'] för autentisering 
	@return array(
		address => (bool)status
	)

grav.removeImage - remove the userimage associated with one or more email addresses 
	@param  (array)$args['addresses'] En lista av de e-postadresser du vill använda denna användarbild för 
	@param  (string)$args['password'] för autentisering 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - remove a userimage from the account and any email addresses with which it is associated 
	@param  (string)$args['userimage'] The userimage you wish to remove from the account 
	@param  (string)$args['password'] för autentisering 
	@return (bool)status

grav.test - a test function
	@param  (string)$args['password'] för autentisering 
	@return (mixed)$args