API DOCUMENTATION v1.0

PushNotifier APIs

Before going into detail of the PushNotifier API you should first read these guidelines. They will help you make great use of the APIs and build awesome applications using them.
They also include first steps you are going to take to get started. Don't forget to try the SDK after you've read the guidelines.


Guidelines

  • Authenticating users.
    Users will be authenticated using their PushNotifier credentials. Make sure to destroy the password the user entered after authenticating to make sure, they never get compromised. Never store any password without proper encryption or use it without permission.

  • Protect your API key.
    Your API key is the key to providing all the features of these APIs. You wouldn't be happy if we needed to take it back because it was used improperly.

  • Never every annoy your users.
    Annoyed users won't be using any of your products if they are annoyed by them. Only send things that are important or the user has declared to receive. If you spam your users though, they can block your application from their device.

  • Build trust.
    Trusted applications using our APIs will be rewarded with an entry in the hall of fame. You are able to get a star when your applications even looks good.

First steps

You need to take these steps first to get started using the PushNotifier API.

  1. Register your application.
    In order to be able to make requests to the API you need to register your application. You can do so in the API settings.

  2. Get to know these APIs.
    Learn how to use the APIs to make your application send messages.

  3. Set up your testing environment.
    Depending on what you want to do you will need to set up a testing environment. For that you'll need:
    • Your application
    • A device running the latest version of PushNotifier (it is recommended to test both Android and iOS)

Download the PushNotifier SDK

If you're lucky the official PushNotifier SDK is available for your language of choice. It makes communicating with the APIs much easier and more comfortable.
Head over to GitHub to download the SDK.