Push Relay API

Many services for delivering push messages to mobile devices are not designed for decentralized networks. They require the mobile application to be bound to an account on the service and a single server to send messages to this account. To work around this limitation, the Moera network uses dedicated Push Relay servers that accept push messages from nodes and route them to their clients. Each node should provide a token it got from the client that confirms that the node has the right to send notifications to the client. Nodes authenticate on the relay using short-living tokens signed with the node's signing key.

Moera Push Relay API is based on JSON-RPC protocol. Until the API is stabilized, it may be changed in various ways and backward compatibility is not guaranteed.

timestamp below is the number of seconds that passed since 01-01-1970 00:00:00 in UTC timezone.

Calls

register(clientId, nodeName, lang, signedAt, signature)

Register a client to receive messages from the specified node. The client will be unregistered automatically if the relay gets an error from the push service indicating that the client cannot receive messages anymore.

Parameters:

String clientId – ID/token of the target client to receive messages

String nodeName – name of the node that will send messages

String lang – language of the messages (use standard language codes, like "en_US" or "uk")

timestamp signedAt – timestamp of the signature, the signature will be valid 2 minutes after the time specified

byte[] signature – the signature (use PushRelayRegister fingerprint)

feedStatus(feedName, notViewed, notViewedMoment, nodeName, signedAt, signature)

Send a message to node's clients about number of new stories in a feed.

Parameters:

String feedName – name of the feed

int notViewed – number of stories that have not been viewed yet

int notViewedMoment – moment of the oldest non-viewed story

String nodeName – name of the node that is sending the message

timestamp signedAt – timestamp of the signature, the signature will be valid 2 minutes after the time specified

byte[] signature – the signature (use PushRelayMessage fingerprint)

storyAdded(story, nodeName, signedAt, signature)

Send a message to node's clients about a new story.

Parameters:

StoryInfo story – the story

String nodeName – name of the node that is sending the message

timestamp signedAt – timestamp of the signature, the signature will be valid 2 minutes after the time specified

byte[] signature – the signature (use PushRelayMessage fingerprint)

storyDeleted(storyId, nodeName, signedAt, signature)

Send a message to node's clients about deleting a story.

Parameters:

String storyId – ID of the story

String nodeName – name of the node that is sending the message

timestamp signedAt – timestamp of the signature, the signature will be valid 2 minutes after the time specified

byte[] signature – the signature (use PushRelayMessage fingerprint)

Fingerprints

PushRelayRegister, version 0

PushRelayMessage, version 0

Error codes