contrast-sdk

Install

The Contrast Api module is available to install via npm.

    npm install contrast-sdk --save

Sample usage

The SDK offers a majority of our public APIs through an instance of the ContrastSdk. Any method of the SDK that interacts with our API returns a promise.

Note: The Contrast URL is optional and defaults to https://app.contrastsecurity.com/Contrast/api

    var ContrastSdk = require('contrast-sdk');    
    var contrastSdk = new ContrastSdk('username','api_key','service_key','teamserver_url');

An example of getting an application:

    var orgUuid='organization_uuid';
    contrastSdk.getApplication(orgUuid, 'an_app_id').then(function(response){
        console.log(response.application.name);
    });

In some cases, you may want to filter applications, servers, traces or libraries. Any endpoint that involves filtering can use the appropriate filter object.

These methods are easily identifiable on the ContrastSdk object by looking at any methods that include the phrase filter.

    var filter = {};
    filter.apps = ['appId1', 'appId2'];
    contrastSdk.filterLibraries(orgUuid, filter).then(function(response){
        response.libraries.forEach(function(library){
            console.log(library.file_name + ' : ' + library.grade);
        });
    });

Developing

Use npm to install the projects dependencies:

    npm install
    npm install -g mocha

To run the tests, create a file in the /tests directory called config.json with TeamServer information. An example test configuration can be seen in tests/config.json.example.

Then run tests with mocha:

    npm run test