XML-RPC API

← Back

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

Det er obligatorisk, at du opretter forbindelse til secure.gravatar.com, og at du gør det over HTTPS. Dette er for sikkerheden for vores fælles brugere. GET parameteret til mail_hash er md5-hashen af brugerens e-mail-adresse, efter den er blevet konverteret til små bogstaver og trimmet.

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

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

Fejl
Fejl kommer normalt med en fejlkode og læsbar tekst. Generelt bør teksten følges, når det er muligt, men en kort beskrivelse af de numeriske fejlkoder er som følger:

	-7	Brug secure.gravatar.com 
	-8	Intern fejl 
	-9	Godkendelsesfejl 
	-10	Parameter til metode mangler 
	-11	Parameter til metode er forkert 
	-100	Diverse fejl (se tekst) 

Metoder
grav.exists - se om en hash har en gravatar 
	@param  (array)$args['hashes'] en tabel af hasher der skal undersøges 
	@param	(string)$args['password'] til identificering 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - hent en liste af adresser for denne konto 
	@param  (string)$args['password'] til identificering 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - returner et array af brugerbillede for denne konto 
	@param  (string)$args['password'] til identificering 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Gem binær billeddata som et brugerbilled til denne 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'] til identificering 
	@return (bool)false ved fejl, (string)userimage ved succes 

grav.saveUrl - Læs et billede via dets link og gem det som et brugerbillede for denne konto 
	@param  (string)$args['url'] en fulldstændig adresse til et billede 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] til identificering 
	@return (bool)false ved fejl, (string)userimage ved succes 

grav.useUserimage - brug et brugerbillede som en gravatar for en eller flere adresser på denne konto 
	@param  (string)$args['userimage'] Det brugerbillede du ønsker at bruge 
	@param  (array)$args['addresses'] En liste af e-mail-adresser du ønsker at bruge dette brugerbillede med 
	@param  (string)$args['password'] til identificering 
	@return array(
		address => (bool)status
	)

grav.removeImage - fjern brugerbilledet der er knyttet til en eller flere e-mail-adresser 
	@param  (array)$args['addresses'] En liste af e-mail-adresser du ønsker at bruge dette brugerbillede med 
	@param  (string)$args['password'] til identificering 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - fjern et brugerbillede fra kontoen og alle tilknyttede e-mail-adresser 
	@param  (string)$args['userimage'] Brugerbilledet du ønsker at fjerne fra kontoen 
	@param  (string)$args['password'] til identificering 
	@return (bool)status

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