Обзор документации API

1. Получите данные учетной записи

Конечная точка: GET https://codecart.ru/api/account/details

Описание: Получает сведения об учетной записи, связанной с предоставленным ключом API.

2. Получите все предметы

Конечная точка: GET https://codecart.ru/api/items/all

Описание: Получает все элементы, связанные с предоставленным ключом API.

3. Получите подробную информацию об элементе

Конечная точка: GET https://codecart.ru/api/items/item

Описание: Получает сведения о конкретном элементе на основе предоставленного идентификатора элемента и ключа API.

4. Проверка покупки

Конечная точка: POST https://codecart.ru/api/purchases/validation

Описание: Подтвердить код покупки и вернуть подробную информацию о покупке, если она действительна.

Аутентификация

Перейдите к настройкам рабочей области.

Пользователь должен сначала войти в свою учетную запись на платформе. Затем они могут перейти в раздел «Настройки» своего рабочего пространства.

Найдите раздел ключей API

В настройках рабочей области пользователь должен найти раздел с надписью "Ключ API" или "Доступ к API".

Создать или получить ключ API

В этом разделе пользователь может либо сгенерировать новый ключ API, либо получить существующий, если он был сгенерирован ранее. Если есть возможность сгенерировать новый ключ, пользователь может нажать на нее, чтобы создать новый ключ API.

Скопируйте ключ API

Как только ключ API будет сгенерирован или получен, пользователь сможет увидеть его на экране. Они могут просто нажать кнопку или значок рядом с ключом, чтобы скопировать его в буфер обмена.

Используйте ключ API

Скопировав ключ API, пользователь теперь может использовать его для аутентификации своих запросов при доступе к конечным точкам API платформы. Обычно им необходимо включать ключ API как часть заголовков или параметров запроса, в зависимости от механизма аутентификации API.

Защитите ключ API

Очень важно напомнить пользователям о необходимости хранить свои ключи API в безопасности и не разглашать их публично. Им следует избегать жесткого кодирования ключей API в клиентском коде или их совместного использования в общедоступных репозиториях. Вместо этого им следует рассмотреть возможность безопасного хранения ключа API в своих серверных приложениях и использования соответствующих средств управления доступом.

Данные аккаунта

Получает сведения об учетной записи, связанной с предоставленным ключом API.

Конечная точка


            GET
https://codecart.ru/api/account/details

Параметры

api_key: Ваш API-ключ (Обязательное)

Ответы

Успешный ответ:


            {
    "status": "успех",
    "data": {
        "name": {
            "firstname": "John",
            "lastname": "Doe",
            "full_name": "John Doe"
        },
        "username": "johndoe",
        "email": "john.doe@example.com",
        "balance": 100.00,
        "currency": "RUB",
        "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"
    }
}

Ошибка ответа:


            {
    "status": "ошибка",
    "msg": "Неверный запрос"
}

Получить все товары

Получает все элементы, связанные с предоставленным ключом API.

Это работает только для авторов и не работает для обычных пользователей.

Конечная точка


            GET
https://codecart.ru/api/items/all

Параметры

api_key: Ваш API-ключ (Обязательное)

Ответы

Успешный ответ:


            {
    "status": "успех",
    "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", // Это не включено в аудиофайлы.
                "preview_video": "https://example.com/video.mp4", // Это включено только для видеоэлементов.
                "preview_audio": "https://example.com/audio.mp3", // Это включено только для аудиоэлементов.
                "screenshots": [ // Это включено только в том случае, если элемент имеет скриншоты.
                    "https://example.com/screenshot1.jpg",
                    "https://example.com/screenshot2.jpg"
                ],
            },
            "price": {
                "regular": 19.99,
                "extended": 29.99
            },
            "currency": "RUB",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Ошибка ответа:


            {
    "status": "ошибка",
    "msg": "Элементы не найдены"
}

Информация о товаре

Получает сведения о конкретном элементе на основе предоставленного идентификатора элемента и ключа API.

Это работает только для авторов и не работает для обычных пользователей.

Конечная точка


            GET
https://codecart.ru/api/items/item

Параметры

api_key: Ваш API-ключ (Обязательное)
item_id: ID элемента, который нужно получить (Обязательное)

Ответы

Успешный ответ:


            {
    "status": "успех",
    "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", // Это не включено в аудиофайлы.
            "preview_video": "https://example.com/video.mp4", // Это включено только для видеоэлементов.
            "preview_audio": "https://example.com/audio.mp3", // Это включено только для аудиоэлементов.
            "screenshots": [ // Это включено только в том случае, если элемент имеет скриншоты.
                "https://example.com/screenshot1.jpg",
                "https://example.com/screenshot2.jpg"
            ],
        },
        "price": {
            "regular": 19.99,
            "extended": 29.99
        },
        "currency": "RUB",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Ошибка ответа:


            {
    "status": "ошибка",
    "msg": "Товар не найден"
}

Проверка покупки

Подтвердить код покупки и вернуть подробную информацию о покупке, если она действительна.

Это работает только для авторов и не работает для обычных пользователей.

Конечная точка


            POST
https://codecart.ru/api/purchases/validation

Параметры

api_key: Ваш API-ключ (Обязательное).
purchase_code: Код покупки для подтверждения (Обязательное).

Ответы

Успешный ответ:


            {
    "status": "успех",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Обычный",
            "price": 19.99,
            "currency": "RUB",
            "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", // Это не включено в аудиофайлы.
                    "preview_video": "https://example.com/video.mp4", // Это включено только для видеоэлементов.
                    "preview_audio": "https://example.com/audio.mp3", // Это включено только для аудиоэлементов.
                    "screenshots": [ Это включено только в том случае, если элемент имеет скриншоты.
                        "https://example.com/screenshot1.jpg",
                        "https://example.com/screenshot2.jpg"
                    ],
                },
                "price": {
                    "regular": 19.99,
                    "extended": 29.99
                },
                "currency": "RUB",
                "published_at": "2024-04-27T12:00:00Z"
            },
            "supported_until": "2024-04-27T12:00:00Z", // Этого не будет, если поддержка отключена или не поддерживается.
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Ошибка ответа:


            {
    "status": "ошибка",
    "msg": "Неверный код покупки"
}