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

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

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

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

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

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

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

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

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

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

4. Валидация покупки

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

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

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

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

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

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

В настройках рабочего пространства пользователь должен найти раздел с пометкой "API Key" или "API Access".

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

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

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

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

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

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

Обезопасьте ключ API

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

Получить детали аккаунта

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

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


            GET
https://www.evno.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": "Руб",
        "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://www.evno.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": "Руб",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

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


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

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

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

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

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


            GET
https://www.evno.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": "Руб",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

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


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

Валидация покупки

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

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

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


            POST
https://www.evno.ru/api/purchases/validation

Параметры

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

Ответы

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


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

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


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