API

Avertissement: L'API est actuellement en cours de développement et peut faire l'objet d'ajouts de fonctionnalités : de nouvelles méthodes et de nouveaux paramètres peuvent être ajoutés à l'avenir. Toutes les modifications apportées resteront compatibles avec les fonctionnalités existantes.

Vue d'ensemble

L'API TLD-List v1 peut être utilisée pour récupérer les données affichées sur TLD-List à partir de sa base de données en direct.

L'API accepte les POST HTTP contenant des données JSON et répond avec des données JSON. Exigences pour toutes les demandes de méthodes API :

• Les demandes doivent être effectuées à l'aide de la méthode HTTP POST.
• Les demandes doivent avoir un corps JSON contenant une paire de clés API publiques et privées valides pour l'authentification.
• Les demandes doivent inclure l'en-tête : Content-Type : application/json

Les paramètres sont transmis à l'API sous forme de clés/valeurs dans le corps de la demande codée en JSON.

L'URL de base pour toutes les demandes d'API est la suivante :
https://api.tld-list.com/v1

Authentification

L'authentification s'effectue en transmettant une clé d'API publique et une clé d'API privée dans le corps JSON envoyé à l'URL de la méthode. Tous les appels API doivent inclure une paire de clés API valide. Les paires de clés API peuvent être générées dans votre compte TLD-List sous l'onglet API.

Visitez Compte > API pour créer des clés API.

Les clés d'API sont transmises dans le corps de la requête JSON à l'aide des paramètres apiKeyPublic (votre clé publique) et apiKeyPrivate (votre clé privée).

Example authentication parameters

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

Réponse

Toutes les réponses API réussies auront un code d'état HTTP 200 SUCCESS et un corps encodé JSON. Tout autre code d'état HTTP dans la réponse indique que la demande a échoué et qu'une erreur s'est produite.

Les objets de réponse JSON renvoyés par l'API auront la structure suivante :

Exemple d'objet de réponse ayant échoué avec des erreurs

'{' 
   "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"
'}'

Exemple d'objet de réponse réussie

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

Objets de réponse communs

Certaines méthodes de l'API renvoient des objets de données ayant la même structure. Ces objets de données communs sont décrits en détail ci-dessous.

RegistrarPricing

Décrit le prix de détail d'un bureau d'enregistrement pour une extension pour un type de prix particulier (register, renewal, transfer), y compris des détails supplémentaires tels que des conditions spéciales, des frais, des taxes et des promotions.

RegistrarPromo

Décrit une promotion active proposée par un bureau d'enregistrement.

Codes d'erreur

En cas d'échec de la demande, l'objet de réponse JSON peut contenir un ou plusieurs objets d'erreur qui décrivent ce qui n'a pas fonctionné.

Limites

L'utilisation de l'API est soumise à certaines limites afin d'éviter les abus. Ces limites d'utilisation sont indiquées ci-dessous et peuvent être modifiées sans préavis.

Pour plus d'informations sur l'API ou si vous avez des questions, consultez notre documentation complète ou contactez notre équipe d'assistance.

Méthodes d'extension

get

Renvoie les extensions et les données tarifaires et détaillées qui leur sont associées. Cette méthode s'apparente à la récupération des données affichées sur une ou plusieurs pages détaillées du TLD (par exemple, .com), à l'exception des données relatives à l'historique du prix le plus bas, qui ne sont pas renvoyées par cette méthode (voir la méthode getAggregateHistory pour les données historiques).

Point de terminaison de l'API: https://api.tld-list.com/v1/extension/get

Temps de réponse: ~12 seconds for all extensions, ~6 seconds < 2000 extensions, ~2 seconds < 100 extensions

Paramètres de la demande

Objet de la réponse

Exemple de demande/réponse

curl -X POST https://api.tld-list.com/v1/extension/get

getNames

Renvoie tous les noms d'extension.

Point de terminaison de l'API: https://api.tld-list.com/v1/extension/getNames

Temps de réponse: ~1 second

Paramètres de la demande

Objet de la réponse

Exemple de demande/réponse

curl -X POST https://api.tld-list.com/v1/extension/getNames

getCheapestRegistrar

Renvoie les bureaux d'enregistrement les moins chers par extension de domaine.

Point de terminaison de l'API: https://api.tld-list.com/v1/extension/getCheapestRegistrar

Temps de réponse: ~8 seconds for all extensions, ~4 seconds < 2000 extensions, ~1 second < 100 extensions

Paramètres de la demande

Objet de la réponse

Exemple de demande/réponse

curl -X POST https://api.tld-list.com/v1/extension/getCheapestRegistrar

Méthodes du registre

getIds

Renvoie tous les identifiants des bureaux d'enregistrement, chacun d'entre eux identifiant de manière unique un bureau d'enregistrement activement répertorié sur TLD-List.

Point de terminaison de l'API: https://api.tld-list.com/v1/registrar/getIds

Temps de réponse: < 1 second

Paramètres de la demande

Aucun

Objet de la réponse

Exemple de demande/réponse

curl -X POST https://api.tld-list.com/v1/registrar/getIds