candor-js-lib v1.0.0

candor-js

JS/TS Library for Candor Services' Project Mercury API.

Documentation

You can add the library to your project with:

npm install candor-mercury

You can then get started by intializing a new instance of the Candor clas using your public API key found at https://candorian.app/api-dashboard.

Verifying a license

You can verify if a license is valid using this function:

let valid = await candor.verifyLicense(LICENSE_KEY, PRODUCT_ID);

You'll want to grab your product ID from https://candorian.app/license-manager by creating a new product and then adding a license. The license key should be added by the client, using some sort of config (we recommend remote configs, see below!). Assign your license to your client using the tools in the dashboard.

Retrieving a remote config

Remote configs allow clients to easily configure parts of their apps without having to mess with complicated or messy configuration files. You can use this function:

let obj = await candor.getConfig(CONFIG_ID);

to retrieve the remote config as a JS object. You can create a remote config at https://candorian.app/config-manager.

Need support?

If you need help with anything to do with this project, then please see the project-mercury-support channel in Discord under the FREELANCERS category.