API Documentation Overview

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

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

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

2. Get All Items

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

Açıklama / Tanıtım: Retrieves all items associated with the provided API key.

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

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

Açıklama / Tanıtım: 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://codeturk.com/api/purchases/validation

Açıklama / Tanıtı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

Navigate to Workspace Settings

The user should first log in to their account on the platform. Then, they can navigate to the "Settings" section of their workspace.

Locate API Key Section

Within the workspace settings, the user should look for a section specifically labeled "API Key" or "API Access."

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

With the API key copied, the user can now use it to authenticate their requests when accessing the platform API endpoints. They typically need to include the API key as part of the request headers or parameters, depending on the API authentication mechanism.

Secure the API Key

Its essential to remind users to keep their API keys secure and not share them publicly. They should avoid hardcoding API keys in client-side code or sharing them in publicly accessible repositories. Instead, they should consider storing the API key securely on their server-side applications and using appropriate access controls.

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://codeturk.com/api/account/details

Parameters

  • api_key: Your API key (Required)

Responses

Success Response:

{
    "status": "success",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "[email protected]",
        "balance": 100.00,
        "currency": "TL",
        "profile": {
            "heading": "Profile Heading",
            "description": "Profile Description",
            "contact": {
                "email": "[email protected]"
            },
            "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": "Invalid request"
}

Get All Items

Retrieves all items associated with the provided API key

Endpoint

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

Parameters

  • api_key: Your API key (Required)

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 sadece video öğeleri için dahildir
                "preview_audio": "https://example.com/audio.mp3", // Bu sadece ses öğeleri için dahildir
                "screenshots": [ // Bu yalnızca öğenin ekran görüntüleri varsa dahildir
                    "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ı"
}

Ürün Detaylarını 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://codeturk.com/api/items/item

Parameters

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

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 sadece video öğeleri için dahildir
            "preview_audio": "https://example.com/audio.mp3", // Bu sadece ses öğeleri için dahildir
            "screenshots": [ // Bu yalnızca öğenin ekran görüntüleri varsa dahildir
                "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

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://codeturk.com/api/purchases/validation

Parameters

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

Responses

Success Response:

{
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Regular",
            "price": 19.99,
            "currency": "TL",
            "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 sadece video öğeleri için dahildir
                    "preview_audio": "https://example.com/audio.mp3", // Bu sadece ses öğeleri için dahildir
                    "screenshots": [ Bu yalnızca öğenin ekran görüntüleri varsa dahildir
                        "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"
            },
            "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"
}