Python API Client

GitHub: https://github.com/OneSignal/onesignal-python-api
Package version: 1.0.1
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

pip install onesignal-python-api

You can also install directly from GitHub using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

You may need to run pip with root permission:

sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Setuptools

Install via Setuptools.

python setup.py install --user

To install the package for all users:

sudo python setup.py install

Getting Started

Please follow the installation procedure and then run the following:

import onesignal
from onesignal.api import default_api

# See configuration.py for a list of all supported configuration parameters.
# Some of the OneSignal endpoints require USER_KEY bearer token for authorization as long as others require APP_KEY
# (also knows as REST_API_KEY). We recommend adding both of them in the configuration page so that you will not need
# to figure it yourself.
configuration = onesignal.Configuration(
    app_key = "YOUR_APP_KEY",
    user_key = "YOUR_USER_KEY"
)


# Enter a context with an instance of the API client
with onesignal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = default_api.DefaultApi(api_client)

Authorization

All the OneSignal endpoints require either an app_key or user_key tokens for authorization. It is recommended to set up both of those keys during the initial config initialization so that you don't need to worry about which endpoint requires app_key and which user_key. You can get the value of these keys from your app dashboard and user settings pages.

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:8080/api/v1

Class	Method	HTTP request	Description
DefaultApi	cancel_notification	DELETE /notifications/{notification_id}	Stop a scheduled or currently outgoing notification
DefaultApi	create_app	POST /apps	Create an app
DefaultApi	create_notification	POST /notifications	Create notification
DefaultApi	create_player	POST /players	Add a device
DefaultApi	create_segments	POST /apps/{app_id}/segments	Create Segments
DefaultApi	delete_player	DELETE /players/{player_id}	Delete a user record
DefaultApi	delete_segments	DELETE /apps/{app_id}/segments/{segment_id}	Delete Segments
DefaultApi	export_players	POST /players/csv_export?app_id={app_id}	CSV export
DefaultApi	get_app	GET /apps/{app_id}	View an app
DefaultApi	get_apps	GET /apps	View apps
DefaultApi	get_notification	GET /notifications/{notification_id}	View notification
DefaultApi	get_notification_history	POST /notifications/{notification_id}/history	Notification History
DefaultApi	get_notifications	GET /notifications	View notifications
DefaultApi	get_outcomes	GET /apps/{app_id}/outcomes	View Outcomes
DefaultApi	get_player	GET /players/{player_id}	View device
DefaultApi	get_players	GET /players	View devices
DefaultApi	update_app	PUT /apps/{app_id}	Update an app
DefaultApi	update_player	PUT /players/{player_id}	Edit device
DefaultApi	update_player_tags	PUT /apps/{app_id}/users/{external_user_id}	Edit tags with external user id

Documentation For Models

Author

[email protected]