rl-node-sdk v0.3.2

rl-node-sdk ·

RUBINLAKE SDK for JavaScript in the browser and Node.js.

If you want to lern more about our API please read the docs: api.rubinlake.com.

Installation

RUBINLAKE SDK is available as the rl-node-sdk package on npm.

RUBINLAKE SDK is flexible and can be used in a variety of projects. The recommended way to install rl-node-sdk depends on your project. Here you can find short examples for the most common scenarios:

npm

npm install rl-node-sdk --save

yarn

yarn add rl-node-sdk

Usage

To write an app or service using the SDK

• Register at RUBINLAKE.com.
• Create a API Key at Profile > Settings > New API Key.
• Add dependency rl-node-sdk in your package.json file.
• Require rl-node-sdk in your file

NodeJS Example

// Import RUBINLAKE SDK
import rubinlake = require('rl-node-sdk');

// Configure SDK
const options = {
  key:  '<YOUR_API_KEY>',
};

// Set configuration
rubinlake.configure(options);

JavaScript Example

// Require RUBINLAKE SDK
var rubinlake = require('rl-node-sdk');

// Configure SDK
var options = {
  key:  '<YOUR_API_KEY>',
};

// Set configuration
rubinlake.configure(options);

Example Projects

See rl-examples for more usage examples.

License

This project is licensed under the Apache License v2.0 - see the LICENSE file for details.