Skip to main content

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

Project description

Лого

📚 Документация для библиотеки apimodkey

Библиотека apimodkey предоставляет удобные методы для взаимодействия с API Modkey.space. С её помощью вы можете создавать ключи, изменять их статус и управлять ими, передавая API-ключ прямо в коде вашего проекта.


⚙️ Метод: create_key

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

Описание:

  • Метод создает ключ с указанным сроком действия, количеством устройств и типом ключа.
  • Возвращает строку с результатом или ошибкой.

Параметры:

  • api_key (str): Ваш API-ключ.
  • days (int): Количество дней действия ключа.
  • devices (int): Количество устройств, на которые можно активировать ключ.
  • key_type (str): Тип ключа (например, 'APK' или 'INJECTOR').

Возвращаемое значение:

  • Строка с результатом создания ключа или ошибкой.

Пример использования:

from apimodkey import create_key

# Указываем API-ключ
api_key = "YOUR_API_KEY"

# Создаем ключ на 30 дней для 3 устройств с типом 'APK'
result = create_key(api_key, 30, 3, 'APK')

# Выводим результат
print(result)

Пример вывода:

Ключ успешно создан!
Ваш ключ: abc123xyz

🔧 Метод: edit_key_status

Этот метод позволяет изменить статус уже существующего ключа.

Описание:

  • Метод изменяет статус ключа на новый.
  • Выводит старый и новый статус ключа, если операция прошла успешно.

Параметры:

  • api_key (str): Ваш API-ключ.
  • key (str): Ключ, для которого нужно изменить статус.
  • new_status (str): Новый статус ключа ('block' или 'active').

Возвращаемое значение:

  • None, но выводит в консоль старый и новый статус ключа.

Пример использования:

from apimodkey import edit_key_status

# Указываем API-ключ
api_key = "YOUR_API_KEY"

# Изменяем статус ключа на 'inactive'
edit_key_status(api_key, 'your_key', 'inactive')

Пример вывода:

Статус ключа успешно изменен!
Старый статус: active
Новый статус: inactive

💡 Метод: edit_key_max_devices

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

Описание:

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

Параметры:

  • api_key (str): Ваш API-ключ.
  • key (str): Ключ, для которого нужно изменить количество устройств.
  • new_max_devices (int): Новое максимальное количество устройств.

Возвращаемое значение:

  • None, но выводит старое и новое количество устройств.

Пример использования:

from apimodkey import edit_key_max_devices

# Указываем API-ключ
api_key = "YOUR_API_KEY"

# Изменяем максимальное количество устройств на 5
edit_key_max_devices(api_key, 'your_key', 5)

Пример вывода:

Максимальное количество устройств успешно изменено!
Старое количество: 3
Новое количество: 5

🆕 Метод: edit_user_key

Этот метод позволяет изменить название или значение ключа для пользователя.

Описание:

  • Метод изменяет значение/название ключа для пользователя.
  • Возвращает новый ключ или ошибку.

Параметры:

  • api_key (str): Ваш API-ключ.
  • key (str): Ключ, который нужно изменить.
  • new_user_key (str): Новое название или значение ключа.

Возвращаемое значение:

  • Новый ключ или ошибка, если операция не удалась.

Пример использования:

from apimodkey import edit_user_key

# Указываем API-ключ
api_key = "YOUR_API_KEY"

# Изменяем название ключа на новое
result = edit_user_key(api_key, 'your_key', 'new_key_name')

# Выводим результат
print(result)

Пример вывода:

Название ключа успешно изменено на 'new_key_name'.

💡 Как использовать?

Чтобы использовать методы из этой библиотеки, вам нужно:

  1. Установить библиотеку через pip.
  2. В вашем коде передать API-ключ в качестве аргумента для каждого метода.

🚀 Установка библиотеки

Для установки библиотеки используйте команду:

pip install apimodkey

📝 Пример с полной документацией:

from apimodkey import create_key, edit_key_status, edit_key_max_devices, edit_user_key

# Указываем свой API-ключ
api_key = "YOUR_API_KEY"

#СОЗДАНИЕ КЛЮЧА 
created_key = create_key(api_key, days=30, devices=5, key_type='INJECTOR') #в кей тип либо APK или INJECTOR

#Редактирование ключа
if created_key:
	edit_key_status(api_key, 'KINDER-30D-osB3cOQVRf', new_status='active')  # или 'active'

#измение количество максимальных устройств
if created_key:
	edit_key_max_devices(api_key, 'KINDER-30D-osB3cOQVRf', new_max_devices=10)

#изменение ключа
if created_key:
	edit_user_key(api_key, 'KINDER-30D-osB3cOQVRf', new_user_key='Test')

🎉 Твой первый ключ уже создан!

Используя эти простые методы, вы можете легко создавать и управлять ключами в Modkey.space. Наслаждайтесь работой с API! 🎉


📜 Рекомендации по безопасности:

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

Work

Владельцем проекта(modkey.space) является CATPoN Разработчик проекта modkey.space Wardex Над библиотекой и документацией работал @MAKCNMOB

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.0.tar.gz (4.8 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.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for apimodkey-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8a19a8adec13c5791cd4758967e9ac260a5029a6a8196ad9129629d27a9d92fc
MD5 9c6a9614eee1d30a2579d69e52e0be0f
BLAKE2b-256 2d64a6659e81d1e6dba166372a4a6ba0aecfe884c1490efd459d21981098a7a8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for apimodkey-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f97572bfa41a3a00f9d193f0abde7001f9dd3441b3da8f51ad2189671b091158
MD5 fe9e933ffcff35511d61c7fcf95c6deb
BLAKE2b-256 7c7a9444c542ac2344df5273d158229b420c32b96c75dae4e512c471eb74d6f9

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