datavenue

SDK for Orange Datavenue platform

Usage no npm install needed!

<script type="module">
  import datavenue from 'https://cdn.skypack.dev/datavenue';
</script>

README

Datavenue NodeJS SDK

This open-source library allows you to integrate Datavenue into your NodeJS app. Learn more about Datavenue at https://datavenue.orange.com

Sample usage

First, you need an Orange Partner account : https://datavenue.orange.com (getting started)

Clone the projet on github, go to Sample directory and run node:

git clone https://github.com/Orange-Datavenue/Datavenue-NodeJS-SDK.git
cd Datavenue-NodeJS-SDK/sample
node server.js

Open a browser and go to http://localhost:8080/

Put your Orange Partner Key
Put your Default Master Key
Press "Submit" button

The Node server will use the SDK for call some API on Datavenue platform.

Installation

The Datavenue NodeJS SDK is available through NPM (https://www.npmjs.com/package/datavenue). To install it, install NPM and run:

npm install datavenue

The Datavenue NodeJS SDK has externals dependencies to :

q - A library for promise (https://www.npmjs.com/package/q)
request - A http client request (https://www.npmjs.com/package/request) 

Documentation

The latest documentation is available on github. See file docs/user_guide_datavenue_sdk_nodejs_1.0.1.pdf

License

Datavenue NodeJS SDK is available under the Apache v2.0 license. See the LICENSE file for more info.