Gravatar.com XMLRPC 詳細

API エンドポイント: https://secure.gravatar.com/xmlrpc?user=[email_hash]

secure.gravatar.com へ HTTPS での接続が必須です。これはユーザー間での安全のためです。email_hash GET のパラメータは、ユーザーのメールアドレスをすべて小文字化してトリムした md5 ハッシュです。

ユーザー認証は API メソッドのレベルで行なわれます。メソッドへの呼び出しとして API キーもしくはパスワードのパラメータを渡します。これらのパラメータのデータはプレインテキストとして渡されます。認証の有効なフォームが一つだけ必要です。 API キーとパスワードのパラメータは、メソッドが処理を開始する前に引数から常にストリップされます。したがって、grav.test メソッドからの返り値でその値は見えません。

エラーは、普通は数字と人間が読むことのできるテキストで表示されます。通常、可能な場合には数字のエラーコードの簡単な説明がテキストで続きます:

	-7	secure.gravatar.com を使用 
	-8	内部エラー 
	-9	認証エラー 
	-10	メソッド引数がありません 
	-11	メソッド引数が間違っています 
	-100	その他のエラー (テキスト参照) 

grav.exists - ハッシュは Gravatar を持っているかチェック 
	@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 - このアカウントのアドレス用の Gravatar としてユーザー画像を使用します 
	@param  (string)$args['userimage'] 使用したいユーザーイメージ 
	@param  (array)$args['addresses'] このユーザー画像を使用するメールアドレスの一覧 
	@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'] このユーザー画像を使用するメールアドレスの一覧 
	@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