XML-RPC API

← Back

Connecting
נקודת הקצה של API: https://secure.gravatar.com/xmlrpc?user=[email_hash]

עליך להתחבר אל secure.gravatar.com ולעשות זאת מחיבור HTTPS. אנחנו דורשים זאת לטובת כל המשתמשים המשותפים שלנו. הפרמטר email_hash GET הוא רכיב md5 hash של כתובת האימייל של המשתמשים לאחר שנכתב באותיות לטיניות קטנות וקוצר.

כל הפרמטרים עבור השיטות צריכים לעבור בתור פריט יחיד ובמסגרת מערך משויך.

אימות
האימות של המשתמש מבוצע במסגרת השיטה של ה-API. יועבר ממך פרמטר של הסיסמה לקריאה של השיטה. הנתונים של הפרמטרים האלה יועברו כטקסט פשוט. הפרמטרים של הסיסמה תמיד מופרדים מהארגומנטים לפני שהשיטות מתחילות את תהליך העיבוד. לכן, צפוי שהם לא יוחזרו מהשיטה 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 - להשתמש בתמונת משתמש בתור 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