@apimatic/sdk

Getting Started with Apimatic API

Introduction

This API gives you programmatic access to APIMatic's Code Generation, Docs Generation and Transformation Engine

Building

Requirements

The SDK relies on Node.js and npm (to resolve dependencies). It also requires Typescript version >=4.1. You can download and install Node.js and npm from the official Node.js website.

NOTE: npm is installed by default when Node.js is installed.

Verify Successful Installation

Run the following commands in the command prompt or shell of your choice to check if Node.js and npm are successfully installed:

• Node.js: node --version

• npm: npm --version

Install Dependencies

• To resolve all dependencies, go to the SDK root directory and run the following command with npm:

npm install

• This will install all dependencies in the node_modules folder.

Installation

The following section explains how to use the generated library in a new project.

1. Initialize the Node Project

• Open an IDE/text editor for JavaScript like Visual Studio Code. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

• Click on File and select Open Folder. Select an empty folder of your project, the folder will become visible in the sidebar on the left.

• To initialize the Node project, click on Terminal and select New Terminal. Execute the following command in the terminal:

npm init --y

2. Add Dependencies to the Client Library

• The created project manages its dependencies using its package.json file. In order to add a dependency on the Apimatic APILib client library, double click on the package.json file in the bar on the left and add the dependency to the package in it.

• To install the package in the project, run the following command in the terminal:

npm install

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
userAgent	string
customUrl	string	The testing domain for the API Default: 'https://localhost:44301/api'
environment	Environment	The API environment. Default: Environment.Production
timeout	number	Timeout for API calls. Default: 30000
httpClientOptions	Partial<HttpClientOptions>	Stable configurable http client options.
unstableHttpClientOptions	any	Unstable configurable http client options.
logging	PartialLoggingOptions	Logging Configuration to enable logging
customHeaderAuthenticationCredentials	CustomHeaderAuthenticationCredentials	The credential object for customHeaderAuthentication

The API client can be initialized as follows:

import { Client, Environment, LogLevel } from 'apimatic-apilib';

const client = new Client({
  customHeaderAuthenticationCredentials: {
    'Authorization': 'Authorization'
  },
  userAgent: 'user-agent',
  timeout: 30000,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
  customUrl: 'https://localhost:44301/api',
});

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
production	Default
testing	-

Authorization

This API uses the following authentication schemes.

• Authorization (Custom Header Signature)

List of APIs

• APIs Management
• Code Generation-Imported APIs
• Code Generation-External APIs
• Docs Portal Management
• Docs Portal Generation-Async
• API Validation-Imported APIs
• API Validation-External APIs
• API Validation V2 -External APIs
• Transformation

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError