XML-RPC API

← Back

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

Необхідно, щоб ви підключилися до secure.gravatar.com, і зробили усе через HTTPS. Це для безпеки наших взаємних користувачів. Параметр email_hash GET є MD5 хешем адреси електронної пошти користувачів, отриманим після переведення у нижній регістр і скорочення.

Усі параметри для всіх методів повинні бути передалі як один об'єкт з допомогою асоціативного масиву.

Автентифікація
Авторизація користувачів відбувається на рівні методу API. Ви будете проходити метод виклику параметра пароля. Дані для цих параметрів будуть передані у вигляді звичайного тексту. Значення паролю завжди видаляється з аргументів перед тим, як методи починають їх обробку. З цієї причини ви повинні очікувати, що не побачите його поверненим з методу grav.test.

Помилки
Помилки зазвичай надходять з номером і деяким описом для людини. Зазвичай текст з'являється за можливості, але короткий опис числових кодів помилок є наступний:

	-7	Користовуйте secure.gravatar.com 
	-8	Внутрішня помилка 
	-9	Помилка перевірки автентичності 
	-10	Пропущений метод параметру 
	-11	Неправильний метод параметру 
	-100	Різні помилки (див. текст) 

Mетоди
grav.exists - перевірити, чи хеш має ґраватар 
	@param  (array)$args['hashes'] масив хешів для перевірки 
	@param	(string)$args['password'] для автентифікації 
	@return array ( 
		hash => (bool)exists,
	)

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

grav.userimages - повертає масив зображень користувача для цього облікового запису 
	@param  (string)$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  (string)$args['password'] для автентифікації 
	@return (bool)false у разі виникнення помилки, (string)userimage при успіху 

grav.saveUrl - Прочитати зображення через його URL та зберегти як зображення користувача для цього облікового запису 
	@param  (string)$args['url'] повне посилання на зображення 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] для автентифікації 
	@return (bool)false у разі виникнення помилки, (string)userimage при успіху 

grav.useUserimage - Використовувати зображення користувача як аватару для однієї або більше адрес на цьому обліковому записі 
	@param  (string)$args['userimage'] Зображення користувача, яке ви хочете використовувати 
	@param  (array)$args['addresses'] Перелік адрес, який ви хочете використовувати для цього зображення користувача 
	@param  (string)$args['password'] для автентифікації 
	@return array(
		address => (bool)status
	)

grav.removeImage - видалити зображення користувача пов'язане з одною або декількома адресами електронної пошти 
	@param  (array)$args['addresses'] Перелік адрес, який ви хочете використовувати для цього зображення користувача 
	@param  (string)$args['password'] для автентифікації 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - видалити зображення користувача з профілю та усі адреси електронної пошти, з якими він пов'язаний 
	@param  (string)$args['userimage'] Зображення користувача, що ви хочете видалити з облікового запису 
	@param  (string)$args['password'] для автентифікації 
	@return (bool)status

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