API Belgelerine Genel Bakış

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

Endpoint: GET https://codecex.com.tr/api/account/details

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

2. Tüm ürünleri alın

Endpoint: GET https://codecex.com.tr/api/items/all

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

3. Bir ürünün ayrıntılarını alın

Endpoint: GET https://codecex.com.tr/api/items/item

Açıklama: Sağlanan ürün kimliğine 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://codecex.com.tr/api/purchases/validation

Açıklama: Bir satın alma kodunu doğrulayın ve geçerliyse satın alma işlemiyle ilgili ayrıntıları döndürür.

Kimlik doğrulama

Çalışma Alanı Ayarlarına gidin

Kullanıcı öncelikle platformdaki hesabına giriş yapmalıdır. Daha sonra çalışma alanlarının "Ayarlar" bölümüne gidebilirler.

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

Kullanıcı, çalışma alanı ayarlarında özel olarak "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 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 buna tıklayabilir.

API Anahtarını kopyalayın

API anahtarı oluşturulduktan veya alındıktan sonra kullanıcının ekranda görüntülendiğini görebilmesi gerekir. Anahtarın yanındaki bir düğmeye veya simgeye tıklayarak onu panolarına kopyalayabilirler.

API Anahtarını kullanın

Kopyalanan API anahtarıyla kullanıcı artık platformun API uç noktalarına erişirken isteklerinin kimliğini doğrulamak için bunu kullanabilir. API kimlik doğrulama mekanizmasına bağlı olarak genellikle istek başlıklarının veya parametrelerinin bir parçası olarak API anahtarını eklemeleri gerekir.

API Anahtarını Güvenli Hale Getirin

Kullanıcılara API anahtarlarını güvende tutmalarını ve bunları herkese açık olarak paylaşmamalarını hatırlatmak önemlidir. API anahtarlarını istemci tarafı koduna sabit kodlamaktan veya bunları herkesin erişebileceği depolarda paylaşmaktan kaçınmalıdırlar. Bunun yerine API anahtarını sunucu tarafı uygulamalarında güvenli bir şekilde saklamayı 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://codecex.com.tr/api/account/details

Parametreler

  • api_key: API anahtarınız (Gerekli)

Tepkiler

Başarı 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": "USD",
        "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": "Geçersiz istek"
}

Tüm ürünleri al

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

Endpoint

GET
https://codecex.com.tr/api/items/all

Parametreler

  • api_key: API anahtarınız (Gerekli)

Tepkiler

Başarı 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"],
            "demo_link": "https://example.com/demo",
            "tags": ["tag1", "tag2"],
            "media": {
                "preview_image": "https://example.com/preview.jpg",
                "screenshots": [
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "USD",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Hata Yanıtı:

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

Ürün Detaylarını Alın

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

Endpoint

GET
https://codecex.com.tr/api/items/item

Parametreler

  • api_key: API anahtarınız (Gerekli)
  • item_id: Alınacak ürünün kimliği (Gerekli)

Tepkiler

Başarı 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"],
        "demo_link": "https://example.com/demo",
        "tags": ["tag1", "tag2"],
        "media": {
            "preview_image": "https://example.com/preview.jpg",
            "screenshots": [
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "USD",
        "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ğrulayın ve geçerliyse satın alma işlemiyle ilgili ayrıntıları döndürür.

Endpoint

POST
https://codecex.com.tr/api/purchases/validation

Parametreler

  • api_key: API anahtarınız (Gerekli).
  • purchase_code: Doğrulanacak satın alma kodu (Gerekli).

Tepkiler

Başarı Yanıtı:

{
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Normal Lisans",
            "price": 19.99,
            "currency": "USD",
            "item": {
                "id": 1,
                "name": "Sample Item",
                "url": "https://example.com/item",
                "media": {
                    "preview_image": "https://example.com/preview.jpg"
                }
            },
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Hata Yanıtı:

{
    "status": "error",
    "msg": "Geçersiz satın alma kodu"
}