XML-RPC API

← Back

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

%Egrave; obbligatorio collegarsi a secure.gravatar.com, e che lo si faccia tramite HTTPS. Ciò per la sicurezza dei nostri utenti comuni. Il parametro GET email_hash è l'hash md5 dell'indirizzo email dell'utente dopo che questi è stato reso minuscolo e accorciato (se necessario).

Autenticazione
L'autenticazione utente avviene a livello di metodo api. Dovrai passare, per quanto riguarda il metodo di chiamata, una apikey o un parametro password. I dati di questi parametri verranno passati come normale testo. È necessario una sola forma di autenticazione. I parametri apikey e password sono sempre estratti dagli argomenti prima che i metodi inizino la loro elaborazione. Per questa ragione non dovresti aspettarti di veder tornare indetro alcuno di questi valori dal metodo grav.test.

Errori
Gli errori solitamente appaiono con un numero ed un testo in chiaro. E di base al testo viene fatta seguire, se possibile, una breve descrizione del codice numerico di errore come in questo esempio:

	-7	Utilizzare secure.gravatar.com 
	-8	Errore interno 
	-9	Errore di autenticazione 
	-10	Parametro metodo mancante 
	-11	Parametro metodo non corretto 
	-100	Errore di altro tipo (vedi testo) 

Metodi
grav.exists - contralla se un hash ha un gravatar 
	@param  $args['hashes'] un array di hash da controllare 
	@param	$args['apikey'] || $args['password'] per l'autenticazione 
	@return array ( 
		hash => (bool)exists,
	)

grav.addresses - ottieni un elenco di indirizzi per questo account 
	@param  $args['apikey'] || $args['password'] per l'autenticazione 
	@return array ( 
		address => array (
			rating        => (int)rating, 
			userimage     => (int)userimage, 
			userimage_url => (int)userimage_url
		) 
	)

grav.userimages - restituisce un array di immagini utente per questo account 
	@param  $args['apikey'] || $args['password'] per l'autenticazione 
	@return array (
		userimage => array( 
			(int)rating, // 0:g, 1:pg, 2:r, 3:x
			(string)url,
		)
	) 

grav.saveData - Salva i dati binari di immagine come una immagine utente per questo account 
	@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'] per l'autenticazione 
	@return (bool)false in caso di fallimento, (string)userimage in caso di successo 

grav.saveUrl - Legge una immagine tramite la sua URL e la salva come immagine utente per questo account 
	@param  (string)$args['url'] una url completa ad una immagine 
	@param  (int)$args['rating'] 0:g, 1:pg, 2:r, 3:x
	@param  $args['apikey'] || $args['password'] per l'autenticazione 
	@return (bool)false in caso di fallimento, (string)userimage in caso di successo 

grav.useUserimage - utiliza una immagine utente come gravatar per uno o più indirizzi di questo account 
	@param  (string)$args['userimage'] L'immagine utente che desideri utilizzare 
	@param  (array)$args['addresses'] Una lista di indirizzi email che desideri utilizzare con questa  immagine utente 
	@param  $args['apikey'] || $args['password'] per l'autenticazione 
	@return array(
		address => (bool)status
	)

grav.removeImage - remove the userimage associated with one or more email addresses 
	@param  (array)$args['addresses'] Una lista di indirizzi email che desideri utilizzare con questa  immagine utente 
	@param  $args['apikey'] || $args['password'] per l'autenticazione 
	@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'] per l'autenticazione 
	@return (bool)status

grav.test - a test function
	@param  $args['apikey'] || $args['password'] per l'autenticazione 
	@return (mixed)$args