Browse Source

Update README.md

main
Fsoky Community 4 years ago
committed by GitHub
parent
commit
6f09b5ece1
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 36
      README.md

36
README.md

@ -1,3 +1,39 @@
# Donation Alerts API Python
__Модуль для Python, который позволит легко работать с Donation Alerts API__ \
[Создать свое приложение Donation Alerts](https://www.donationalerts.com/application/clients) \
[Официальная документация Donation Alerts API](https://www.donationalerts.com/apidoc)
![DA API](https://github.com/Fsoky/Donation-Alerts-API-Python/blob/main/images/logo-api.jpg)
## 🔥 Простой пример работы
В этом примере мы логинимся в нашем приложении с определенными правами, получаем _access_token_, после в пременной `user` мы получаем JSON-объект, в котором содержится информация, в переменной `donation_list` тоже хранится информация, только уже другая. И теперь возвращаем нашу переменную `user`
`DonationAlertsApi` - основной класс для работы с DA API, на вход принимает _client_id_, _client_secret_, _redirect_url_, _scopes_ \
`Scopes` - позволит вам передать ряд прав в удобном формате, все права можете посмотреть в [оф. документации](https://www.donationalerts.com/apidoc#authorization__scopes), также имеет атрибут _ALL_SCOPES_ для передачи всех прав сразу (Scopes.ALL_SCOPES)
```python
from flask import Flask, redirect
from donationalerts_api import DonationAlertsApi, Scopes
app = Flask(__name__)
api = DonationAlertsApi("client id", "client secret", "http://127.0.0.1:5000/login", [Scopes.USER_SHOW, Scopes.DONATION_INDEX])
@app.route("/", methods=["get"])
def index():
return redirect(api.login()) # Log in your application
@app.route("/login", methods=["get"])
def login():
code = api.get_code()
access_token = api.get_access_token(code)
user = api.get_user(access_token)
donation_list = api.get_donations(access_token)
return user
if __name__ == "__main__":
app.run(debug=True)
```

Loading…
Cancel
Save