This package contains the HTTP client used by the Sinch SDK client. It uses 2 third-party dependencies:

• node-fetch to send requests.
• form-data to manage "multipart/form-data" streams.

There are 5 folders in this package:

• api: it defines the interface for an Api, an ApiClient and for ApiClientOptions.
• client: it contains the fetch implementation for the ApiClient. This implementation handles the refresh of the JWT for the APIs which support this authentication method.
• domain: it contains some Sinch-specific interfaces and enums used at domain level for authentication and region definition.
• plugins: calling an API can be seen as a straighforward operation as it's "just" about sending an HTTP request to a server and reading the response. And this is was the ApiClient does. However, all APIs don't behave the same and this is why we have introduced the request and response plugins:
  • request plugins will modify the request: for the moment, they are all about adding some headers (for authentication, for tracking the SDK usage).
  • response plugins will modify the response, e.g.: response content is checked and transformed into an exception if the content is empty.
• utils: it contains some utility methods that are used by the API SDKs, such as the methods to validate headers are valid in a callback event request, or a method to convert text to hexadecimal for a UDH header

npm install @sinch/sdk-client

yarn add @sinch/sdk-client

In this section, we'll see how to implement the Api interface and how to use the ApiFetchClient to call the API endpoint.

export class MyExampleApi implements Api {
    public readonly apiName = 'MyExampleApi';
    public readonly client: ApiClient;

    constructor(apiClient: ApiClient) {
        this.client = apiClient;
    }

    public async myApiOperation(): Promise<Response> {
        // Define the API endpoint
        const url = `${this.client.apiClientOptions.basePath}/myDomain`;
        // Build the request options: you can use the method 'prepareOptions' from the apiClient 
        // that will apply the request plugins onto the default built options
        const requestOptions: RequestOptions = await this.client.prepareOptions(...);
        // Send the request and apply the response plugins
        return this.client.processCall<Response>({
            url,
            requestOptions,
            apiName: this.apiName,
        });
    }
}

const apiClientOptions: ApiClientOptions = {
  basePath: 'https://my-example-api-server.com',
  requestPlugins: [
    // Add here the plugins that will be executed before the request is sent
  ],
  responsePlugins: [
    // Add here the plugins that will be executed after the response is received and parsed
  ]
}

// Instantiate the API Client
const apiClient = new ApiFetchClient(apiClientOptions);

// Once the API Client is intantiated, it can be given as a parameter to your API
const myApi = new MyExampleApi(apiClient);

// The API operations can now be invoked
const myResponse = await myApi.myApiOperation();

Developer Experience team: devexp@sinch.com