Download the PHP package notific/notific-php-sdk without Composer

On this page you can find all versions of the php package notific/notific-php-sdk. 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?

Example code of notific/notific-php-sdk

Informations about the package notific-php-sdk

An SDK to easily work with the Notific API

This SDK lets you perform API calls to Notific. API documentation https://notific.io/api

Usage

To install the SDK in your project you need to require the package via composer:

$ composer require notific/notific-php-sdk

Create an instance of the SDK:

If you don't have an App ID yet, sign up at https://app.notific.io/signup

Public notifications

You can get an array of public notification instances with publicNotifications() method.

You can optionally give arguments to method which will be transformed to query parameters. Read more about filtering and sorting options from API documentation

Create new public notification.

Retrieve a public notification instance.

Update the notification.

Delete the notification.

Recipients

You can get an array of recipient instances with recipients() method.

You can optionally give arguments to method which will be transformed to query parameters. Read more about filtering and sorting options from API documentation

Create a recipient.

Retrieve a recipient instance.

Update the recipient.

Add tags to the recipient.

Remove tags from the recipient.

Remove all tags from the recipient.

Templates

Where private notifications are immutable and unnamed, templates are editable and easy to retrieve by name.

You can get an array of template instances with templates() method.

Create a template.

Retrieve a template with a name parameter.

Private notifications

You can get an array of private notification instances with privateNotifications() method.

You can optionally give arguments to method which will be transformed to query parameters. Read more about filtering and sorting options from API documentation

Create new private notification.

Retrieve a private notification instance.

Update the private notification.

Send private notifications

You can use a private notification or a template to send a private notifications to recipient(s). We recommend you to use templates because they are easier to refer and manage as they are editable.

Send private notification with the notification id and recipient(s) id:s. Recipients can be a string, a list or an an array of id:s.

You can use two delivery channels to send private notifications, broadcast (default) and email. Email channel requires valid email settings.

If you are tagging your recipients you can send notification using tags. Tags can be a string, a list or an array of id:s. Recipient must have all given tags.

To send a notification to ALL your recipients, use predefined tag all.

Alternative way to send private notification with private notification instance.

Send private notification with recipient instance.

Tip: you can test the private notification and send it to your self. You will receive the notification instantly if you are logged in to notific.io dashboard.

Pagination & limiting

Response data will be paginated to 15 items by default. Navigating through the pages and limiting the number of items per page can be done with query parameters. For example ?page=2&limit=25. Read more about paging and limiting from API documentation.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

This package uses code from and is greatly inspired by the Oh Dear SDK package which is inspired by the Forge SDK package by Mohammed Said.

License

The MIT License (MIT). Please see License File for more information.

All versions of notific-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version ^7.0
guzzlehttp/guzzle Version ^6.3
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 notific/notific-php-sdk contains the following files

Loading the files please wait ....