@bipsync/apiclient

Installation

npm install @bipsync/apiclient

Examples

Getting the latest notes

example.js

require( '@bipsync/apiclient' )()
    .then( function( client ) {
        // make a request to the research api
        client.request( 'v1/research' )
            .then( function( response ) {
                // grab the results
                return response.results;
            } )
            .map( function( research ) {
                // print the title for each document
                console.log( research.title );
            } ); } );

run it

$ node example.js // --options='{"property":"value"}'
latest note title #1
latest note title #2
latest note title #3
...

using the OAuth device code grant to authenticate

When running reports locally OAuth can be used to authenticate:

$ node example.js --deviceAuth // --options='{"property":"value"}'
OAuth app ID (https://alpha-api.bipsync.devenv): 
Visit the following URL in your browser to approve this request and obtain an access token:
https://alpha.bipsync.devenv/oauth/device?user_code=KGNRKXVB
latest note title #1
latest note title #2
latest note title #3
...

You will be prompted to visit a web app URL to approve the request. Once authorized the API client will retrieve a short-lived access token from the API and make it available to the report.