API

Ostrzeżenie: API jest obecnie w fazie rozwoju i podlega dodaniu nowych funkcji: nowe metody i parametry mogą zostać dodane w przyszłości. Wszelkie wprowadzone zmiany pozostaną wstecznie kompatybilne z istniejącą funkcjonalnością.

Przegląd

Interfejs API TLD-List v1 może być używany do pobierania danych wyświetlanych na stronie TLD-List z bazy danych na żywo.

API akceptuje HTTP POST zawierające dane JSON i odpowiada danymi JSON. Wymagania dla wszystkich żądań metod API:

• Żądania muszą być składane przy użyciu metody HTTP POST
• Żądania muszą mieć treść JSON zawierającą prawidłową parę publicznych i prywatnych kluczy API do uwierzytelniania
• Żądania muszą zawierać nagłówek: Content-Type: application/json

Parametry są przekazywane do interfejsu API jako klucze/wartości w treści żądania zakodowanej w formacie JSON.

Podstawowy adres URL dla wszystkich żądań API to: https://api.tld-list.com/v1

Uwierzytelnianie

Uwierzytelnianie odbywa się poprzez przekazanie publicznego klucza API i prywatnego klucza API w treści JSON przesłanej do adresu URL metody. Wszystkie wywołania API muszą zawierać prawidłową parę kluczy API. Pary kluczy API można wygenerować na koncie TLD-List w zakładce API.

Proszę odwiedzić Konto > API, aby utworzyć klucze API.

Klucze API są przekazywane w treści żądania JSON przy użyciu parametrów apiKeyPublic (Państwa klucz publiczny) i apiKeyPrivate (Państwa klucz prywatny).

Example authentication parameters

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

Odpowiedź

Wszystkie pomyślne odpowiedzi API będą miały kod stanu HTTP 200 SUCCESS i zakodowaną treść JSON. Każdy inny kod stanu HTTP w odpowiedzi wskazuje, że żądanie nie powiodło się i wystąpił błąd.

Obiekty odpowiedzi JSON zwracane przez API będą miały następującą strukturę:

Przykład nieudanego obiektu odpowiedzi z błędami

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

Przykład pomyślnego obiektu odpowiedzi

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

Wspólne obiekty odpowiedzi

Niektóre metody API zwracają obiekty danych o tej samej strukturze. Te typowe obiekty danych zostały szczegółowo opisane poniżej.

RegistrarPricing

Opisuje ceny detaliczne rejestratora dla rozszerzenia dla określonego typu cenowego (register, renewal, transfer), w tym dodatkowe szczegóły, takie jak specjalne warunki, opłaty, podatki i promocje.

RegistrarPromo

Opisuje aktywną promocję oferowaną przez rejestratora.

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

Kody błędów

W przypadku niepowodzenia żądania obiekt odpowiedzi JSON może zawierać jeden lub więcej obiektów błędów, które opisują, co poszło nie tak. Poniżej znajduje się niepełna lista identyfikacyjnych kodów błędów, które można ustawić w polu kodu obiektu błędu.

Ograniczenia

Korzystanie z API podlega pewnym ograniczeniom, aby zapobiec nadużyciom. Te ograniczenia użytkowania są przedstawione poniżej i mogą ulec zmianie bez powiadomienia.

Metody rozszerzenia

get

Zwraca rozszerzenia i powiązane z nimi dane dotyczące cen i szczegółów. Ta metoda jest podobna do pobierania danych wyświetlanych na jednej lub kilku stronach szczegółów TLD (na przykład .com), z wyjątkiem danych "Historia najtańszych cen", które nie są zwracane przez tę metodę.

Punkt końcowy API:https://api.tld-list.com/v1/extension/get

Czas reakcji: ~12 seconds for all extensions, ~6 seconds < 2000 extensions, ~2 seconds < 100 extensions

Parametry żądania

Obiekt odpowiedzi

Przykład żądania/odpowiedzi

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

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

getNames

Zwraca wszystkie nazwy rozszerzeń.

Punkt końcowy API:https://api.tld-list.com/v1/extension/getNames

Czas reakcji: ~1 second

Parametry żądania

Obiekt odpowiedzi

Przykład żądania/odpowiedzi

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", "wantPunycode": true, "omitExtensionsWithoutRegistrars": true'}'

'{'
   "data" : [
      "2000.hu",
      "5g.in"
   ],
   "errors" : [],
   "seconds" : 0.697,
   "status" : "SUCCESS"
'}'

getCheapestRegistrar

Zwraca najtańszych rejestratorów/dostawców, ich ceny, medianę cen i średnią cenę za rozszerzenie domeny. Rozszerzenia, które nie są sprzedawane przez żadnego rejestratora, nie są zwracane.

Punkt końcowy API:https://api.tld-list.com/v1/extension/getCheapestRegistrar

Czas reakcji: ~8 seconds for all extensions, ~4 seconds < 2000 extensions, ~1 second < 100 extensions

Parametry żądania

Obiekt odpowiedzi

Przykład żądania/odpowiedzi

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", "includeRegistrars": ["godaddy", "namecheap", "porkbun", "namesilo", "netim"], "extensions": ["com", "co.uk"]'}'

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

Metody rejestratora

getIds

Zwraca wszystkie identyfikatory rejestratorów, z których każdy jednoznacznie identyfikuje rejestratora aktywnie notowanego na stronie TLD-List.

Punkt końcowy API:https://api.tld-list.com/v1/registrar/getIds

Czas reakcji: < 1 second

Parametry żądania

Brak

Obiekt odpowiedzi

Przykład żądania/odpowiedzi

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"
   ],
   "errors" : [],
   "seconds" : 0.001,
   "status" : "SUCCESS"
'}'