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

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

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

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

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

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

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

3. Получить информацию о товаре

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

Описание: Извлекает сведения о конкретном товаре на основе предоставленного ID товара и ключа API.

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

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

Описание: Проверяет код покупки и возвращает сведения о покупке, если он действителен.

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

Перейдите в настройки рабочего пространства

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

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

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

Сгенерировать или получить ключ API

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

Скопировать ключ API

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

Использовать ключ API

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

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

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

Получить информацию об аккаунте

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

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


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

Параметры

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

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

Error Response:


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

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

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

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

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


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

Параметры

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

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", // Это не включено в аудиофайлы
                "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...
        }
    ]
}

Error Response:


            {
    "status": "error",
    "msg": "Пока нет товаров"
}

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

Извлекает сведения о конкретном товаре на основе предоставленного ID товара и ключа API.

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

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


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

Параметры

api_key: Ваш ключ API (Обязательно)
item_id: The ID of the item to retrieve (Обязательно)

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", // Это не включено в аудиофайлы
            "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"
    }
}

Error Response:


            {
    "status": "error",
    "msg": "Item Not Found"
}

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

Проверяет код покупки и возвращает сведения о покупке, если он действителен.

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

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


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

Параметры

api_key: Ваш ключ API (Обязательно).
purchase_code: The purchase code to validate (Обязательно).

Responses

Success Response:


            {
    "status": "success",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Обычная",
            "price": 19.99,
            "currency": "RUB",
            "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", // Этого не будет, если поддержка отключена или не поддерживается
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

Error Response:


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