Taler APNs Relay RESTful API

17.15. Taler APNs Relay RESTful API#

17.15.1. Version History#

The current protocol version is v0.

  • Nothing depends on the apns relay API at this point.

Version history:

  • v0: Initial version.

Upcoming versions:

  • None anticipated.

Ideas for future version:

  • vXXX: marker for features not yet targeted for release

17.15.2. Introduction#

APNs Relay API.

17.15.3. Config#

GET /config#

Return the protocol version and configuration information about the bank. This specification corresponds to current protocol being version v0.

Response:

200 OK:

Response is a ApnsRelayConfig.

Details:

interface ApnsRelayConfig {
  // Name of the API.
  name: "taler-apns-relay";

  // libtool-style representation of the Bank protocol version, see
  // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
  // The format is "current:revision:age".
  version: string;

  // URN of the implementation (needed to interpret 'revision' in version).
  implementation: string;
}

17.15.4. Device Registration#

POST /devices#

Register an iOS device for recurrent wakeup.

Request:

interface DeviceRegistrationRequest {
  // Device token
  token: string;
}

Response:

204 No Content:

The device have been registered.

DELETE /devices#

Register an iOS device.

Request:

interface DeviceUnregistrationRequest {
  // Device token
  token: string;
}

Response:

204 No Content:

The device have been registered.