API di interfacciamento gestione domini
Struttura generale
Le API sono estremamente semplici, utilizzano chiamate HTTP in GET e ritornano risposte in JSON in codifica UTF-8.
Il servizio richiesto si trova nel parametro ws
, l'endpoint all'URL https://hyppo.com/domain.php
, e i servizi sono:
list
, orders
set_cust
Esempio: https://hyppo.com/domain.php?ws=list&par1=val1&par2=val2
È disponibile una libreria in PHP per una immediata implementazione: download oppure visualizza.
Errori
Gli errori vengono restituiti nel JSON di ritorno con la descrizione dell'errore nella variabile error
.
Autenticazione
Parametri:
user
: userid breve (assegnato da hyppoCom)
nonce
: codice arbitario scelto dal client
key
: si ottiene calcolando il checksum MD5 della password
dell'utente con nonce
Esempio in PHP: $key=md5($password.$nonce);
Chiamata: https://hyppo.com/domain.php?ws=list&user=userid&nonce=230514&key=a543b9622f7bf1a340a8a6682d09ad17
Servizio list
Recupera i domini dell'utente con relativi dettagli.
Parametri (opzionali):
filter
: filtra i domini corrispondenti alla sottostringa (SQL: like '%valore%'
)
sort
: determina il campo di ordinamento
Ritorno:
count
: numero elementi ritornati
domains
: Array di domini corrispondenti alla ricerca, con chiave il nome del dominio, ciascuno ha i seguenti campi:
name
: Dominio
org
: Organizzazione registrant
fname
: Nome persona fisica
lname
: Cognome persona fisica
email
: E-Mail registrant
addr
: Indirizzo registrant
creat
: Data di creazione
expir
: Data di scadenza
paid
: Data di fatturazione
price
: Prezzo
registry
: Registro
dns
: Array dei DNS autoritativi
own_id
: UserID proprietario
redirect
: eventuali redirect del dominio
cust
: Campo 'note utente'
warn
: Notifica di allarme
letexpire
: Se impostato il dominio non viene rinnovato a scadenza
privacy
: Flag WHOIS privacy
Servizio orders
Recupera gli ordini relativi ai propri domini.
Parametri (opzionali):
domain
: richiede esclusivamente gli ordini relativi ad un dominio
days
: limita temporalmente la ricerca ad un determinato numero di giorni (da oggi)
Ritorno:
count
: numero elementi ritornati
orders
: Array di ordini ciascun elemento ha i seguenti campi:
date
: data operazione
domain
: Dominio
oper
: C=Creazione, R=Rinnovo, T=Trasferimento, D=Cancellazione (Deletion), O=Transfer-out
price
: Prezzo in Euro
Opzionalmente, se già fatturati:
inv_date
: Data fattura
inv_doc
: Numero fattura
Servizio set_custom
Imposta il campo 'note utente' per un dominio.
Parametri:
domain
: dominio sul quale operare
value
: valore da impostare
Ritorno:
affected
: 1 se impostato con successo, altrimenti 0