API

Uyarı: API şu anda geliştirilme aşamasındadır ve ek özelliklere tabidir: gelecekte yeni yöntemler ve parametreler eklenebilir. Yapılan tüm değişiklikler mevcut işlevsellikle geriye dönük olarak uyumlu kalacaktır.

Genel Bakış

TLD-List v1 API, TLD-List adresinde görüntülenen verileri canlı veritabanından almak için kullanılabilir.

API, JSON verileri içeren HTTP POST'ları kabul eder ve JSON verileriyle yanıt verir. Tüm API yöntemi istekleri için gereksinimler:

• İstekler HTTP POST yöntemi kullanılarak yapılmalıdır
• İstekler, kimlik doğrulama için geçerli bir genel ve özel API anahtar çifti içeren bir JSON gövdesine sahip olmalıdır
• İstekler şu başlığı içermelidir: Content-Type: application/json

Parametreler, JSON kodlu istek gövdesinde anahtar/değerler olarak API'ye aktarılır.

Tüm API istekleri için temel URL şöyledir: https://api.tld-list.com/v1

Kimlik Doğrulama

Kimlik doğrulama, yöntem URL'sine gönderilen JSON gövdesinde genel bir API anahtarı ve özel bir API anahtarı geçirilerek gerçekleştirilir. Tüm API çağrıları geçerli bir API anahtar çifti içermelidir. API anahtar çiftleri TLD-List hesabınızda API sekmesi altında oluşturulabilir.

API anahtarları oluşturmak için Hesap > API'yi ziyaret edin.

API anahtarları JSON istek gövdesinde apiKeyPublic (genel anahtarınız) ve apiKeyPrivate (özel anahtarınız) parametreleri kullanılarak iletilir.

Example authentication parameters

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

Yanıt

Tüm başarılı API yanıtları 200 SUCCESS HTTP durum koduna ve JSON kodlu bir gövdeye sahip olacaktır. Yanıttaki diğer HTTP durum kodları isteğin başarısız olduğunu ve bir hata oluştuğunu gösterir.

API tarafından döndürülen JSON yanıt nesneleri aşağıdaki yapıya sahip olacaktır:

Hataları içeren örnek başarısız yanıt nesnesi

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

Örnek başarılı yanıt nesnesi

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

Ortak Yanıt Nesneleri

API yöntemlerinden bazıları aynı yapıya sahip veri nesneleri döndürür. Bu ortak veri nesneleri aşağıda ayrıntılı olarak açıklanmıştır.

RegistrarPricing

Özel şartlar, ücretler, vergi ve promosyonlar gibi ek ayrıntılar da dahil olmak üzere, bir kayıt kuruluşunun belirli bir fiyat türü (register, renewal, transfer) için bir uzantıya yönelik perakende fiyatlandırmasını açıklar.

Özel şartlar, ücretler, vergi ve promosyonlar gibi ek ayrıntılar da dahil olmak üzere, bir kayıt kuruluşunun belirli bir fiyat türü (register, renewal, transfer) için bir uzantıya yönelik perakende fiyatlandırmasını açıklar.

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

'{'
    "limitPerCustomer": '{'
        "pricetype": [
            "register"
        ],
        "count": 1
    '}',
    "newCustomerOnly": '{'
        "pricetype": [
            "register"
        ]
    '}',
    "affiliateLink": '{'
        "pricetype": [
            "register"
        ]
    '}',
    "multiYearPurchaseRequired": '{'
        "pricetype": [
            "register"
        ],
        "count": 2
    '}',
    "nameserverLockIn": '{'
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ]
    '}',
    "idSubmissionRequired": '{'
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ]
    '}'
'}'

'{'
    "feeIcann": '{'
        "pricetype": [
            "register",
            "renewal",
            "transfer"
        ],
        "amount": "0.18",
        "addedToListPrice": true
    '}'
'}'

'{'
    "feeTax": [
        '{'
            "addedToListPrice": false,
            "appliesToCustomers": [
                "eu",
                "us",
                "in"
            ],
            "amountRateType": "percent",
            "amountRate": "13",
            "type": "hst"
        '}',
        '{'
            "addedToListPrice": false,
            "appliesToCustomers": [
                "ca"
            ],
            "amountRateType": "percent",
            "amountRate": "5",
            "type": "gst"
        '}'
    ]
'}'

'{'
    "feePayment": '{'
        "addedToListPrice": false,
        "amountRate": "~",
        "amountRateMin": "0.9",
        "amountRateMax": "20",
        "amountRateType": "percent-varies-by-method"
    '}'
'}'

'{'
    "currencyExchangeRate": '{'
        "base": "GBP",
        "quote": "USD",
        "rate": "1.2482"
    '}'
'}'

[
    '{'
        "name": "dns"
    '}',
    '{'
        "name": "whois-privacy"
    '}',
    '{'
        "name": "email-account",
        "count": 5
    '}',
    '{'
        "name": "ssl-cert",
        "duration": 365
    '}'
]

RegistrarPromo

Bir kayıt kuruluşu tarafından sunulan aktif bir promosyonu tanımlar. Örnek:

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

Hata Kodları

İstek başarısız olduğunda, JSON yanıt nesnesi neyin yanlış gittiğini açıklayan bir veya daha fazla hata nesnesi içerebilir. Aşağıda, hata nesnesinin kod alanında ayarlanabilecek tanımlayıcı hata kodlarının kapsamlı olmayan bir listesi bulunmaktadır.

Sınırlar

API'nin kullanımı, kötüye kullanımı önlemek için belirli sınırlamalara tabidir. Bu kullanım sınırlamaları aşağıda gösterilmiştir ve önceden haber verilmeksizin değiştirilebilir.

Uzatma Yöntemleri

get

Uzantıları ve bunlarla ilişkili fiyatlandırma ve ayrıntı verilerini döndürür. Bu yöntem, bu yöntem tarafından döndürülmeyen "En Ucuz Fiyat Geçmişi" verileri haricinde (geçmiş veriler için getAggregateHistory yöntemine bakın), bir veya daha fazla TLD ayrıntı sayfasında (örneğin, .com) görüntülenen verileri almaya benzer.

API uç noktası:https://api.tld-list.com/v1/extension/get

Yanıt süresi:~12 seconds for all extensions, ~6 seconds < 2000 extensions, ~2 seconds < 100 extensions

İstek parametreleri

Yanıt nesnesi

Tabloidation content...

Örnek istek/cevap

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

getNames

Tüm uzantı adlarını döndürür.

API uç noktası:https://api.tld-list.com/v1/extension/getNames

Yanıt süresi:~1 second

İstek parametreleri

Yanıt nesnesi

Örnek istek/cevap

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

getCheapestRegistrar

En ucuz alan adı kayıt şirketlerini/sağlayıcılarını, fiyatlarını, ortanca fiyatı ve alan adı uzantısı başına ortalama fiyatı döndürür. Herhangi bir kayıt şirketi tarafından satılmayan uzantılar döndürülmez.

API uç noktası:https://api.tld-list.com/v1/extension/getCheapestRegistrar

Yanıt süresi:~8 seconds for all extensions, ~4 seconds < 2000 extensions, ~1 second < 100 extensions

İstek parametreleri

Yanıt nesnesi

Örnek istek/cevap

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

Kayıt Yöntemleri

getIds

Tüm aktif kayıt şirketlerinin bir listesini döndürür.

API uç noktası:https://api.tld-list.com/v1/registrar/getIds

Yanıt süresi:~200 milliseconds

İstek parametreleri

Bu yöntem hiçbir parametre gerektirmez.

Yanıt nesnesi

Örnek istek/cevap

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