Yougile API models
Project description
Yougile API для Python
Информация о библиотеке
Библиотека является разработкой стороннего разработчика для удобства обращения к Yougile API.
Установка
Если вы устанавливаете вручную, перед использованием библиотеки, необходимо установить следующее:
> pip install pydantic
> pip install requests
Если вы устанавливаете из PyPI, то эти библиотеки устанавливаются автоматически:
> pip install yougile-api
Wiki
У моделей есть правила:
- Название моделей полностью копируют URL этой модели на официальном API.
- У всех моделей есть описания параметров, краткого описания из официального API и ссылка на запрос.
- Названия параметров модели и их типизация идентичны параметрам из официального API (За исключением параметра
token
)
Возможности
Вы можете использовать токен не только к отдельным моделям, но и к самой функции запроса:
import yougile
import yougile.models as models
def yougile_get(model:yougile.BaseModel) -> yougile.Response:
return yougile.query(model,token="TOKEN")
model = models.ChatMessageController_search(chatId="12324")
response = yougile_get(model)
for msg in response.json()['content']:
print(msg['text'])
Примеры
1. Получаем список доступных компаний
import yougile # Импортируем библиотеку
import yougile.models as models # Импортируем модели
model = models.AuthKeyController_companiesList(login="USERNAME",password="PASSWORD") # Указываем модель запроса листа компаний через авторизацию
response = yougile.query(model) # Делаем запрос на сервер
print(response.text) # Получаем ответ
2. Создаем токен
import yougile
import yougile.models as models
model = models.AuthKeyController_create(login="USERNAME",password="PASSWORD",companyId="12345")
response = yougile.query(model)
print(response.json()['key'])
3. Получаем историю сообщений
import yougile
import yougile.models as models
model = models.ChatMessageController_search(token="TOKEN",chatId="12324")
response = yougile.query(model)
for msg in response.json()['content']:
print(msg['text'])
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
yougile-api-1.0.0.tar.gz
(22.7 kB
view hashes)
Built Distribution
Close
Hashes for yougile_api-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 145e64fed82db91a1c6fe0e3e2be1652d66932ca30e69640ed7113a5b343af3a |
|
MD5 | f8ae9a9927067016832a485e5f681186 |
|
BLAKE2b-256 | 31cfc63c37119831b7314b87d04a94299bc90f6307ecc86983a6a7367f725ee6 |