API di dominio - Elenco dei comandi API

API Dynadot

Iniziare con la nostra API RESTful

L'API di Dynadot è progettata per un'integrazione fluida con i tuoi sistemi. La nostra API presenta URL orientati alle risorse prevedibili, supporta corpi di richiesta codificati in JSON, restituisce risposte codificate in JSON e XML, e aderisce ai metodi HTTP standard, all'autenticazione e ai codici di risposta.Puoi utilizzare l'API di Dynadot sia in modalità test che in modalità live. La modalità è determinata dalla chiave API utilizzata per autenticare le tue richieste. La modalità test ti consente di simulare e convalidare la tua integrazione API senza influenzare i dati o le transazioni in tempo reale.L'API di Dynadot è principalmente focalizzata sulla gestione dei domini, sul processamento degli ordini e sui servizi correlati. Puoi eseguire azioni come registrare, trasferire e rinnovare domini, gestire le impostazioni DNS e visualizzare o aggiornare gli ordini dell'account.Si prega di notare: Le creazioni, aggiornamenti e cancellazioni in blocco non sono supportati, e ciascun tipo di richiesta è limitato a un solo oggetto o azione.

Generazione delle tue chiavi APIPrima di iniziare a effettuare richieste API, è fondamentale generare la tua API Key e il tuo API Secret.Queste chiavi sono necessarie per l'autenticazione e per garantire la sicurezza delle tue azioni quando interagisci con la nostra API.Puoi generare sia la Chiave API che il Segreto API attraverso la sezione API nelle impostazioni del tuo account.1. Accedi al tuo account su Dynadot.2. Naviga su Strumenti > API.3. Genera la tua API Key e API Secret da questa pagina.

Unisciti alla nostra ComunitàHai qualche idea o suggerimento? Parla direttamente con i nostri ingegneri professionisti.Discord

Metodo HTTPL'API utilizza metodi HTTP standard per eseguire operazioni sulle risorse:

Method	Description
GET	GET Request: Retrieve detailed information about a specified resource
POST	POST Request: Create a new resource
PUT	PUT Request: Fully update the specified resource
DELETE	DELETE Request: Remove the specified resource

URL

L'URL di base per tutte le richieste API è:https://api.dynadot.com/

Il formato completo dell'URL:Sure! Here’s the translation of your text into Italian: http://api.dynadot.com/restful/version_code/resource/{resource_identify}/action

https://api.dynadot.com/restful/v1/domains/{domain_name}/search

Sure! Please provide the text you would like me to translate into Italian.

La versione attuale dell'API èv

Quando si costruisce l'URL della richiesta API, è necessario includere solo la versione principale. Gli aggiornamenti minori e le patch sono progettati per essere retrocompatibili e non introdurranno modifiche che possano compromettere il tuo codice esistente. Questo garantisce stabilità, permettendoti di beneficiare di miglioramenti e correzioni incrementali senza dover modificare la tua implementazione.Quando verranno rilasciate versioni future, manterremo la compatibilità con le versioni precedenti per un certo periodo di tempo. Nuove funzionalità e modifiche significative saranno introdotte in incrementi di versione maggiori.

HeaderL'intestazione di una richiesta API contiene metadati sulla richiesta. Questi metadati forniscono un contesto essenziale affinché il server possa elaborare correttamente la richiesta. Le intestazioni comunemente utilizzate includono:

Content-TypeSpecifica il formato dei dati inviati nel corpo della richiesta. Il server utilizza queste informazioni per analizzare correttamente la richiesta. Attualmente, l'unico valore accettabile è: application/json

Content-Type: application/json

AccettaInforma il server del formato di risposta atteso dal client.Valori possibili: application/json, application/xml

Accept: application/json

AutorizzazioneTutte le richieste API devono includere una chiave API per l'autenticazione. Puoi ottenere la tua chiave API dal pannello di controllo del tuo account.You can generate an API key in API setting page

Authorization: Bearer YOUR_API_KEY

