XML-RPC API

← Back

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

It is mandatory that you connect to secure.gravatar.com, and that you do so over HTTPS. This is for the safety of our mutual users. The email_hash GET parameter is the md5 hash of the users email address after it has been lowercased, and trimmed.

Аутентификация
User authentication happens at the api method level. You will pass to the method call an apikey or password parameter. The data for these parameters will be passed in plain text. Only one valid form of authentication is necessary. The apikey and password params are always stripped from the arguments before the methods begin their processing. For this reason you should expect not to see either of these values returned from the grav.test method.

Ошибки
Ошибки обычно состоят из номера и описания. Обычно за номером всегда следует описание, но все же вот краткая расшифровка кодов ошибок:

	-7	Использовать secure.gravatar.com 
	-8	Внутренняя ошибка 
	-9	Ошибка аутентификации 
	-10	Method parameter missing 
	-11	Method parameter incorrect 
	-100	Другая ошибка (смотрите текст) 

Методы
grav.exists - проверить граватар сопоставленный данному хэшу 
	@param  $args['hashes'] an array of hashes to check 
	@param	$args['apikey'] || $args['password'] для аутентификации 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - получить список адресов для этого аккаунта 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - return an array of userimages for this account 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Save binary image data as a userimage for this account 
	@param  (string)$args['data'] a base64_encode()d image
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return (bool)false в случае неудачи, (string)userimage в случае успеха 

grav.saveUrl - Read an image via its URL and save that as a userimage for this account 
	@param  (string)$args['url'] a full url to an image 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return (bool)false в случае неудачи, (string)userimage в случае успеха 

grav.useUserimage - use a userimage as a gravatar for one of more addresses on this account 
	@param  (string)$args['userimage'] Изображение, которое вы хотите использовать 
	@param  (array)$args['addresses'] Список email-адресов для которых вы хотите использовать это изображение 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return array(
		address => (bool)status
	)

grav.removeImage - remove the userimage associated with one or more email addresses 
	@param  (array)$args['addresses'] Список email-адресов для которых вы хотите использовать это изображение 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@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  $args['apikey'] || $args['password'] для аутентификации 
	@return (bool)status

grav.test - a test function
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return (mixed)$args