Download the PHP package dreamonkey/laravel-onesignal-rest-api without Composer

On this page you can find all versions of the php package dreamonkey/laravel-onesignal-rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-onesignal-rest-api

OneSignal REST API Wrapper For Laravel/Lumen

Introduction

This project is a Laravel 6+ / Lumen wrapper for the OneSignal REST API v1. It supports all operations currently supported by the API.

Installation (Laravel and Lumen)

Require the package with composer.

Laravel Users:

Service provider will be auto-discovered.

Lumen Users:

Update bootstrap/app.php, adding the following entry

Configuration

There are three values that need to be set in order to use the library: your default OneSignal app ID, the REST API key and your account User Auth Key. All of these items can be found in your Control Panel on the OneSignal site. First two are app-related and can be found inside your app settings in the "Keys & IDs" tab (upper left corner), the third is account-related and can be found pressing your account avatar (lower right corner) and selecting "Account & API Keys".

Place the 3 keys into your .env file, as such:

Usage

There is a function for each of the OneSignal API calls. They are broken down here. All methods will return an array formatted like this:

Note: In all instances where an \$app_id is asked for, omitting it will grab the default OneSignal App ID specified in the .env file

Apps

getApps() - Get all Apps for the user
getApp( \$app_id ) - Get the given App
postapp( \$data ) - Create a new App
putApp( $app_id, $data ) - Update an App

Players

getPlayers( $app_id, $limit, \$offset ) - Get Players from an App
getPlayer( \$id ) - Get Player of the given ID
postPlayer ( $data, $app_id ) - Add Player to an App
putPlayer( $data, $app_id ) - Update Player object for an App
postCSVExport( \$app_id ) - Get a CSV dump of all Players for an App
postPlayerOnSession( \$data ) - Start a new device session for this Player
postPlayerOnPurchase( \$data ) - Track a new purchase for this Player
postPlayerOnFocus( \$data ) - Increment the Players total session length

Notifications

getNotifications( $app_id, $limit, \$offset ) - Get all Notifications for an App
getNotification( $id, $app_id ) - Get a Notification from an App
postNotification( $data, $app_id ) - Add a Notification to an App
putNotificationTrackOpen( $id, $app_id, \$opened ) - Track whether a Notification was opened
deleteNotification( $id, $app_id ) - Delete a Notification from an App

References

The official OneSignal API documentation is listed here: https://documentation.onesignal.com/docs/server-api-overview

Acknowledgements

This project has been forked and evolved by Dreamonkey from https://github.com/jmrieger/onesignal-laravel


All versions of laravel-onesignal-rest-api with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
guzzlehttp/guzzle Version ^6.2|^7.0.1
illuminate/support Version ^6.0|^7.0|^8.0|^9.0|^10.0
symfony/psr-http-message-bridge Version ^1.0|^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dreamonkey/laravel-onesignal-rest-api contains the following files

Loading the files please wait ....