Integrations Platform - Client

This component is a JS client library to communicate with the Integrations Platform Server. It exposes a standard oazapfts interface compiled without the --optimistic option.

Getting started

1. Install the library:

npm install @unito/integrations-platform-client

2. Use the library:

import * as IntegrationsPlatform from '@unito/integrations-platform-client';

IntegrationsPlatform.defaults.baseUrl = 'http://enpoint.to.the.server';
IntegrationsPlatform.defaults.headers = { Authorization: 'Bearer YOUR_TOKEN' };

try {
  IntegrationsPlatform.optimistic(IntegrationsPlatform.getIntegrations());
} catch (err: unknown) {
  if (err instanceof IntegrationsPlatform.HttpError) {
    // Handle the error.
  }
}

See oazapfts for more information.

Development

Getting started

Install the dependencies:

npm ci

Regenerate the library

npm publish --dry-run

Publish the library

1. Modify the version. For example:

npm version minor

See npm version help for more information.

2. Create a changeset -> pull request -> merge on main.

3. A Github Action will automatically publish the package in our private NPM repository.

Terms and Conditions

By using the Integration Platform Client, you agree to be bound by our terms and conditions. Please ensure you have read and understood the Unito Software Development Kit Agreement before using the Platform Client. The full agreement can be found at Unito SDK Agreement.