X-Request-IDL'intestazione X-Request-ID è un intestazione opzionale utilizzata per identificare in modo univoco ciascuna richiesta API. Quando è inclusa, questa intestazione aiuta a tracciare e correlare le richieste tra sistemi e registri, facilitando il debug e il monitoraggio dell'attività API.Il valore di X-Request-ID deve essere un UUID valido (Identificatore Universale Unico), seguendo il formato standard: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (ad esempio, 123e4567-e89b-12d3-a456-426614174000).

X-Request-ID: 550e8400-e29b-41d4-a716-446655440000

Sure! However, it seems that you haven't provided the text you want to be translated. Please share the text, and I'll be happy to help with the translation to Italian!L'intestazione X-Signature è un meccanismo di sicurezza obbligatorio per le richieste transazionali, comprese quelle che recuperano informazioni sensibili o aggiornano dati. Garantisce l'autenticità, l'integrità e la non ripudiabilità delle richieste API richiedendo ai client di firmare il payload della richiesta utilizzando HMAC-SHA256.

Per generare la firma, avrai bisogno dei seguenti valori1. Chiave API: La tua chiave API unica.2. Percorso Completo e Query: Il percorso completo dell'endpoint API insieme ai parametri di query.3. X-Request-Id: L'ID della richiesta. Se non è disponibile, puoi inserire una stringa vuota.4. Corpo della Richiesta: Il corpo della richiesta. Se è vuoto o nullo, puoi inserire una stringa vuota.

La stringa da firmare è una combinazione dei valori menzionati sopra, concatenati nel seguente ordine:

apiKey + "\n" + fullPathAndQuery + "\n" + (xRequestId or empty String) + "\n" + (requestBody or empty String)

apiKey = "your_api_key"
fullPathAndQuery = "/v1/some/endpoint?param=value"
xRequestId = "unique-request-id"
requestBody = "{\"key\":\"value\"}"


stringToSign = "your_api_key\n/v1/some/endpoint?param=value\nunique-request-id\n{\"key\":\"value\"}"

Genera la firma HMAC-SHA256Dopo aver costruito la stringa da firmare, è necessario applicare la crittografia HMAC-SHA256 utilizzando la tua chiave segreta. Questo processo genererà la firma.La firma viene generata seguendo i seguenti passaggi:1. Utilizza l'algoritmo HMAC-SHA256.Sure! Please provide the text you would like me to translate into Italian.3. Usa il segreto come chiave.
Applica la firma generata come valore di X-Signature nell'intestazione della richiesta.

X-Signature: {HMAC-SHA256 Signature}

BodyIl corpo di una richiesta API viene utilizzato per inviare dati al server. È comunemente incluso nelle richieste POST, PUT o PATCH (non tipicamente per le richieste GET o DELETE).

Sure! Please provide the text you would like me to translate into Italian.Il formato dei dati del corpo è determinato dall'intestazione Content-Type. Alcuni formati comuni includono:

{
    "domainName": "domain.com",
    "showPrice": "yes",
    "currency": "USD"
}

Casi d'uso tipiciRichieste POST: Il metodo POST viene utilizzato per creare una nuova risorsa sul server. Il corpo della richiesta di solito contiene i dettagli della risorsa.Richieste PUT: Il metodo PUT viene utilizzato per aggiornare una risorsa esistente sostituendola completamente. Il corpo della richiesta contiene la risorsa aggiornata nella sua interezza.Richieste GET: Il metodo DELETE viene utilizzato per rimuovere una risorsa esistente dal server. Non ha un corpo di richiesta.Richieste DELETE: Il metodo GET viene utilizzato per recuperare una risorsa esistente dal server. Non ha un corpo di richiesta

Response FormatTutte le risposte API vengono restituite in formato JSON o XML, a seconda del formato dei dati del corpo determinato dall'intestazione Accept, fornendo i dati richiesti o un messaggio di errore, se applicabile.

Sure! Please provide the text you would like me to translate into Italian.Sure! Please provide the text you would like me to translate into Italian.

