Skip to main content

Библиотека для использования апи от Modkey.space

Project description

Лого

ModKey API Документация

Обзор

Класс ModKey предоставляет Python-интерфейс для работы с API ModKey. Эта документация охватывает все доступные методы с примерами использования и ожидаемыми результатами.

Инициализация

Для использования API необходимо создать экземпляр класса ModKey с вашим API-ключом.

from modkey import ModKey

api = ModKey(api_key="ваш_api_ключ_здесь")

Методы

1. create_key(days: int, devices: int, key_type: str)

Создает новый лицензионный ключ с указанными параметрами.

Параметры:

  • days - Срок действия ключа в днях
  • devices - Максимальное количество устройств для этого ключа
  • key_type - Тип ключа (например, "APK", "INJECTOR")

Пример:

response = api.create_key(days=30, devices=5, key_type="APK") #два типа APK или INJECTOR
print(response)

Возможный вывод:

{'status': True, 'data': {'message': 'The key has been successfully created!', 'key': 'CATPON-30D-Wm6CH5nuva'}, 'code': 200}

2. edit_key_max_devices(key: str, new_max_devices: int)

Изменяет максимальное количество устройств для существующего ключа.

Параметры:

  • key - Лицензионный ключ для изменения
  • new_max_devices - Новое максимальное количество устройств

Пример:

response = api.edit_key_max_devices(key="ABCDE-12345-FGHIJ-67890", new_max_devices=10)
print(response)

Возможный вывод:

{'status': True, 'data': {'message': 'The key max devices has been successfully editing!', 'key': 'SOFTNANE-30D-EM61QGcbD0', 'old_max_devices': '5', 'new_max_devices': '10', 'info': 'the free version'}, 'code': 200}

3. edit_user_key(key: str, new_key: str)

Изменяет значение лицензионного ключа на новое.

Параметры:

  • key - Текущий лицензионный ключ
  • new_key - Новое значение ключа

Пример:

response = api.edit_user_key(key="ABCDE-12345-FGHIJ-67890", new_key="NEWKEY-54321-67890")
print(response)

Возможный вывод:

{'status': True, 'data': {'message': 'The user key has been successfully editing!', 'key': 'KINDER-30D-EM61QGcbD0', 'old_user_key': 'SOFTNAME-30D-EM61QGcbD0', 'new_user_key': '1234'}, 'code': 200}

4. info_key(key: str)

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

Параметры:

  • key - Лицензионный ключ для запроса

Пример:

response = api.info_key(key="1234")
print(response)

Возможный вывод:

{'status': True, 'data': {'message': 'None', 'key': '1234', 'expired_date': None, 'max_devices': '10', 'devices': None, 'status': '1', 'active': '1', 'registrator': 'KINDER', 'registrator_id': '155', 'soft': '105', 'key_type': 'APK', 'alpha': None}, 'code': 200}

5. edit_key_status(key: str, new_status: str)

Изменяет статус лицензионного ключа.

Параметры:

  • key - Лицензионный ключ
  • new_status - Новый статус (например, "active", "block")

Пример:

response = api.edit_key_status(key="ABCDE-12345-FGHIJ-67890", new_status="block")
print(response)

Возможный вывод:

{'status': True, 'data': {'message': 'The key status has been successfully editing!', 'key': '1234', 'old_status': '1', 'new_status': '0', 'info': 'the free version'}, 'code': 200}

6. info_api()

Получает информацию о вашем API-аккаунте.

Пример:

response = api.info_api()
print(response)

Возможный вывод:

{'status': True, 'data': {'id': '155', 'username': 'KINDER', 'balance': '49976952', 'VIP': '0', 'status': '1', 'level': '4', 'telegram_id': '1742648077', 'soft': {'id': '105', 'name': 'KINDER', 'VIP': '1', 'status': '1', 'soft_status': '1', 'price': '{"1": "30", "3": "55", "7": "150", "14": "280", "20": "300", "30": "550", "60": "799", "25000": "999"}'}}, 'code': 200}

Обработка ошибок

При возникновении ошибок API возвращает JSON-объект с полем "status": false и описанием ошибки:

{
    "status": false,
    "error": "Описание ошибки"
}

Установка через PyPI

Чтобы установить пакет, выполните:

pip install apimodkey

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apimodkey-0.2.6.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apimodkey-0.2.6-py3-none-any.whl (38.6 kB view details)

Uploaded Python 3

File details

Details for the file apimodkey-0.2.6.tar.gz.

File metadata

  • Download URL: apimodkey-0.2.6.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for apimodkey-0.2.6.tar.gz
Algorithm Hash digest
SHA256 3421598033427702e0f5c0e4f25e8815c7b5b7abcfd4f31938cf13beb0ed12a1
MD5 8b19e6d0aa8297b941cd4633060064fa
BLAKE2b-256 45951beab168255c21680f50d0800590eed57dc10a280b1e5f45225a5e4804a3

See more details on using hashes here.

File details

Details for the file apimodkey-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: apimodkey-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 38.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for apimodkey-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3c1c57006aaa0127800a7cf9abc5a72365bf2317d79edb8d56d82bab5c5a2c78
MD5 8a6c6ebca56adce1d2bc8a2caead1c5d
BLAKE2b-256 827927d27360dd13510cb25ae0c3db943fc0af4ba8744188f263fc165fcb44d9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page