XML-RPC-API

← Back

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

Het is verplicht dat je via HTTPS verbinding maakt met secure.gravatar.com. Dit is voor de veiligheid van onze wederzijdse gebruikers. De GET parameter email_hash is de md5 hash van het e-mailadres van de gebruiker nadat deze is omgezet naar kleine letters, en spaties zijn verwijderd aan het begin en het eind.

Alle parameters van alle methods moeten als één enkel item worden doorgegeven, binnen een associatieve array.

Authenticatie
Gebruikersauthenticatie vind plaats op API method niveau. Je moet aan de method call een password parameter meegeven. De data in deze parameter moet in plain-text worden doorgegeven. De password parameter wordt altijd van de rest van de argumenten gehaald voordat de method call verwerkt wordt. Daarom mag je er niet van uit gaan dat deze terugkomt als je grav.test aanroept.

Foutmeldingen
Foutboodschappen verschijnen meestal met een nummer en een leesbare tekst. In het algemeen moet je deze tekst aanhouden indien mogelijk, maar een korte omschrijving van de numerieke foutboodschappen zijn als volgt:

	-7	Gebruik secure.gravatar.com 
	-8	Interne fout 
	-9	Authenticatiefout 
	-10	Methode parameter ontbreekt 
	-11	Methode parameter onjuist 
	-100	Overige fout (zie tekst) 

Methoden
grav.exists - controleer of de hash een gravatar heeft 
	@param  (array)$args['hashes'] een array van te controleren hashes 
	@param	(string)$args['password'] voor authenticatie 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - verkrijg een lijst van adressen voor dit account 
	@param  (string)$args['password'] voor authenticatie 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - verkrijg een array van gebruikersafbeeldingen van dit account 
	@param  (string)$args['password'] voor authenticatie 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Bewaar de binaire afbeelding gegevens als gebruikersafbeelding voor dit account 
	@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'] voor authenticatie 
	@return (bool)false indien fout, (string)userimage indien goed 

grav.saveUrl - Lees een afbeelding via een URL en bewaar deze als gebruikersafbeelding voor dit account 
	@param  (string)$args['url'] Een volledige url naar een afbeelding 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] voor authenticatie 
	@return (bool)false indien fout, (string)userimage indien goed 

grav.useUserimage - gebruik de gebruikersafbeelding als gravatar voor een of meer e-mailadressen op dit account 
	@param  (string)$args['userimage'] De gebruikersafbeelding de je wilt gebruiken 
	@param  (array)$args['addresses'] Een lijst van de e-mailadressen waarvoor jij deze gebruikersafbeelding wilt gebruiken 
	@param  (string)$args['password'] voor authenticatie 
	@return array(
		address => (bool)status
	)

grav.removeImage - verwijder de gebruikersafbeelding die is geassocieerd met een of meer e-mailadressen 
	@param  (array)$args['addresses'] Een lijst van de e-mailadressen waarvoor jij deze gebruikersafbeelding wilt gebruiken 
	@param  (string)$args['password'] voor authenticatie 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - verwijder een gebruikersafbeelding en het geassocieerde e-mailadres van het account  
	@param  (string)$args['userimage'] De gebruikersafbeelding u wenst te verwijderen van dit account 
	@param  (string)$args['password'] voor authenticatie 
	@return (bool)status

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