Codice: Lo stato della richiestaMessaggio: Maggiori dettagli sullo statoDati: Il corpo della risposta

{
    "Code": "200",
    "Message": "Success",
    "Data": {}
}

Gestione degli ErroriI codici di stato HTTP sono numeri standardizzati a tre cifre restituiti da un server per indicare l'esito della richiesta di un client. Forniscono informazioni essenziali su se la richiesta è stata elaborata con successo, se richiede ulteriori azioni o se ha incontrato un errore. Questi codici sono suddivisi in cinque categorie, ognuna delle quali rappresenta un tipo distinto di risposta.I codici di stato della nostra API seguono il protocollo HTTP/1.1, uno standard ampiamente accettato che garantisce comunicazioni coerenti e affidabili. Utilizzando HTTP/1.1, sfruttiamo funzionalità come le connessioni persistenti e la memorizzazione nella cache avanzata per ottimizzare le interazioni tra client e server.

2xx (Riuscito): Indica che il comando è stato ricevuto e accettato

200Il codice di stato indica che la richiesta è stata completata con successo.

201Il codice di stato indica che la richiesta è stata completata e ha portato alla creazione di una o più nuove risorse.

202Il codice di stato indica che la richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è stata completata.

249L'utente ha inviato troppe richieste in un determinato intervallo di tempo.

4xx (Errore del Cliente): Indica che il cliente ha commesso un errore nella richiesta, come ad esempio fornire un input non valido o mancare di una corretta autorizzazione.

400Il codice di stato indica che il server non può o non vuole elaborare la richiesta a causa di qualcosa che viene percepito come un errore del client.

401Il codice di stato indica che la richiesta non è stata applicata perché manca di credenziali di autenticazione valide per la risorsa di destinazione.

402Il codice di stato indica che la richiesta non è stata elaborata a causa di un problema di pagamento.

403Il codice di stato indica che il server ha compreso la richiesta ma rifiuta di soddisfarla.

404Il codice di stato indica che il server di origine non ha trovato una rappresentazione attuale per la risorsa target o non è disposto a rivelare che ne esista una.

409La richiesta non può essere completata a causa di un conflitto con lo stato attuale della risorsa.

5xx (Errore del Server): Indica che il server ha riscontrato un errore o non è in grado di soddisfare la richiesta.

500Il codice di stato indica che il server ha incontrato una condizione imprevista che gli ha impedito di soddisfare la richiesta.

501Il codice di stato indica che il server non supporta la funzionalità necessaria per soddisfare la richiesta.

502Il codice di stato indica che il server, mentre funge da gateway o proxy, ha ricevuto una risposta non valida da un server in entrata a cui ha avuto accesso nel tentativo di soddisfare la richiesta.

503Il codice di stato indica che il server non è attualmente in grado di gestire la richiesta a causa di un sovraccarico temporaneo o di una manutenzione programmata, che probabilmente sarà risolta dopo un certo ritardo.

504Il codice di stato indica che il server, mentre fungeva da gateway o proxy, non ha ricevuto una risposta tempestiva da un server upstream a cui doveva accedere per completare la richiesta.

CodiceNome dello Stato

200Successo

201Creato

202Accettato

249Troppe richieste

400Richiesta non valida

401Non autorizzato

402Pagamento Richiesto

403Vietato

404Non trovato

409Conflitto

500Errore interno del server

501Non implementato

502Gateway Errato

503Servizio non disponibile

504Timeout del Gateway

Limitazione della velocitàLe richieste devono essere inviate tramite https (socket sicuro) per motivi di sicurezza. Solo 1 richiesta può essere elaborata alla volta, quindi ti preghiamo di attendere il completamento della tua richiesta attuale prima di inviarne un'altra.

Riceverai diversi conteggi di fili in base al livello di prezzo del tuo account:

Price level	Account
Regular	1 thread
Bulk	5 threads
Super Bulk	25 threads

<Response>
  <status>
    <code>429</code>
    <message>Too Many Requests</message>
  </status>
  <error>
    <description>You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later.</description>
  </error>
