goinstant/rest-client

Client for GoInstant's v1 REST API. This repo will no longer be updated. GoInstant will be discontinued as of August 31, 2014. Read our blog for more details.

REST API Client

A Node.JS module which provides an interface to all routes supported by the v1 GoInstant REST API

API Documentation

Documentation for the GoInstant REST API is available at https://developers.goinstant.com/v1/rest-api

Client Example

Simply pass your credentials to the constructor and the module handles the REST (Pun intended).

var GoInstant = require('goinstant-rest').v1;

var client = new GoInstant({
  client_id: 'YOUR CLIENT ID HERE',
  client_secret: 'YOUR CLIENT SECRET HERE'
});

Authentication

Your set of credentials, the client_id and client_secret, allow the client to generate access tokens for use with authenticated requests. Currently every route on the GoInstant REST API requires authentication.

Obtaining Credentials

Credentials can be generated through your GoInstant dashboard via https://goinstant.com/dashboard/credentials

---

Client

• Developers
  • all
  • get
  • create
  • update
  • remove
• Applications
  • all
  • get
  • create
  • update
  • remove
• Teams
  • all
  • get
  • create
  • update
  • remove
  • Developers
    • all
    • add
    • remove
• Rooms
  • all
  • get
  • create
  • users
• Keys
  • get
  • update
  • remove
• Channels
  • message
• Login Settings
  • get
  • update
  • set