pusher-platform-node

pusher-platform-node

Pusher Platform SDK for Node.js.

Installation

Add pusher-platform-node to your package.json file:

{
  "dependencies": {
    "pusher-platform-node": "^0.8.1"
  }
}

Usage

In order to access Pusher Platform, first instantiate an Instance object. It takes the following arguments:

var pusher = require("pusher-platform-node");

var pusherPlatform = new pusher.Instance({
  instanceId: "",
  serviceName: "",
  serviceVersion: "",
  key: "",
});

instanceId is the ID that is unique to app developers' instance - they get that from the dashboard. The service SDKs will need to relay that down. Same for the key. serviceName and serviceVersion should come from the service SDK itself. They can be hardcoded there. Think feeds and v1.

It is also possible to specify host and port. This will override the cluster value that is encoded in the instance and allow you to connect to a development or testing server.

Authetication

Instance objects provide an authenticate method, which can be used in controllers to build authentication endpoints. Authentication endpoints issue access tokens used by Pusher Platform clients to access the API.

Make sure you authenticate the user before issuing access tokens.

• authenticatePayload param is essentially object of type AuthenticatePayload. The object must have the following format: (Please note that if you using one of our client libraries they will handle this format for you)

type AuthenticatePayload {
  grant_type?: string;
  refresh_token?: string;
};

let authenticatePayload = {
  grant_type: 'client_credentials'
};

let authOptions = {
  userId: 'zan',
  serviceClaims: {
    claim1: 'sdsdsd'
    ...
  }
};

let authResponse = app.authenticate(authenticatePayload, authOptions);

Where the authResponse is an object containing your access and refresh tokens:

let = authResponse: {
  access_token: {
    token: 'adsasd',
    expires_id: 1000
  },
  token_type: 'bearer';
  expires_in: 20000;
  refresh_token: 'cvbccvbb'
}

Request API

Instance objects provide a low-level request API, which can be used to contact Pusher Platform.

pusherApp.request({
  method: "POST",
  path: "feeds/playground",
  headers: {
    "Content-Type": "application/json",
  },
  body: { items: ["test"] },
}).then(function(response) {
  console.log(response.statusCode);
  console.log(response.headers);
  return pusher.readJSON(response);
}).then(function(body) {
  console.log(body);
}).catch(function(e) {
  if (e instanceof pusher.ErrorResponse) {
    console.log(e.statusCode);
    console.log(e.headers);
    console.log(e.description);
  } else {
    console.log(e);
  }
});

Issues, Bugs, and Feature Requests

Feel free to create an issue on Github if you find anything wrong. Please use the existing template. If you wish to contribute, please make a pull request. To summon help you can also ping @pusher/sigsdk or @zmarkan.

License

pusher-platform-node is released under the MIT license. See LICENSE for details.