Download the PHP package fernleafsystems/apiwrappers-pushover without Composer
On this page you can find all versions of the php package fernleafsystems/apiwrappers-pushover. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download fernleafsystems/apiwrappers-pushover
More information about fernleafsystems/apiwrappers-pushover
Files in fernleafsystems/apiwrappers-pushover
Package apiwrappers-pushover
Short Description PHP Wrapper For The Pushover Notifications API
License MIT
Informations about the package apiwrappers-pushover
ApiWrappers-Pushover
PHP Wrapper for Pushover Notifications API
Installation
To get started, add the package to your project by issuing the following command:
composer require fernleafsystems/apiwrappers-pushover
Current version 0.1.x is beta. Please include using strict Composer versions.
Getting Started
Only 2 main parts of the API are implemented so far:
- User/Group Verification
- Message sending (
Push
ing)
1) User / Group Verification
With all API requests, the first thing to do is create a new API Connection.
Verify a user or a group
2) User / Group Verification with changed Key
To perform actions against the API you send an Access Token - not the OAuth code you obtained in the previous stage. To get this, your app will send a request for a new token and it will look like this:
3) Send a message
Sending a message is very simple. Give the title and the message and adjust any other parameters of the Message according to the API.
4) Send to a specific device.
All the current API classes let you specify an optional device. If this is omitted it uses all devices.
In the case of Verify, if it's omitted it verifies the user has at least 1 active device.
Errors and Exceptions
When retrieving, creating and updating, there are some basic checks on the data to ensure
the absolute minimums are provided before a request is sent out. If these checks fail
an Exception
is thrown.
If these checks don't fail, and the request fails, you have a few options. This will likely change in the future as the current implementation is flawed and not satisfactory.
If you find bugs, suggestions for improvements etc., please do let us know.