Guides

Live API

The Live API add-on allows you to receive all the signals your mobile and web apps generate and handle them in your own servers. This is a crucial tool for integrations between Notificare and your infrastructure or 3rd party software.

To access these pages, expand the Settings menu and click in Services like shown below:

Services menu 6b8daebef3

This is an add-on feature of Notificare. Before you can subscribe to this add-on you will need to be enrolled in a paid plan. If you already have a paid plan, you can subscribe to this add-on by clicking in the Subscribe button like shown below:

Live api service box subscribe 048d970516

One you've subscribed to this add-on, to configure your service, you should click the Configure button in the Live API box:

Live api service box b32c30f3b4

In order to setup this add-on you must already have prepared your server handle the Live API validation. You can find example projects for Java and Node.js. For Node.js we even have a full example server implementation that is ready to consume this API, you can find it here. This projects can be starting point to for your server implementation. There's basically two main things your server must do, verify the generated keys sent as headers with all signals the Live API sends and validate the payload (by decrypting it using those keys) in order to guarantee all the signals really come from a trusted source.

You can start by generating a public and private key (these must be included in your server implementation), to do that first name your Live API instance:

Live api service name 4710a6172b

And then provide the endpoint where it will run (must be an publicly available URL):

Live api service endpoint 12014ade89

Finally you should click in the Generate Keys button to make sure you store these changes:

Live api service generate keys button f1ed9a154e

After you generate the keys you will see your keys, copy and paste them in your server:

Live api service keys 24671be2d2

After adding the keys to your server, our platform will be waiting for you to verify them, you will be seeing a warning like this:

Live api service will verify 79d604e717

When you are ready to verify, go ahead and click the Verify button:

Live api service verify button d5732b1bf4

If your server is successfully verified, your instance will become active and you'll see a warning like this:

Live api service verified b7766bd723

After this point your service will be active and shown like the example below:

Live api service box active 33cf259b49

This will mean that you server is now ready to receive all the events your apps generate. To learn more about the payloads you will be receiving, please read our Live API documentation located here.