A node.js symphony api implementation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.gitignore
CONTRIBUTING.md
LICENSE
NOTICE
README.md
index.js
package.json

README.md

symphony-api

A node.js symphony api implementation

Installation

To use the library, run this command in your project's root path.

npm -install symphony-api --save

Getting Started

Example

var symphonyApi = require('symphony-api');
var fs = require('fs');

var urls = {
	keyUrl: 'https://foundation-dev-api.symphony.com/keyauth',
	sessionUrl: 'https://foundation-dev-api.symphony.com/sessionauth',
	agentUrl: 'https://foundation-dev.symphony.com/agent',
	podUrl: 'https://foundation-dev.symphony.com/pod'
};


var cert = fs.readFileSync('./certs/bot-cert.pem', {encoding: 'utf-8'});
var key = fs.readFileSync('./certs/bot-key.pem', {encoding: 'utf-8'}),
var passphrase = 'this is my passphrase'

var api = symphonyApi.create(urls);
api.setCerts(cert, key, passphrase)
api.authenticate()
	.then()
	{
		api.stream.list()
			.then(function(streams)
			{
				if (streams.length > 0) api.message.send(streams[0].id, 'text', 'hello there');
			});
	});

Using the API

The api is encapsulated into a single object that is created using symphonyApi.create();. Once authenticated, additional functionality is made available through members of this main object. For instance, api.message.send(streamId, 'text', 'hello world') will send the text 'hello world' to the stream streamId.

Api

api.user (UserModel)

api.feed (FeedModel)

api.message (MessageModel)

api.stream (StreamModel)