XML-RPC API

← Back

Connecting
Koncový bod API: https://secure.gravatar.com/xmlrpc?user=[email_hash]

Je povinností připojovat se k serveru secura.gravatar.com a to pomocí protokolu HTTPS. To pro bezpečnost našich uživatelů. Parametr GET email_hash je MD5 hash uživatelovo e-mailové adresy.

All parameters for all methods should be passed as a single item, within an associative array.

Ověřování
User authentication happens at the api method level. You will pass to the method call a password parameter. The data for these parameters will be passed in plain text. The password param is always stripped from the arguments before the methods begin their processing. For this reason you should expect not to see it returned from the grav.test method.

Chyby
Chyby obvykle obsahují číslo a čitelný text. Obecně by měl text následovat, kdykoliv je to možné, ale stručný popis číselných kódů chyb je následující:

	-7	Použijte secure.gravatar.com 
	-8	Interní chyba (Problém není na Vašem přijímači) 
	-9	Chyba autorizace 
	-10	Chybí parametr metody 
	-11	Nesprávný parametr metody 
	-100	Chyba (viz. text) 

Metody
grav.exists - ověří zda hash má gravatar 
	@param  (array)$args['hashes'] pole hashů ke kontrole 
	@param	(string)$args['password'] pro ověření 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - získat seznam adres pro tento účet 
	@param  (string)$args['password'] pro ověření 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - vrací pole obrázků uživatele pro tento účet 
	@param  (string)$args['password'] pro ověření 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Uložit binární data obrázku jako uživatelský obrázek pro tento účet 
	@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'] pro ověření 
	@return (bool)false v případě chyby, (string)userimage v případě úspěchu 

grav.saveUrl - Načíst obrázek pomocí jeho URL a uložit jako uživatelský obrázek pro tento účet 
	@param  (string)$args['url'] celá url obrázku 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] pro ověření 
	@return (bool)false v případě chyby, (string)userimage v případě úspěchu 

grav.useUserimage - použít uživatelský obrázek jako gravatar pro jednu nebo více adres na tomto účtu 
	@param  (string)$args['userimage'] Uživatelský obrázek, který chcete použít 
	@param  (array)$args['addresses'] Seznam e-mailových adres, pro které chcete tento uživatelský obrázek používat 
	@param  (string)$args['password'] pro ověření 
	@return array(
		address => (bool)status
	)

grav.removeImage - odstranit uživatelský obrázek připojený k jedné nebo více e-mailovým adresám 
	@param  (array)$args['addresses'] Seznam e-mailových adres, pro které chcete tento uživatelský obrázek používat 
	@param  (string)$args['password'] pro ověření 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - odstranit uživatelský obrázek z účtu a od každé adresy, ke které je připojen 
	@param  (string)$args['userimage'] Uživatelský obrázek, který chcete odstranit z účtu 
	@param  (string)$args['password'] pro ověření 
	@return (bool)status

grav.test - a test function
	@param  (string)$args['password'] pro ověření 
	@return (mixed)$args