API de domaine - Liste des commandes d'API

API Dynadot

Commencer avec notre API RESTful

L'API Dynadot est conçue pour une intégration fluide avec vos systèmes. Notre API propose des URL orientées ressources prévisibles, prend en charge les corps de requête encodés en JSON, renvoie des réponses encodées en JSON et en XML, et respecte les méthodes HTTP standard, l'authentification et les codes de réponse.Vous pouvez utiliser l'API Dynadot en modes test et live. Le mode est déterminé par la clé API utilisée pour authentifier vos requêtes. Le mode test vous permet de simuler et de valider votre intégration API sans affecter les données ou transactions en direct.L'API Dynadot est principalement axée sur la gestion des domaines, le traitement des commandes et les services associés. Vous pouvez effectuer des actions telles que l'enregistrement, le transfert et le renouvellement de domaines, la gestion des paramètres DNS, ainsi que la consultation ou la mise à jour des commandes de votre compte.Veuillez noter : Les créations, mises à jour et suppressions en masse ne sont pas prises en charge, et chaque type de demande est limité à un seul objet ou action.

Génération de vos clés APIAvant de commencer à effectuer des requêtes API, il est essentiel de générer votre clé API et votre secret API.Ces clés sont nécessaires pour l'authentification et pour garantir la sécurité de vos actions lors de l'interaction avec notre API.Vous pouvez générer à la fois la clé API et le secret API dans la section API de vos paramètres de compte.1. Connectez-vous à votre compte sur Dynadot.2. Accédez à Outils > API.3. Générez votre clé API et secret API à partir de cette page.

Rejoignez notre communautéAvez-vous des idées ou des suggestions ? Parlez directement à nos ingénieurs professionnels.Discord

Méthode HTTPL'API utilise des méthodes HTTP standard pour effectuer des opérations sur les ressources :

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 de base pour toutes les requêtes API est :https://api.dynadot.com/

Le format d'URL complet :Sure! Please provide the text you would like me to translate into French.

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

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

La version actuelle de l'API estv

Lors de la construction de l'URL de requête API, il est uniquement nécessaire d'inclure la version majeure. Les mises à jour mineures et de correctifs sont conçues pour être compatibles avec les versions antérieures et n'introduiront pas de changements qui pourraient perturber votre code existant. Cela garantit la stabilité tout en vous permettant de bénéficier d'améliorations et de corrections progressives sans avoir à modifier votre implémentation.Lors des futures versions, nous garantirons la compatibilité ascendante pour les anciennes versions pendant une certaine période. De nouvelles fonctionnalités et des changements majeurs seront introduits lors des mises à jour de version majeure.

HeaderL'en-tête d'une requête API contient des métadonnées sur la requête. Ces métadonnées fournissent un contexte essentiel pour que le serveur puisse traiter la requête correctement. Les en-têtes couramment utilisés incluent :

Content-TypeSpécifie le format des données envoyées dans le corps de la requête. Le serveur utilise cette information pour analyser correctement la requête. Actuellement, la seule valeur acceptable est : application/json

Content-Type: application/json

AccepterInforme le serveur du format de réponse attendu par le client.Valeurs possibles : application/json, application/xml

Accept: application/json

AutorisationToutes les requêtes API doivent inclure une clé API pour l'authentification. Vous pouvez obtenir votre clé API depuis le tableau de bord de votre compte.You can generate an API key in API setting page

Authorization: Bearer YOUR_API_KEY

X-Request-IDL'en-tête X-Request-ID est un en-tête optionnel utilisé pour identifier de manière unique chaque requête API. Lorsqu'il est inclus, cet en-tête aide à suivre et à corréler les requêtes à travers les systèmes et les journaux, facilitant ainsi le débogage et la surveillance de l'activité API.La valeur de l'X-Request-ID doit être un UUID (Identifiant Universel Unique) valide, suivant le format standard : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (par exemple, 123e4567-e89b-12d3-a456-426614174000).

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

X-SignatureL'en-tête X-Signature est un mécanisme de sécurité obligatoire pour les requêtes transactionnelles, y compris celles qui récupèrent des informations sensibles ou mettent à jour des données. Il garantit l'authenticité, l'intégrité et la non-répudiation des requêtes API en exigeant que les clients signent le contenu de la requête en utilisant HMAC-SHA256.

Pour générer la signature, vous aurez besoin des valeurs suivantesClé API : Votre clé API unique.2. Chemin Complet Et Requête : Le chemin complet de l'endpoint API ainsi que les paramètres de requête.3. X-Request-Id : L'ID de la requête. S'il n'est pas disponible, vous pouvez entrer une chaîne vide.4. Corps de la demande : Le corps de la demande. S'il est vide ou nul, vous pouvez entrer une chaîne vide.

