XML-RPC API

← Back

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

Det är obligatoriskt att du ansluter till secure.gravatar.com, och att du gör det över HTTPS. Detta är för säkerheten hos våra gemensamma användare. Email_hash GET-parametern är md5-hash för användarens e-postadress efter att den har blivit till gemener och trimmats.

Alla parametrar för alla metoder ska överföras som ett enskilt objekt, inom en associativ array.

Autentisering
Användarautentisering sker på API-metodnivån. Du kommer att skicka en lösenordsparameter till metodanropet. Data för dessa parametrar kommer att skickas som oformaterad text. Lösenordsparametrarna avlägsnas alltid från argumenten innan metoderna börjar bearbeta dem. Av denna anledning bör du inte förvänta dig att se parametern returneras från metoden grav.test.

Fel
Fel kommer vanligen med ett nummer och läsbar text. I allmänhet bör texten följas när det är möjligt, men en kort beskrivning av de numeriska felkoderna är följande:

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

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

grav.addresses - hämta en lista över 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 om det lyckas 

grav.saveUrl - Läs en bild via dess URL och spara det 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 om det lyckas 

grav.useUserimage - använd en användarbild som en gravatar för en av flera adresser på detta konto 
	@param  (string)$args['userimage'] Den användarbild du vill använda 
	@param  (array)$args['addresses'] En lista över 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 - ta bort användarbilden associerat med en eller flera e-postadresser 
	@param  (array)$args['addresses'] En lista över 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 - ta bort en användarbild från kontot och eventuella e-postadresser som den är associerad med 
	@param  (string)$args['userimage'] Den användarbild du vill ta bort från kontot 
	@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