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

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

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

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

2. Получить все предметы

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

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

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

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

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

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

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

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

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

Navigate to Workspace Settings

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

Locate API Key Section

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

Generate or Retrieve API Key

In this section, the user can either generate a new API key or retrieve an existing one if it has been previously generated. If there is an option to generate a new key, the user can click on it to create a fresh API key.

Copy the API Key

Once the API key is generated or retrieved, the user should be able to see it displayed on the screen. They can simply click on a button or icon next to the key to copy it to their clipboard.

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 в своих серверных приложениях и использования соответствующих элементов управления доступом.

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

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

Endpoint

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

Параметры

  • api_key: Your API key (Required)

Ответы

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

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

Endpoint

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

Параметры

  • api_key: Your API key (Required)

Ответы

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

{
    "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", // This is not included for audio items
                "preview_video": "https://example.com/video.mp4", // This is only included for video items
                "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
                "screenshots": [ // This is only included if item has 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.

Endpoint

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

Параметры

  • api_key: Your API key (Required)
  • item_id: Идентификатор элемента для извлечения (Required)

Ответы

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

{
    "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", // This is not included for audio items
            "preview_video": "https://example.com/video.mp4", // This is only included for video items
            "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
            "screenshots": [ // This is only included if item has 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": "Элемент не найден"
}

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

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

Endpoint

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

Параметры

  • api_key: Your API key (Required).
  • purchase_code: Код покупки для подтверждения (Required).

Ответы

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

{
    "status": "Успешно",
    "data": {
        "purchase": {
            "purchase_code": "abcdefghijklmnopqrstuvwxyz123456789",
            "license_type": "Regular",
            "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", // This is not included for audio items
                    "preview_video": "https://example.com/video.mp4", // This is only included for video items
                    "preview_audio": "https://example.com/audio.mp3", // This is only included for audio items
                    "screenshots": [ This is only included if item has 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", // This will not exist if support is disabled or its not supported
            "downloaded": false,
            "date": "2024-04-27T12:00:00Z"
        }
    }
}

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

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