XML-RPC API

← Back

Connecting
Punkt wyjściowy API: https://secure.gravatar.com/xmlrpc?user=[email_hash]

Wymagane jest połączenie z secure.gravatar.com, które musi zostać dokonane przez HTTPS.

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

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

Błędy
Błędy z reguły składają się z liczby i zrozumiałego dla człowieka tekstu. Powinno się zwracać uwagę na ten tekst, kiedy tylko można, ale dodatkowo, poniżej znajduje się krótki spis liczbowych kodów błędów:

	-7	Używaj secure.gravatar.com 
	-8	Wewnętrzny błąd 
	-9	Błąd uwierzytelniania 
	-10	Do metody nie przekazano parametru 
	-11	Przekazany do metody parametr jest nieprawidłowy 
	-100	Rozmaite błędy (zobacz poniżej) 

Metody
grav.exists - sprawdź, czy pod danym hashem znajduje się gravat 
	@param  (array)$args['hashes'] tablica hashy do sprawdzenia 
	@param	(string)$args['password'] dla uwierzytelnienia 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - pobierz listę adresów dla tego konta 
	@param  (string)$args['password'] dla uwierzytelnienia 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - zwróć tablicę obrazków przypisanych do tego konta 
	@param  (string)$args['password'] dla uwierzytelnienia 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Zapisz binarne dane obrazka jako obrazek tego konta 
	@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'] dla uwierzytelnienia 
	@return (bool)false w przypadku porażki, (string)userimage w przypadku sukcesu 

grav.saveUrl - Odczytaj obrazek przez jego adres URL i użyj go jako obrazka konta 
	@param  (string)$args['url'] pełny adres url obrazka 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] dla uwierzytelnienia 
	@return (bool)false w przypadku porażki, (string)userimage w przypadku sukcesu 

grav.useUserimage - użyj obrazka jako gravatara jednego lub więcej adresów przypisanych do tego konta 
	@param  (string)$args['userimage'] Obrazek użytkownika, którego chcesz użyć 
	@param  (array)$args['addresses'] Lista adresów e-mail, do których chcesz przypisać ten obrazek 
	@param  (string)$args['password'] dla uwierzytelnienia 
	@return array(
		address => (bool)status
	)

grav.removeImage - remove the userimage associated with one or more email addresses 
	@param  (array)$args['addresses'] Lista adresów e-mail, do których chcesz przypisać ten obrazek 
	@param  (string)$args['password'] dla uwierzytelnienia 
	@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'] dla uwierzytelnienia 
	@return (bool)status

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