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

1. Получите данные аккаунта

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


            GET
https://digit.market/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://digit.market/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://digit.market/api/items/item

Параметры

api_key: Ваш API-ключ (Обязательный)
item_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://digit.market/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": "Неверный код покупки"
}