You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.2 KiB
2.2 KiB
Donation-Alerts-API-Python
This module for python. With help this module, you can interact with API Donation Alerts
pip install donationalerts_api -U
Official documentation Donation alerts API
Donation alerts application clients
| Class | Description |
|---|---|
| DonationAlertsApi(client_id, client_secret, redirect_uri, scope) | Request to API Donation Alerts |
| Scopes | Has attributes for the instruction of scopes (user_show, donation_index, donation_subscribe, custom_alert_store, goal_subscribe, poll_subscribe, all_scopes) |
| Method | Description |
|---|---|
| login() | Returns link for connect to API |
| get_code() | Returns code access application |
| get_access_token(code) | Receive access token for the application (necessarily: transfer argument code which you got by get_code) |
| get_donations(access_token) | Receive information about donate (messages) |
| get_user(access_token) | Receive information about user |
| send_custom_alert(access_token, external_id, headline, messages, image_url=None, sound_url=None, is_shown=0) | Send custom alert |
Example:
from flask import Flask, redirect
from donationalerts_api import DonationAlertsApi, Scopes
client = Flask(__name__)
api = DonationAlertsApi("9999", "a43f67k9920h01a2wdw", "http://127.0.0.1:5000/login", Scopes.all_scopes)
@client.route("/", methods=["get"])
def index():
redirect(api.login())
@client.route("/login", methods=["get"])
def login():
code = api.get_code()
access_token = api.get_access_token(code)
user = api.get_user(access_token)
donations = api.get_donations(access_token)
api.send_custom_alert(access_token, 12, "Test headline", "Test something message...")
return user
if __name__ == "__main__":
client.run(debug=True)
Now you can pass list of scopes:
from donationalerts_api import DonationAlertsApi, Scopes # New class: Scopes
scopes = ["oauth-user-show", "oauth-donation-index", "oauth-poll-subcribe"] # Also right variant
api = DonationAlertsApi("client id", "client secret", "redirect uri", [Scopes.user_show, Scopes.donation_index]) # Or you can pass all scopes: Scopes.all_scopes