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

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

Эндпоинт: GET https://imhoshop.ru/api/account/details

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

Получение всех элементов

Эндпоинт: GET https://imhoshop.ru/api/items/all

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

Получение данных элемента

Эндпоинт: GET https://imhoshop.ru/api/items/item

Описание: Возвращает данные конкретного элемента на основе предоставленного ID элемента и API-ключа.

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

Эндпоинт: POST https://imhoshop.ru/api/purchases/validation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Эндпоинт


            GET
https://imhoshop.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": "USD",
        "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://imhoshop.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": "USD",
            "published_at": "2024-04-27T12:00:00Z"
        },
        {
            // Next item...
        }
    ]
}

Ответ с ошибкой:


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

Получение данных элемента

Возвращает данные конкретного элемента на основе предоставленного ID элемента и API-ключа.

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

Эндпоинт


            GET
https://imhoshop.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": "USD",
        "published_at": "2024-04-27T12:00:00Z"
    }
}

Ответ с ошибкой:


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

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

Валидирует код покупки и возвращает данные о покупке, если он верен.

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

Эндпоинт


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

Параметры

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

Ответы

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


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

Ответ с ошибкой:


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