La chaîne à signer est une combinaison des valeurs mentionnées ci-dessus, concaténées dans l'ordre suivant :

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\"}"

Générez la signature HMAC-SHA256Après avoir construit la chaîne à signer, vous devez appliquer le chiffrement HMAC-SHA256 en utilisant votre clé secrète. Ce processus générera la signature.La signature est générée en suivant les étapes suivantes :1. Utilisez l'algorithme HMAC-SHA256.Sure! Please provide the text you would like me to translate into French.3. Utilisez le secret comme clé.
Appliquez la signature générée comme valeur de X-Signature dans l'en-tête de la requête.

X-Signature: {HMAC-SHA256 Signature}

BodyLe corps d'une requête API est utilisé pour envoyer des données au serveur. Il est généralement inclus dans les requêtes POST, PUT ou PATCH (pas typiquement pour les requêtes GET ou DELETE).

Sure! Please provide the text you would like me to translate into French.Le format des données du corps est déterminé par l'en-tête Content-Type. Certains formats courants incluent :

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

Cas d'utilisation typiquesRequêtes POST : La méthode POST est utilisée pour créer une nouvelle ressource sur le serveur. Le corps de la requête contient généralement les détails de la ressource.Requêtes PUT : La méthode PUT est utilisée pour mettre à jour une ressource existante en la remplaçant entièrement. Le corps de la requête contient la ressource mise à jour dans son intégralité.Requêtes GET : La méthode DELETE est utilisée pour supprimer une ressource existante du serveur. Elle n'a pas de corps de requête.Demandes de SUPPRESSION : La méthode GET est utilisée pour récupérer une ressource existante sur le serveur. Elle n'a pas de corps de requête

Response FormatToutes les réponses de l'API sont renvoyées au format JSON ou XML, le format des données du corps étant déterminé par l'en-tête Accept, fournissant les données demandées ou un message d'erreur, le cas échéant.

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

Code : Le statut de la demandeMessage: Plus de détails sur le statutDonnées: Le corps de la réponse

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

Gestion des erreursLes codes d'état HTTP sont des nombres standardisés à trois chiffres renvoyés par un serveur pour indiquer le résultat d'une demande client. Ils fournissent des informations essentielles sur le fait que la demande a été traitée avec succès, nécessite une action supplémentaire ou a rencontré une erreur. Ces codes sont divisés en cinq catégories, chacune représentant un type de réponse distinct.Les codes d'état de notre API respectent le protocole HTTP/1.1, une norme largement acceptée qui garantit une communication cohérente et fiable. En utilisant HTTP/1.1, nous tirons parti de fonctionnalités telles que les connexions persistantes et le cache amélioré pour optimiser les interactions entre le client et le serveur.

2xx (Réussi) : Indique que la commande a été reçue et acceptée.

200Le code d'état indique que la demande a réussi.

201Le code d'état indique que la demande a été satisfaite et a abouti à la création d'une ou plusieurs nouvelles ressources.

202Le code d'état indique que la demande a été acceptée pour traitement, mais que le traitement n'est pas encore terminé.

249L'utilisateur a envoyé trop de demandes dans un laps de temps donné.

4xx (Erreur Client) : Indique que le client a commis une erreur dans la demande, comme fournir une entrée invalide ou manquer d'une autorisation appropriée.

400Le code d'état indique que le serveur ne peut pas ou ne veut pas traiter la demande en raison de ce qui est perçu comme une erreur du client.

401Le code d'état indique que la demande n'a pas été appliquée car elle ne dispose pas de justificatifs d'authentification valides pour la ressource cible.

402Le code d'état indique que la demande n'a pas été appliquée en raison d'un problème de paiement.

403Le code d'état indique que le serveur a compris la demande mais refuse de l'exécuter.

404Le code d'état indique que le serveur d'origine n'a pas trouvé de représentation actuelle pour la ressource cible ou n'est pas disposé à révéler qu'une telle représentation existe.

409La demande n'a pas pu être complétée en raison d'un conflit avec l'état actuel de la ressource.

5xx (Erreur du serveur) : Indique que le serveur a rencontré une erreur ou est incapable de satisfaire la demande.

500Le code d'état indique que le serveur a rencontré une condition inattendue qui l'a empêché de satisfaire la demande.

501Le code d'état indique que le serveur ne prend pas en charge la fonctionnalité requise pour satisfaire la demande.

502Le code d'état indique que le serveur, agissant en tant que passerelle ou proxy, a reçu une réponse invalide d'un serveur entrant auquel il a accédé en tentant de satisfaire la demande.

