XML-RPC API

← Back

Connecting
Крайна точка (API Endpoint): https://secure.gravatar.com/xmlrpc?user=[email_hash]

Задължително се свързвайте със secure.gravatar.com чрез HTTPS. То е за взаимната сигурност на потребителите. Изразът с адреса (email_hash) от параметъра GET е md5 израз на потребителския пощенски адрес, подрязан с малки букви.

Всички параметри за всички методи трябва да са обединени на едно място, в съответната област.

Удостоверяване
Упълномощаването се извършва по методи на ниво API. Към параметрите в заявката ще се приложи и такъв за парола. Данните от тези параметри се предават с обикновен текст (plain text). Параметърът с паролата винаги се отделя от останалите, преди методите да започнат обработка. Поради тази причина не очаквайте да го виждате обратно след grav.test.

Грешки
Грешките обикновено съдържат код и разбираем текст. Текстът следва, където е възможно, но ето и кратко описание на цифровия код:

	-7	Използвайте secure.gravatar.com 
	-8	Вътрешна грешка 
	-9	Грешка при удостоверяване 
	-10	Липсващ параметър 
	-11	Неправилен параметър 
	-100	Обща грешка (прочетете написаното) 

Методи
grav.exists - проверка за образ (Gravatar) от израз (hash) 
	@param  (array)$args['hashes'] област от изрази (hash) за проверка 
	@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'] пълен адрес (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