@datenkraft/bb-control-server-api-ts-client NPM

Backbone - Control Server API TS Client

Introduction

The Control Server API TS Client enables you to work with the Control Server API.

Prerequisites

Installation

You can use npm to install the package.

npm install @datenkraft/bb-control-server-api-ts-client

Using the package

The package can be used to communicate with the Control Server API. The Client includes functionalities for every endpoint defined in the openapi.json. The Client is auto-generated with ferdikoomen/openapi-typescript-codegen using an openapi.json file.

Initializing the Client

import { ConfigOptions } from '@datenkraft/bb-base-api-ts-client';
import { ControlServerApiClient } from '@datenkraft/bb-control-server-api-ts-client';

const configOptions: ConfigOptions = {
  clientId: 'clientId',
  clientSecret: 'clientSecret',
  oAuthTokenHost: 'oAuthTokenHost',
  tokenTradeInPath: 'tokenTradeInPath',
  externalIdToken: 'externalIdToken',
  useExternalIdToken: true,
};

ControlServerApiClient.init(configOptions).then(() => {
  // Client is initialized
});

Example Endpoint: Get Task Template Collection

ControlServerApiClient.Generated.TaskTemplateService
  .getTaskTemplateCollection()
  .then((taskTemplateCollection) => {
    // Request succeeded
  })
  .catch((error) => {
    // An error occured
  });