use-sdk

Use SDK

Install a TypeScript SDK, generated with @ama-sdk/schematics, configure an API client, and make API calls.

Choosing a Client

Client	Package	Best For
ApiFetchClient	@ama-sdk/client-fetch	Node.js, browsers, standalone apps, SSR, Angular apps with ApiManager
ApiAngularClient	@ama-sdk/client-angular	Angular apps needing HttpClient (interceptors, SSR transfer state)
ApiBeaconClient	@ama-sdk/client-beacon	Fire-and-forget tracking/analytics calls

In Angular apps, prefer ApiFetchClient with ApiManager (see below) unless you specifically need Angular's HttpClient features (interceptors, transfer state).

Setup: ApiFetchClient (Standalone / Node.js / Browser)

Install

# @my-org/my-sdk is a placeholder for the generated SDK package name
npm install @ama-sdk/client-fetch @ama-sdk/core @my-org/my-sdk

Configure

import { ApiFetchClient } from '@ama-sdk/client-fetch';
import { PetApi } from '@my-org/my-sdk';

const client = new ApiFetchClient({
  basePath: 'https://api.example.com/v1',
  requestPlugins: [],
  fetchPlugins: []
});

const petApi = new PetApi(client);

Constructor Options

For the full list of options, read the source interfaces:

• ApiFetchClient options: https://github.com/AmadeusITGroup/otter/blob/main/packages/@ama-sdk/client-fetch/src/api-fetch-client.ts (see BaseApiFetchClientOptions and BaseApiFetchClientConstructor)
• Base options (shared by all clients): https://github.com/AmadeusITGroup/otter/blob/main/packages/@ama-sdk/core/src/fwk/core/base-api-constructor.ts (see BaseApiClientOptions)

Setup: ApiAngularClient (Angular Apps)

Install

ng add @ama-sdk/client-angular
npm install @my-org/my-sdk

Configure

import { inject } from '@angular/core';
import { HttpClient } from '@angular/common/http';
import { ApiAngularClient } from '@ama-sdk/client-angular';

const client = new ApiAngularClient({
  httpClient: inject(HttpClient),
  basePath: 'https://api.example.com/v1'
});