ArrowDB Node SDK
The SDK of ArrowDB for NodeJS
Getting started
git clone git+https://github.com/appcelerator/arrowdb-node-sdk.gitcd arrowdb-node-sdknpm install
Basic Example
You can get an overview of ArrowDB Node SDK example from examples/basic.js
cd arrowdb-node-sdk/examplesexport ARROWDB_APPKEY=YOUR_ARROWDB_TEST_APPKEYnode basic.js
ArrowDB Node SDK Example on Node.ACS
There is another example for ArrowDB Node SDK to show how to run on Node.ACS as a service.
Make sure you have installed Node.ACS command line tool first:
sudo npm -g install acs
Then you can try:
cd arrowdb-node-sdk/examples/over_nodeacs# Update config.json to fill in your ArrowDB app key vi config.jsonacs run
Open another session and try:
curl -b cookie.txt -c cookie.txt -X POST -F "login=YOUR_USERNAME" -F "password=YOUR_PASSWORD" http://localhost:8080/logincurl -b cookie.txt -c cookie.txt -X GET http://localhost:8080/showMe
ArrowDB Node SDK Basic Usage
Use ArrowDB Node SDK directly
var ArrowDB = ;var arrowDBApp = 'Your_ARROWDB_APPKEY'; arrowDBApp;
Use ArrowDB Node SDK inner express or http/https NodeJS module
// HTTP call 1 with cookie:var arrowDBApp = 'Your_ARROWDB_APPKEY'; arrowDBApp; // HTTP call 2 with cookie, after HTTP call 1:var ArrowDB = ;var arrowDBApp = 'Your_ARROWDB_APPKEY'; arrowDBApp;
Custom ACS Endpoint
var ArrowDB = ;var arrowDBApp = arrowDBKey apiEntryPoint: "api.customacs.com" prettyJson: true ;
General RestAPI call
var arrowDBApp = 'Your_ARROWDB_APPKEY'; arrowDBApp;
Session Management
By default, arrowdb-node-sdk will manage sessions for you automatically when you
log in and out. You can create a new ArrowDB
instance for each authenticated
session. You can also reuse an existing instance by calling usersLogin()
again,
however this simply overwrites the existing session cookie and will not log out
the previous session.
However, if you'd prefer to manually manage the session cookie, then you can set
the autoSessionManagement
option to false
when the ArrowDB
instance is
created.
var arrowDBApp = 'Your_ARROWDB_APPKEY' autoSessionManagement: false;
This means once you log in, you must track the session cookie yourself:
arrowDBApp;
Running Unit Tests
To run the unit tests, simply run:
export ARROWDB_APPKEY=ONE_OF_YOUR_ARROWDB_TEST_APPKEY
npm test
License
This project is open source and provided under the Apache Public License
(version 2). Please make sure you see the LICENSE
file included in this
distribution for more details on the license. Also, please take notice of the
privacy notice at the end of the file.