API

Avvertimento: L'API è attualmente in fase di sviluppo e soggetta a funzionalità aggiunte: nuovi metodi e parametri potrebbero essere aggiunti in futuro. Qualsiasi modifica apportata rimarrà compatibile con le funzionalità esistenti.

Panoramica

L'API TLD-List v1 può essere utilizzata per recuperare i dati visualizzati su TLD-List dal suo database live.

L'API accetta HTTP POST contenenti dati JSON e risponde con dati JSON. Requisiti per tutte le richieste di metodi API:

• Le richieste devono essere effettuate con il metodo HTTP POST.
• Le richieste devono avere un corpo JSON contenente una coppia di chiavi API pubbliche e private valide per l'autenticazione.
• Le richieste devono includere l'intestazione: Tipo di contenuto: application/json

I parametri vengono passati all'API come chiavi/valori nel corpo della richiesta codificata JSON.

L'URL di base per tutte le richieste API è: https://api.tld-list.com/v1

Autenticazione

L'autenticazione viene eseguita passando una chiave API pubblica e una chiave API privata nel corpo JSON inviato all'URL del metodo. Tutte le chiamate API devono includere una coppia di chiavi API valida. Le coppie di chiavi API possono essere generate nel suo account TLD-List, nella scheda API.

Visiti il sito Account > API per creare le chiavi API.

Le chiavi API vengono passate nel corpo della richiesta JSON utilizzando i parametri apiKeyPublic (la sua chiave pubblica) e apiKeyPrivate (la sua chiave privata).

Example authentication parameters

'{' 
    "apiKeyPublic":"MY_PUBLIC_KEY",
    "apiKeyPrivate":"MY_PRIVATE_KEY"
'}' 

Risposta

Tutte le risposte API di successo avranno un codice di stato HTTP 200 SUCCESS e un corpo codificato JSON. Qualsiasi altro codice di stato HTTP nella risposta indica che la richiesta non è andata a buon fine e che si è verificato un errore.

Gli oggetti di risposta JSON restituiti dall'API avranno la seguente struttura:

Esempio di oggetto di risposta fallito con errori

'{' 
   "errors" : [
      '{' 
         "code" : "PARAMETER_INVALID",
         "message" : "pricetypes parameter must be a non-empty array",
         "parameter" : "pricetypes"
      '}',
      '{' 
         "code" : "PARAMETER_INVALID",
         "message" : "includeRegistrars parameter contains invalid registrar names: foobar",
         "parameter" : "includeRegistrars"
      '}' 
   ],
   "seconds" : 0.001,
   "status" : "FAIL"
'}' 

Esempio di oggetto di risposta di successo

'{' 
   "data" : [
      '{' 
         "cheapest" : '{' 
            "renewal" : [
               '{' 
                  "id" : "sav",
                  "name" : "Sav",
                  "price" : "8.38"
               '}' 
            ],
         '}',
         "currency" : "USD",
         "name" : "com",
         "registrarsIncluded" : 58,
         "registrarsTotal" : 58
      '}' 
   ],
   "errors" : [],
   "seconds" : 0.001,
   "status" : "SUCCESS"
'}' 

Oggetti di risposta comuni

Alcuni dei metodi API restituiscono oggetti di dati che hanno la stessa struttura. Questi oggetti di dati comuni sono descritti in dettaglio di seguito.

RegistrarPricing

Descrive i prezzi al dettaglio di una società di registrazione per un'estensione per un particolare tipo di prezzo (register, renewal, transfer), inclusi dettagli aggiuntivi come termini speciali, tariffe, tasse e promozioni.

'{' 
    "register": "8.73",
    "renewal": "9.73",
    "transfer": "9.73",
    "whoisPrivacy": "0.00"
'}' 

'{' 
    "code": "MYCOUPONCODE",
    "amount": "20.00",
    "type": "discount-percent",
    "start": "2015-06-22T00:00:00",
    "end": "2025-06-22T00:00:00"
'}' 

RegistrarPromo

Descrive una promozione attiva offerta da una società di registrazione. Esempio:

'{' 
    "code": "MYCOUPONCODE",
    "amount": "20.00",
    "type": "discount-percent",
    "start": "2015-06-22T00:00:00",
    "end": "2025-06-22T00:00:00"
'}' 

Codici di errore

In caso di fallimento della richiesta, l'oggetto di risposta JSON può contenere uno o più oggetti di errore che descrivono cosa è andato storto. Di seguito è riportato un elenco non esaustivo di codici di errore identificativi che possono essere impostati nel campo codice dell'oggetto error.

Limiti

L'utilizzo dell'API è soggetto a determinati limiti per evitare abusi. Questi limiti di utilizzo sono indicati di seguito e sono soggetti a modifiche senza preavviso.

Metodi di estensione

get

Restituisce le estensioni e i dati relativi ai prezzi e ai dettagli ad esse associati. Questo metodo è simile al recupero dei dati visualizzati su una o più pagine di dettagli del TLD, ad eccezione dei dati della "Storia del prezzo più conveniente", che non vengono restituiti da questo metodo.

Endpoint API: https://api.tld-list.com/v1/extension/get

Tempo di risposta: ~12 seconds for all extensions, ~6 seconds < 2000 extensions, ~2 seconds < 100 extensions

Parametri della richiesta

Oggetto della risposta

Esempio di richiesta/risposta

curl -X POST https://api.tld-list.com/v1/extension/get -H 'Content-Type: application/json' -d '{"extensions": ["com"], "apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY"}'

'{' "data" : [...], "errors" : [], "seconds" : 0.068, "status" : "SUCCESS" '}' 

getNames

Restituisce tutti i nomi delle estensioni.

Endpoint API: https://api.tld-list.com/v1/extension/getNames

Tempo di risposta: ~1 second

Parametri della richiesta

Oggetto della risposta

Esempio di richiesta/risposta

curl -X POST https://api.tld-list.com/v1/extension/getNames -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY"}'

'{' "data" : ["com", "net", "org", ...], "errors" : [], "seconds" : 0.697, "status" : "SUCCESS" '}' 

getCheapestRegistrar

Restituisce i registrar/provider più economici, i loro prezzi, il prezzo mediano e il prezzo medio per estensione di dominio.

Endpoint API: https://api.tld-list.com/v1/extension/getCheapestRegistrar

Tempo di risposta: ~8 seconds for all extensions, ~4 seconds < 2000 extensions, ~1 second < 100 extensions

Parametri della richiesta

Oggetto della risposta

Esempio di richiesta/risposta

curl -X POST https://api.tld-list.com/v1/extension/getCheapestRegistrar -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY", "extensions": ["com"]}'

'{' "data" : [...], "errors" : [], "seconds" : 0.126, "status" : "SUCCESS" '}' 

Metodi di registrazione

getIds

Restituisce tutti gli ID della società di registrazione, ognuno dei quali identifica in modo univoco una società di registrazione attivamente quotata su TLD-List.

Endpoint API: https://api.tld-list.com/v1/registrar/getIds

Tempo di risposta: < 1 second

Parametri della richiesta

Nessuno

Oggetto della risposta

Esempio di richiesta/risposta

curl -X POST https://api.tld-list.com/v1/registrar/getIds -H 'Content-Type: application/json' -d '{"apiKeyPublic":"MY_PUBLIC_KEY","apiKeyPrivate":"MY_PRIVATE_KEY"}'

'{' "data" : ["101domain", "123reg", "above.com", ..., "webnames.ca"], "errors" : [], "seconds" : 0.001, "status" : "SUCCESS" '}'