</Response>

{
  "code": 429,
  "message": "Too Many Requests",
  "error": {
    "description": "You have reached the maximum allowed requests within the concurrent limit of your account. Please try again later."
  }
}

Panoramica del Registro delle Modifiche

Un Registro delle Modifiche è un resoconto dettagliato delle modifiche, miglioramenti, correzioni di bug e nuove funzionalità introdotte in ciascuna versione dell'API. Fornisce trasparenza per gli utenti e gli sviluppatori documentando l'impatto di ciascun aggiornamento. È composto da due parti principali:

Versione APIQuesta parte evidenzia il sistema di versioning dell'API, che aiuta gli sviluppatori a tenere traccia dell'evoluzione delle funzionalità e a garantire la compatibilità. Ogni versione dell'API è identificata da un numero di versione unico (ad es., v1.0.1, v2.2.3) e rappresenta una pietra miliare o un rilascio significativo. Il versioning consente agli utenti di mantenere le integrazioni con minimi disagi, scegliendo di aggiornare quando sono pronti.

Cronologia delle modificheIl Registro delle Modifiche fornisce informazioni dettagliate sugli aggiornamenti, le correzioni di bug, le deprecazioni e i miglioramenti introdotti in ciascuna versione. Esso delinea le modifiche specifiche apportate agli endpoint, ai parametri, ai meccanismi di autenticazione o ai formati di risposta. Questa sezione garantisce agli sviluppatori la massima trasparenza su ciò che è cambiato e consente loro di adattare le proprie implementazioni di conseguenza. Mantenendo un registro delle modifiche chiaro e dettagliato, miriamo a fornire agli sviluppatori gli strumenti e le informazioni necessarie per gestire le integrazioni in modo efficace e sicuro.

Versione API

La nostra API è attualmente alla versionev

I codici di versione vengono utilizzati per identificare e gestire in modo sistematico gli aggiornamenti dell'API. Seguono il formato del Versioning Semantico (SemVer):

Sure! Please provide the text you would like me to translate into Italian.Sure! Please provide the text you would like me to translate into Italian.Sure! Please provide the text you would like me to translate into Italian.

Ogni componente del codice versione ha uno scopo specifico e aiuta gli sviluppatori a comunicare in modo efficace l'ambito e il tipo di modifiche.

Versione MaggioreDefinizione: Rappresenta cambiamenti significativi che potrebbero compromettere la compatibilità con le versioni precedenti.Sure! Please provide the text you would like me to translate into Italian.<Major>.x.x

Esempi:v1.0.0->v2.0.0Una completa riprogettazione dell'API o modifiche allo schema incompatibili.

Versione MinoreDefinizione: Indica l'aggiunta di funzionalità retrocompatibili.Sure! Please provide the text you would like me to translate into Italian.x.<Minor>.x

Esempi:v1.0.0->v1.1.0Aggiungere nuovi endpoint o metodi mantenendo la compatibilità con le versioni precedenti.

Versione della patchDefinizione: Si riferisce a correzioni di bug retrocompatibili o a miglioramenti minori.Sure! Please provide the text you would like me to translate into Italian.x.x.<Patch>

Esempi:v1.0.0->v1.1.0Correzione di un piccolo bug in un endpoint API.

Registro delle modifiche API

Un Change Log è un registro dettagliato delle modifiche, miglioramenti, correzioni di bug e nuove funzionalità introdotte in ciascuna versione di un software o di un'API. Fornisce trasparenza per gli utenti e gli sviluppatori documentando l'impatto di ciascun aggiornamento.

Un'entrata tipica in un registro delle modifiche include:Descrizione: Una breve spiegazione di cosa è stato cambiato.Componenti Affected: Moduli specifici, endpoint o funzionalità colpiti dalla modifica.

Esempio: Aggiunta la supporto per questo nuovo comando APISure! Here’s the translation of your text into Italian: <Registrazione Dominio>

Cronologia delle modificheTieni traccia di ogni modifica all'API di Dynadot.