API Dokümantasyonu

1. Hesap Detaylarını Al

Endpoint: GET https://www.kurumsalkey.com/api/account/details

Açıklama: Sağlanan API anahtarıyla ilişkili hesabın detaylarını getirir.

2. Tüm Ürünleri Getir

Endpoint: GET https://www.kurumsalkey.com/api/items/all

Açıklama: Sağlanan API anahtarıyla ilişkili tüm ürünleri getirir.

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

Endpoint: GET https://www.kurumsalkey.com/api/items/item

Açıklama: Sağlanan ürün ID'si ve API anahtarıyla belirli bir ürünün detaylarını getirir.

4. Satın Alma Doğrulaması

Endpoint: POST https://www.kurumsalkey.com/api/purchases/validation

Açıklama: Bir satın alma kodunu doğrular ve geçerliyse satın alma ile ilgili detayları döner.

Kimlik Doğrulama

Çalışma Alanı Ayarlarına Git

Kullanıcı, önce platformda hesabına giriş yapmalıdır. Daha sonra, çalışma alanlarının "Ayarlar" bölümüne gidebilir.

API Anahtarı Bölümünü Bulun

Çalışma alanı ayarlarında, özellikle "API Anahtarı" veya "API Erişimi" olarak etiketlenmiş bir bölümü aramalıdır.

API Anahtarını Oluşturun veya Alın

Bu bölümde, kullanıcı yeni bir API anahtarı oluşturabilir ya da daha önce oluşturulmuş bir anahtarı alabilir. Yeni bir anahtar oluşturma seçeneği varsa, kullanıcı tıklayarak yeni bir API anahtarı oluşturabilir.

API Anahtarını Kopyalayın

API anahtarı oluşturulduktan veya alındıktan sonra, ekranda görüntülenebilir. Kullanıcı, anahtarın yanındaki düğmeye veya ikona tıklayarak anahtarı panoya kopyalayabilir.

API Anahtarını Kullanın

Kopyalanan API anahtarıyla kullanıcı, platform API uç noktalarına erişirken taleplerini doğrulamak için anahtarı kullanabilir. Genellikle API doğrulama mekanizmasına bağlı olarak API anahtarı, istek başlıklarında veya parametrelerde dahil edilmelidir.

API Anahtarını Güvende Tutma

Kullanıcılara API anahtarlarını güvende tutmaları ve başkalarıyla paylaşmamaları gerektiği hatırlatılmalıdır. API anahtarlarını istemci tarafı kodlarında sabitlemekten veya herkese açık depolarda paylaşmaktan kaçınmalıdırlar. Bunun yerine, API anahtarlarını sunucu tarafı uygulamalarında güvenli bir şekilde saklamaları ve uygun erişim kontrolleri kullanmaları önerilir.

Hesap Detaylarını Getir

Sağlanan API anahtarıyla ilişkili hesabın detaylarını getirir.

Endpoint


            GET
https://www.kurumsalkey.com/api/account/details

Parametreler

api_key: API Anahtarınız (Zorunlu)

Yanıtlar

Başarılı Yanıt:


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

Hata Yanıtı:


            {
    "status": "error",
    "msg": "Invalid request"
}

Tüm Ürünleri Getir

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

Bu yalnızca satıcılar için çalışır ve normal kullanıcılar için geçerli değildir.

Endpoint


            GET
https://www.kurumsalkey.com/api/items/all

Parametreler

api_key: API Anahtarınız (Zorunlu)

Yanıtlar

Başarılı Yanıt:


            {
    "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", // This is not included for audio items
                "preview_video": "https://example.com/video.mp4", // This is only included for video items
                "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
                "screenshots": [ // This is only included if item has 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...
        }
    ]
}

Hata Yanıtı:


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

Bir Ürünün Detaylarını Getir

Sağlanan ürün ID'si ve API anahtarıyla belirli bir ürünün detaylarını getirir.

Bu yalnızca satıcılar için çalışır ve normal kullanıcılar için geçerli değildir.

Endpoint


            GET
https://www.kurumsalkey.com/api/items/item

Parametreler

api_key: API Anahtarınız (Zorunlu)
item_id: The ID of the item to retrieve (Zorunlu)

Yanıtlar

Başarılı Yanıt:


            {
    "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", // This is not included for audio items
            "preview_video": "https://example.com/video.mp4", // This is only included for video items
            "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
            "screenshots": [ // This is only included if item has 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"
    }
}

Hata Yanıtı:


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

Satın Alma Doğrulaması

Bir satın alma kodunu doğrular ve geçerliyse satın alma ile ilgili detayları döner.

Bu yalnızca satıcılar için çalışır ve normal kullanıcılar için geçerli değildir.

Endpoint


            POST
https://www.kurumsalkey.com/api/purchases/validation

Parametreler

api_key: API Anahtarınız (Zorunlu).
purchase_code: The purchase code to validate (Zorunlu).

Yanıtlar

Başarılı Yanıt:


            {
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Standart",
            "price": 19.99,
            "currency": "TRY",
            "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", // This is not included for audio items
                    "preview_video": "https://example.com/video.mp4", // This is only included for video items
                    "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
                    "screenshots": [ This is only included if item has 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"
            },
            "supported_until": "2024-04-27T12:00:00Z", // This will not exist if support is disabled or its not supported
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Hata Yanıtı:


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