XML-RPC API

← Back

Connecting
Конечная точка API: https://secure.gravatar.com/xmlrpc?user=[email_hash]

Произведите подключение к secure.gravatar.com по протоколу HTTPS. Это необходимо для безопасности наших общих пользователей. Параметр email_hash GET является md5 хэшем адреса электронной почты пользователя, переведенным в нижний регистр и укороченным.

Аутентификация
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	Отсутствует параметр метода 
	-11	Неверный метод параметра 
	-100	Другая ошибка (смотрите текст) 

Методы
grav.exists - проверить граватар сопоставленный данному хэшу 
	@param  $args['hashes'] массив хэшей для проверки 
	@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 - выдать массив изображений пользователя для этой учетной записи 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Сохранить двоичные данные изображения как изображение пользователя учетной записи 
	@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 - Считать изображение через его адрес URL и сохранить его как изображение пользователя для этой учетной записи 
	@param  (string)$args['url'] полный URL изображения 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return (bool)false в случае неудачи, (string)userimage в случае успеха 

grav.useUserimage - использовать изображение пользователя в качестве граватара для одного из нескольких адресов этой учетной записи 
	@param  (string)$args['userimage'] Изображение, которое вы хотите использовать 
	@param  (array)$args['addresses'] Список email-адресов для которых вы хотите использовать это изображение 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return array(
		address => (bool)status
	)

grav.removeImage - удалить изображение пользователя, связанное с одним или несколькими адресами электронной почты 
	@param  (array)$args['addresses'] Список email-адресов для которых вы хотите использовать это изображение 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - удалить изображение пользователя из учетной записи и связанных адресов электронной почты 
	@param  (string)$args['userimage'] Изображение пользователя, которое Вы хотите удалить из учетной записи 
	@param  $args['apikey'] || $args['password'] для аутентификации 
	@return (bool)status

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