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

1. Get Account Details

Endpoint: GET https://avety.ru/api/account/details

Описание: Retrieves details of the account associated with the provided API key.

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

Endpoint: GET https://avety.ru/api/items/all

Описание: Retrieves all items associated with the provided API key.

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

Endpoint: GET https://avety.ru/api/items/item

Описание: Retrieves details of a specific item based on the provided item ID and API key.

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

Endpoint: POST https://avety.ru/api/purchases/validation

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

Authentication

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

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

Найдите раздел API Key

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

Generate or Retrieve API Key

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

Copy the API Key

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

Use the API Key

With the API key copied, the user can now use it to authenticate their requests when accessing the platform API endpoints. They typically need to include the API key as part of the request headers or parameters, depending on the API authentication mechanism.

Secure the API Key

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

Get Account Details

Retrieves details of the account associated with the provided API key

Endpoint


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

Parameters

api_key: Ваш ключ API (Требуется)

Responses

Success Response:


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

Error Response:


            {
    "status": "Ошибка",
    "msg": "Invalid request"
}

Get All Items

Retrieves all items associated with the provided API key

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

Endpoint


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

Parameters

api_key: Ваш ключ API (Требуется)

Responses

Success Response:


            {
    "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...
        }
    ]
}

Error Response:


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

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

Retrieves details of a specific item based on the provided item ID and API key.

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

Endpoint


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

Parameters

api_key: Ваш ключ API (Требуется)
item_id: The ID of the item to retrieve (Требуется)

Responses

Success Response:


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

Error Response:


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

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

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

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

Endpoint


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

Parameters

api_key: Ваш ключ API (Требуется).
purchase_code: The purchase code to validate (Требуется).

Responses

Success Response:


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

Error Response:


            {
    "status": "Ошибка",
    "msg": "Недействительный код покупки"
}