API Belgelerine Genel Bakış

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

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

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

2. Tüm Ürünleri Al

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

Tanım: Sağlanan API anahtarıyla ilişkili tüm ürünleri alır.

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

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

Tanım: Sağlanan ürün ID ve API anahtarına göre belirli bir ürünün ayrıntılarını alır.

4. Satın Alma Doğrulaması

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

Tanım: Bir satın alma kodunu doğrulayın ve geçerliyse satın alma ile ilgili ayrıntıları döndürün.

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.

API Anahtar Bölümünü Bul

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

API Anahtarını Oluştur veya Al

Bu bölümde, kullanıcı yeni bir API anahtarı oluşturabilir veya daha önce oluşturulmuşsa mevcut bir anahtarı alabilir. Yeni bir anahtar oluşturma seçeneği varsa, kullanıcı yeni bir API anahtarı oluşturmak için üzerine tıklayabilir.

API Anahtarını Kopyala

API anahtarı oluşturulduktan veya alındıktan sonra, kullanıcı bunu ekranda görüntülenmiş olarak görebilmelidir. Anahtarın yanındaki bir düğmeye veya simgeye tıklayarak onu panoya kopyalayabilirler.

API Anahtarını Kullanın

API anahtarı kopyalandığında, kullanıcı artık platform API uç noktalarına erişirken isteklerini doğrulamak için bunu 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.

API Anahtarını Güvence Altına Alın

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.

Get Account Details

Retrieves details of the account associated with the provided API key

Endpoint

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

Parametreler

  • api_key: API anahtarınız (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": "TRY",
        "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

Sağlanan API anahtarıyla ilişkili tüm ürünleri alır

Endpoint

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

Parametreler

  • api_key: API anahtarınız (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 ürünleri için dahil değildir
                "preview_video": "https://example.com/video.mp4", // Bu yalnızca video ürünleri için dahildir
                "preview_audio": "https://example.com/audio.mp3", // Bu yalnızca ses ürünleri için dahildir
                "screenshots": [
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "TRY",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Error Response:

{
    "status": "error",
    "msg": "Hiçbir ürün bulunamadı"
}

Get An Item Details

Sağlanan ürün ID ve API anahtarına göre belirli bir ürünün ayrıntılarını alır.

Endpoint

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

Parametreler

  • api_key: API anahtarınız (Gerekli)
  • item_id: Alınacak ürünün ID (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 ürünleri için dahil değildir
            "preview_video": "https://example.com/video.mp4", // Bu yalnızca video ürünleri için dahildir
            "preview_audio": "https://example.com/audio.mp3", // Bu yalnızca ses ürünleri için dahildir
            "screenshots": [
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "TRY",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Error Response:

{
    "status": "error",
    "msg": "Ürün Bulunamadı"
}

Purchase Validation

Bir satın alma kodunu doğrulayın ve geçerliyse satın alma ile ilgili ayrıntıları döndürün.

Endpoint

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

Parametreler

  • api_key: API anahtarınız (Gerekli).
  • purchase_code: Doğrulamak için satın alma kodu (Gerekli).

Responses

Success Response:

{
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Düzenli",
            "price": 19.99,
            "currency": "TRY",
            "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": "Geçersiz satın alma kodu"
}