ntlango-api-client v1.0.3

Ntlango API Client

The Ntlango API Client is a TypeScript client for the Ntlango API, generated from the OpenAPI specification located in the ntlango-api-model npm.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Initializing the Client
  • Making API Requests
• Contributing
• License

Getting Started

Prerequisites

Before using the Ntlango API Client, make sure you have the following prerequisites installed:

• Node.js
• npm (Node Package Manager)

Installation

To install the Ntlango API Client, follow these steps:

1. Install the ntlango-api-client npm package.

npm install ntlango-api-client

Usage

Initializing the Client

You need to initialize the Ntlango API Client before making API requests. To do so, you can create an instance of the NtlangoClient class.

import { NtlangoClient } from 'ntlango-api-client';

const ntlangoInitializationProps = {
  baseUrl: 'https://api.beta.ntlango.com/api/v1',
};

const client = new NtlangoClient(ntlangoInitializationProps);

Making API Requests

With the client initialized, you can make API requests using the ntlangoClient instance.

const response = await client.ntlangoClient.someApiEndpoint(parameters);
console.log(response.data); // Process the API response

Contributing

We welcome contributions to the Ntlango API Client. If you find a bug or have an improvement in mind, please open an issue or submit a pull request in the ntlango-api-client repository.

License

This project is licensed under the MIT License.