XML-RPC API

← Back

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

您必须通过HTTPS连接到secure.gravatar.com。以便保障我们所有用户的安全。 email_hash GET参数是经过小写和休整的用户电子邮箱地址的md5哈希值。

任何方法中的任何参数都应作为一个关联数组内的一个单一项目进行传递。

认证
用户身份验证在api方法层进行。 您将向方法调用传递一个密码参数。 这些参数的数据将以纯文本形式传递。 密码参数会在方法开始处理之前从参数中剥离。因此,您无法看到其从 grav.test 方法中返回。

错误
错误讯息通常会带有一个代码及一段易读的文字。一般而言,那文字如有的话会出现在后,数字错误代码的简述如下:

	-7	使用 secure.gravatar.com 
	-8	内部错误 
	-9	认证错误 
	-10	遗失程序参数 
	-11	程序参数错误 
	-100	杂项错误(见文) 

程序
grav.exists - 检查金钥是否拥有gravatar 
	@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 - 使用一个用户图像作为gravatar于一个或多个电邮地址 
	@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