XML-RPC API

← Back

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

Es obligatorio que te conectes a secure.gravatar.com, y que lo hagas mediante HTTPS. Esto es para la seguridad de nuestros usuarios mutuos. El parámetro GET de email_hash es el hash md5 de la dirección de correo de los usuarios después de ponerla en minúsculas y recortarla.

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

Autentificació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.

Errores
Los errores suelen venir con un número y texto legible por humanos. En general, el texto debe ser seguido siempre que sea posible, pero aquí hay una breve descripción de los números de código de error:

	-7	Utilizar secure.gravatar.com 
	-8	Error interno 
	-9	Error al auntentificar 
	-10	Parámetro de Método faltante 
	-11	parámetro de Método incorrecto 
	-100	Error misceláneo (ver texto) 

Métodos
grav.exists - comprobar si un hash tiene un gravatar 
	@param  (array)$args['hashes'] una array de hashes para comprobar 
	@param	(string)$args['password'] para autenticación 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - obtener una lista de direcciones para esta cuenta 
	@param  (string)$args['password'] para autenticación 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - devolver un grupo de imágenes de usuario para esta cuenta 
	@param  (string)$args['password'] para autenticación 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Guardar datos binarios de imagen como imagen de usuario para esta cuenta 
	@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'] para autenticación 
	@return (bool)false en caso de fallo, (string)userimage en caso de éxito 

grav.saveUrl - Lee una imagen a través de su URL y guárdala como imagen de usuario para esta cuenta 
	@param  (string)$args['url'] una dirección URL completa a una imagen 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  (string)$args['password'] para autenticación 
	@return (bool)false en caso de fallo, (string)userimage en caso de éxito 

grav.useUserimage - utiliza una imagen de usuario como un gravatar para una o más direcciones en esta cuenta 
	@param  (string)$args['userimage'] La imagen de usuario que desea utilizar 
	@param  (array)$args['addresses'] Lista de direcciones de email con las que desees utilizar esta imagen de usuario 
	@param  (string)$args['password'] para autenticación 
	@return array(
		address => (bool)status
	)

grav.removeImage - remueve la imagen de usuario asociada con una o más direcciones de correo electrónico 
	@param  (array)$args['addresses'] Lista de direcciones de email con las que desees utilizar esta imagen de usuario 
	@param  (string)$args['password'] para autenticación 
	@return array(
		address => (bool)status
	)

grav.deleteUserimage - elimina una imagen de usuario de la cuenta y las direcciones de correo electrónico con las que está asociada 
	@param  (string)$args['userimage'] La imagen de usuario que deseas eliminar de la cuenta 
	@param  (string)$args['password'] para autenticación 
	@return (bool)status

grav.test - a test function
	@param  (string)$args['password'] para autenticación 
	@return (mixed)$args