T1-ESB Services

Install via npm dependencies

// in package.json
...
dependencies: {
  ...
  "t1-esbservices": "https://gitlab+deploy-token-43773:[email protected]/t1p/t1-esbservices.git#releases",
  ...
},

ESB Services Setup

To setup ESBServices, use createESBServices(config) function.

Config

• apiKey - required, api key to Services provided by ESB
• accessKey - required, access key to Services provided by ESB
• secretAccessKey - required, secret access key to Services provided by ESB
• endpoint - optional, ESB Services Endpoint provided by ESB.

This library aims to provide services to ESB in Production level for Production usages. By providing Production-level Endpoint, it allows ESB to changes their endpoint.

For security reasons, all access keys are required to in order to use the services.

// ES5-JavaScript
const { createESBServices } = require("t1-esbservices");

const ESBServices = createESBServices({
  apiKey: "api key",
  accessKey: "access key",
  secretAccessKey: "secret access key",
  endpoint: "sample.esb.endpoint.com",
});

// ES6-JavaScript, TypeScript
import { createESBServices } from "t1-esbservices";

const ESBServices = createESBServices({
  apiKey: "api key",
  accessKey: "access key",
  secretAccessKey: "secret access key",
  endpoint: "sample.esb.endpoint.com",
});

ESB Services: Commands and Queries

The provided services can be categorized into 2 groups: Commands and Queries.

The name of each function begins with either command or query.

The Command functions are the services that make some data changes.

The Query functions are the services that gets current data.