yougile-api

Yougile API models


License
MIT
Install
pip install yougile-api==1.0.1

Documentation

Yougile API для Python

Π˜Π½Ρ„ΠΎΡ€ΠΌΠ°Ρ†ΠΈΡ ΠΎ Π±ΠΈΠ±Π»ΠΈΠΎΡ‚Π΅ΠΊΠ΅

Π‘ΠΈΠ±Π»ΠΈΠΎΡ‚Π΅ΠΊΠ° являСтся Ρ€Π°Π·Ρ€Π°Π±ΠΎΡ‚ΠΊΠΎΠΉ стороннСго Ρ€Π°Π·Ρ€Π°Π±ΠΎΡ‚Ρ‡ΠΈΠΊΠ° для удобства обращСния ΠΊ Yougile API.

Установка

Если Π²Ρ‹ устанавливаСтС Π²Ρ€ΡƒΡ‡Π½ΡƒΡŽ, ΠΏΠ΅Ρ€Π΅Π΄ использованиСм Π±ΠΈΠ±Π»ΠΈΠΎΡ‚Π΅ΠΊΠΈ, Π½Π΅ΠΎΠ±Ρ…ΠΎΠ΄ΠΈΠΌΠΎ ΡƒΡΡ‚Π°Π½ΠΎΠ²ΠΈΡ‚ΡŒ ΡΠ»Π΅Π΄ΡƒΡŽΡ‰Π΅Π΅:

> pip install pydantic
> pip install requests

Если Π²Ρ‹ устанавливаСтС ΠΈΠ· PyPI, Ρ‚ΠΎ эти Π±ΠΈΠ±Π»ΠΈΠΎΡ‚Π΅ΠΊΠΈ ΡƒΡΡ‚Π°Π½Π°Π²Π»ΠΈΠ²Π°ΡŽΡ‚ΡΡ автоматичСски:

> pip install yougile-api

Wiki

Π£ ΠΌΠΎΠ΄Π΅Π»Π΅ΠΉ Π΅ΡΡ‚ΡŒ ΠΏΡ€Π°Π²ΠΈΠ»Π°:

  1. НазваниС ΠΌΠΎΠ΄Π΅Π»Π΅ΠΉ ΠΏΠΎΠ»Π½ΠΎΡΡ‚ΡŒΡŽ ΠΊΠΎΠΏΠΈΡ€ΡƒΡŽΡ‚ URL этой ΠΌΠΎΠ΄Π΅Π»ΠΈ Π½Π° ΠΎΡ„ΠΈΡ†ΠΈΠ°Π»ΡŒΠ½ΠΎΠΌ API.
  2. Π£ всСх ΠΌΠΎΠ΄Π΅Π»Π΅ΠΉ Π΅ΡΡ‚ΡŒ описания ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ΠΎΠ², ΠΊΡ€Π°Ρ‚ΠΊΠΎΠ³ΠΎ описания ΠΈΠ· ΠΎΡ„ΠΈΡ†ΠΈΠ°Π»ΡŒΠ½ΠΎΠ³ΠΎ API ΠΈ ссылка Π½Π° запрос.
  3. Названия ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ΠΎΠ² ΠΌΠΎΠ΄Π΅Π»ΠΈ ΠΈ ΠΈΡ… типизация ΠΈΠ΄Π΅Π½Ρ‚ΠΈΡ‡Π½Ρ‹ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Π°ΠΌ ΠΈΠ· ΠΎΡ„ΠΈΡ†ΠΈΠ°Π»ΡŒΠ½ΠΎΠ³ΠΎ 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'])