اِی‌پی‌آی XML-RPC

← Back

Connecting
پایانهٔ ای‌پی‌آی: https://secure.gravatar.com/xmlrpc?user=[email_hash]

لازم است که به secure.gravatar.com متصل شوید و این کار را از راه اچ‌تی‌تی‌پی‌اس انجام دهید. این برای امنیت کاربران است. پارامتر GET در email_hash، هش ام‌دی۵ حروف کوچک رایانشانی کاربر است.

همهٔ پارامترهای همهٔ متودها باید به صورت یک آیتم یکتا داده شوند، در داخل یک آرایهٔ جمعی.

اصالت‌سنجی
اصالت‌سنجی کاربر در سطح متودهای ای‌پی‌آی رخ می‌دهد. شما به در زمان فراخوانی یک متود، یک پارامتر گذرواژه را رد می‌کنید. داده‌های این پارامترها به صورت متن ساده رد می‌شوند. پارامتر گذرواژه همواره پیش از آغاز پردازش متود، از آرگومان‌ها حذف می‌شود. به همین دلیل می‌توان انتظار داشت که در متود grav.test برگردانده نشود.

خطاها
خطاها معمولاً با شماره و متنی قابل خواندن برای انسان همراهند. به طور کلی هر جا که ممکن باشد باید دستورات متن را دنبال نمود، اما یک توضیح مختصر در مورد شمارهٔ خطاها به شرح زیر است:

	-7	از secure.gravatar.com استفاده کنید 
	-8	خطای داخلی 
	-9	خطای اصالت‌سنجی 
	-10	پارامتر متود دریافت نشد 
	-11	پارامتر متود نادرست است 
	-100	خطای متفرقه (متن را ببینید) 

روش‌ها
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 - خواندن یک تصویر از راه نشانی وب آن و ذخیره‌سازی‌اش به عنوان تصویر کاربری برای این حساب 
	@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