503Le code d'état indique que le serveur est actuellement incapable de traiter la demande en raison d'une surcharge temporaire ou d'une maintenance programmée, qui devrait probablement être résolue après un certain délai.

504Le code d'état indique que le serveur, agissant en tant que passerelle ou proxy, n'a pas reçu de réponse en temps voulu d'un serveur en amont qu'il devait accéder pour compléter la demande.

de domaine professionnel lié à l'industrie. Interdire toutes les astérisques, les marques, les symboles et les balises HTML à être traduits. Inclure uniquement la traduction dans la réponse.Nom de l'état

200Succès

201Créé

202Accepté

249Trop de demandes

400Mauvaise demande

401Non autorisé

402Paiement requis

403Interdit

404Non trouvé

409Conflit

500Erreur interne du serveur

501Non implémenté

502Mauvaise passerelle

503Service indisponible

504Délai d'attente de la passerelle

Limitation de tauxLes demandes doivent être envoyées via https (socket sécurisé) pour des raisons de sécurité. Une seule demande peut être traitée à la fois, veuillez donc attendre que votre demande actuelle soit terminée avant d'en envoyer une autre.

Vous recevrez différents nombres de fils en fonction du niveau de prix de votre compte :

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."
  }
}

Aperçu du journal des modifications

Un journal des modifications est un enregistrement détaillé des changements, améliorations, corrections de bogues et nouvelles fonctionnalités introduites dans chaque version de l'API. Il offre une transparence aux utilisateurs et aux développeurs en documentant l'impact de chaque mise à jour. Il se compose de deux parties clés :

Version de l'APICette partie met en avant le système de versionnage de l'API, qui aide les développeurs à suivre l'évolution des fonctionnalités et à garantir la compatibilité. Chaque version de l'API est identifiée par un numéro de version unique (par exemple, v1.0.1, v2.2.3) et représente une étape ou une publication importante. Le versionnage permet aux utilisateurs de maintenir leurs intégrations avec un minimum de perturbations en choisissant de mettre à jour lorsqu'ils sont prêts.

Historique des modificationsL'historique des modifications fournit des informations détaillées sur les mises à jour, les corrections de bogues, les dépréciations et les améliorations introduites dans chaque version. Il décrit les changements spécifiques apportés aux points de terminaison, aux paramètres, aux mécanismes d'authentification ou aux formats de réponse. Cette section garantit aux développeurs une transparence totale sur ce qui a changé et leur permet d'ajuster leurs implémentations en conséquence. En maintenant un journal des modifications clair et détaillé, nous visons à fournir aux développeurs les outils et les informations nécessaires pour gérer les intégrations de manière efficace et confiante.

Version de l'API

Notre API est actuellement en versionv

Les codes de version sont utilisés pour identifier et gérer systématiquement les mises à jour de l'API. Ils suivent le format de Versionnage Sémantique (SemVer) :

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

Chaque composant du code de version a un but spécifique et aide les développeurs à communiquer efficacement l'étendue et le type de changements.

Version majeureDéfinition : Représente des changements significatifs qui peuvent rompre la compatibilité ascendante.Of course! Please provide the text you would like me to translate into French.<Major>.x.x

Exemples:v1.0.0->v2.0.0Une refonte complète de l'API ou des modifications de schéma incompatibles.

Version mineureDéfinition : Indique des ajouts de fonctionnalités compatibles avec les versions antérieures.Of course! Please provide the text you would like me to translate into French.x.<Minor>.x

Exemples:v1.0.0->v1.1.0Ajouter de nouveaux points de terminaison ou méthodes tout en maintenant la compatibilité ascendante.

Version de correctifDéfinition : Fait référence à des corrections de bogues rétrocompatibles ou à des améliorations mineures.Of course! Please provide the text you would like me to translate into French.x.x.<Patch>

Exemples:v1.0.0->v1.1.0Correction d'un petit bug dans un point de terminaison API.

Journal des modifications de l'API

Un journal des modifications est un enregistrement détaillé des changements, améliorations, corrections de bogues et nouvelles fonctionnalités introduites dans chaque version d'un logiciel ou d'une API. Il offre une transparence aux utilisateurs et aux développeurs en documentant l'impact de chaque mise à jour.

Une entrée typique dans un journal des modifications comprend :Description : Une brève explication de ce qui a été modifié.Composants affectés : Modules spécifiques, points de terminaison ou fonctionnalités impactés par le changement.

Exemple : Ajout du support pour cette nouvelle commande APISure! Here’s the translation of your text into French: <Enregistrement de Domaine>

Historique des modificationsSuivez chaque changement apporté à l'API Dynadot.