@emilgroup/process-manager-sdk-node v1.5.0
Emil Process Manager SDK for Nodejs
This TypeScript/JavaScript client utilizes axios. The generated Node module can be used with Nodejs based applications.
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via package.json
. (Reference). For more information, you can go to Emil Api documentation.
Consuming
Navigate to the folder of your consuming project and run one of the following commands:
npm install @emilgroup/process-manager-sdk-node@1.5.0 --save
or
yarn add @emilgroup/process-manager-sdk-node@1.5.0
And then you can import WorkflowsApi
.
import { WorkflowsApi } from '@emilgroup/process-manager-sdk-node'
const workflowsApi = new WorkflowsApi();
Credentials
To use authentication protected endpoints, you have to first authorize. To do so, the easiest way is to provide a configuration file under ~/.emil/credentials
with the following content:
emil_username=XXXXX@XXXX.XXX
emil_password=XXXXXXXXXXXXXX
It is also possible to provide environment variables instead:
export EMIL_USERNAME=XXXXX@XXXX.XXX
export EMIL_PASSWORD=XXXXXXXXXXXXXX
Example
Here is a basic functionning example:
async function listWorkflows(): Promise<Void> {
try {
const workflowsApi = new WorkflowsApi();
await workflowsApi.initialize(); // should be called only once per Api.
const { data: { items } } = await workflowsApi.listWorkflows();
console.log(items);
} catch(error) {
// process error
}
}