API Documentation Overview

1. Hesap Ayrıntılarını Alın

Endpoint: GET https://dnscheckup.com/api/account/details

Açıklama: Sağlanan API anahtarıyla ilişkili hesabın ayrıntılarını alır.

2. Get All Items

Endpoint: GET https://dnscheckup.com/api/items/all

Açıklama: Retrieves all items associated with the provided API key.

3. Bir Ürün Detayları Alın

Endpoint: GET https://dnscheckup.com/api/items/item

Açıklama: Sağlanan öğe kimliği ve API anahtarına göre belirli bir öğenin ayrıntılarını alır.

4. Purchase Validation

Endpoint: POST https://dnscheckup.com/api/purchases/validation

Açıklama: Validate a purchase code and returns details about the purchase if valid.

Authentication

Çalışma Alanı Ayarlarına gidin

Kullanıcının önce platformdaki hesabına giriş yapması gerekir. Daha sonra çalışma alanının "Ayarlar" bölümüne gidebilir.

Locate API Key Section

Çalışma alanı ayarları içerisinde, kullanıcı özel olarak "API Anahtarı" veya "API Erişimi" olarak etiketlenen bölümü aramalıdır.

Generate or Retrieve API Key

In this section, the user can either generate a new API key or retrieve an existing one if it has been previously generated. If there is an option to generate a new key, the user can click on it to create a fresh API key.

Copy the API Key

Once the API key is generated or retrieved, the user should be able to see it displayed on the screen. They can simply click on a button or icon next to the key to copy it to their clipboard.

Use the API Key

API anahtarı kopyalandığında, kullanıcı artık bunu platform API uç noktalarına erişirken isteklerini doğrulamak için kullanabilir. Genellikle API kimlik doğrulama mekanizmasına bağlı olarak API anahtarını istek başlıklarının veya parametrelerinin bir parçası olarak eklemeleri gerekir.

Secure the API Key

Kullanıcılara API anahtarlarını güvenli tutmaları ve bunları herkese açık olarak paylaşmamaları gerektiğini hatırlatmak önemlidir. API anahtarlarını istemci tarafı koduna sabit kodlamaktan veya herkese açık olarak erişilebilen depolarda paylaşmaktan kaçınmalıdırlar. Bunun yerine, API anahtarını sunucu tarafı uygulamalarında güvenli bir şekilde depolamayı ve uygun erişim kontrollerini kullanmayı düşünmelidirler.

Hesap Ayrıntılarını Alın

Sağlanan API anahtarıyla ilişkili hesabın ayrıntılarını alır

Endpoint

GET
https://dnscheckup.com/api/account/details

Parameters

  • api_key: Your API key (Gerekli)

Responses

Success Response:

{
    "status": "success",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "john.doe@example.com",
        "balance": 100.00,
        "currency": "TL",
        "profile": {
            "heading": "Profile Heading",
            "description": "Profile Description",
            "contact": {
                "email": "contact@example.com"
            },
            "social_links": [
                "facebook": "/",
                "x": "/",
                // etc...
            ],
            "media": {
                "avatar": "https://example.com/avatar.jpg",
                "cover": "https://example.com/cover.jpg"
            }
        },
        "registered_at": "2024-04-27T12:00:00Z"
    }
}

Error Response:

{
    "status": "error",
    "msg": "Geçersiz istek"
}

Get All Items

Retrieves all items associated with the provided API key

Endpoint

GET
https://dnscheckup.com/api/items/all

Parameters

  • api_key: Your API key (Gerekli)

Responses

Success Response:

{
    "status": "success",
    "items": [
        {
            "id": 1,
            "name": "Sample Item",
            "description": "This is a sample item",
            "category": "Category Name",
            "sub_category": "Subcategory Name",
            "options": ["option1", "option2"],
            "version": 1.0.0,
            "demo_link": "https://example.com/demo",
            "tags": ["tag1", "tag2"],
            "media": {
                "thumbnail": "https://example.com/thumbnail.png",
                "preview_image": "https://example.com/preview.jpg", // Bu, ses öğeleri için dahil değildir
                "preview_video": "https://example.com/video.mp4", // Bu yalnızca video öğeleri için dahildir
                "preview_audio": "https://example.com/audio.mp3", // Bu yalnızca ses öğeleri için dahildir
                "screenshots": [
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "TL",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Error Response:

{
    "status": "error",
    "msg": "Hiçbir öğe bulunamadı"
}

Bir Ürün Detayları Alın

Sağlanan öğe kimliği ve API anahtarına göre belirli bir öğenin ayrıntılarını alır.

Endpoint

GET
https://dnscheckup.com/api/items/item

Parameters

  • api_key: Your API key (Gerekli)
  • item_id: The ID of the item to retrieve (Gerekli)

Responses

Success Response:

{
    "status": "success",
    "item": {
        "id": 1,
        "name": "Sample Item",
        "description": "This is a sample item",
        "category": "Category Name",
        "sub_category": "Subcategory Name",
        "options": ["option1", "option2"],
        "version": 1.0.0,
        "demo_link": "https://example.com/demo",
        "tags": ["tag1", "tag2"],
        "media": {
            "thumbnail": "https://example.com/thumbnail.png",
            "preview_image": "https://example.com/preview.jpg", // Bu, ses öğeleri için dahil değildir
            "preview_video": "https://example.com/video.mp4", // Bu yalnızca video öğeleri için dahildir
            "preview_audio": "https://example.com/audio.mp3", // Bu yalnızca ses öğeleri için dahildir
            "screenshots": [
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "TL",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Error Response:

{
    "status": "error",
    "msg": "Item Not Found"
}

Purchase Validation

Validate a purchase code and returns details about the purchase if valid.

Endpoint

POST
https://dnscheckup.com/api/purchases/validation

Parameters

  • api_key: Your API key (Gerekli).
  • purchase_code: The purchase code to validate (Gerekli).

Responses

Success Response:

{
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Normal",
            "price": 19.99,
            "currency": "TL",
            "item": {
                "id": 1,
                "name": "Sample Item",
                "url": "https://example.com/item",
                "media": {
                    "preview_image": "https://example.com/preview.jpg"
                }
            },
            "supported_until": "2024-04-27T12:00:00Z", // Destek devre dışı bırakılırsa veya desteklenmezse bu mevcut olmayacaktır
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Error Response:

{
    "status": "error",
    "msg": "Invalid purchase code"
}