Getting Started with MultiAuth-Sample

Introduction

API for Markdown Notes app.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

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 | | --- | --- | --- | | accessToken | string | | | port | string | Default: '80' | | suites | SuiteCodeEnum | Default: SuiteCodeEnum.Hearts | | environment | Environment | The API environment. Default: Environment.Testing | | timeout | number | Timeout for API calls.Default: 0 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | basicAuthCredentials | BasicAuthCredentials | The credential object for basicAuth | | apiKeyCredentials | ApiKeyCredentials | The credential object for apiKey | | apiHeaderCredentials | ApiHeaderCredentials | The credential object for apiHeader | | oAuthCCGCredentials | OAuthCCGCredentials | The credential object for oAuthCCG | | oAuthACGCredentials | OAuthACGCredentials | The credential object for oAuthACG | | oAuthROPCGCredentials | OAuthROPCGCredentials | The credential object for oAuthROPCG | | oAuthBearerTokenCredentials | OAuthBearerTokenCredentials | The credential object for oAuthBearerToken |

HttpClientOptions

| Parameter | Type | Description | | --- | --- | --- | | timeout | number | Timeout in milliseconds. | | httpAgent | any | Custom http agent to be used when performing http requests. | | httpsAgent | any | Custom https agent to be used when performing http requests. | | retryConfig | Partial<RetryConfiguration> | Configurations to retry requests. |

RetryConfiguration

| Parameter | Type | Description | | --- | --- | --- | | maxNumberOfRetries | number | Maximum number of retries. Default: 0 | | retryOnTimeout | boolean | Whether to retry on request timeout. Default: true | | retryInterval | number | Interval before next retry. Used in calculation of wait time for next request in case of failure. Default: 1 | | maximumRetryWaitTime | number | Overall wait time for the requests getting retried. Default: 0 | | backoffFactor | number | Used in calculation of wait time for next request in case of failure. Default: 2 | | httpStatusCodesToRetry | number[] | Http status codes to retry against. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524] | | httpMethodsToRetry | HttpMethod[] | Http methods to retry against. Default: ['GET', 'PUT'] |

The API client can be initialized as follows:

const client = new Client({
  basicAuthCredentials: {
    username: 'Username',
    password: 'Password'
  },
  apiKeyCredentials: {
    'token': 'token',
    'api-key': 'api-key'
  },
  apiHeaderCredentials: {
    'token': 'token',
    'api-key': 'api-key'
  },
  oAuthCCGCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret'
  },
  oAuthACGCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthRedirectUri: 'OAuthRedirectUri',
    oAuthScopes: [
      OAuthScopeOAuthACGEnum.ReadScope
    ]
  },
  oAuthROPCGCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret',
    oAuthUsername: 'OAuthUsername',
    oAuthPassword: 'OAuthPassword'
  },
  oAuthBearerTokenCredentials: {
    accessToken: 'AccessToken'
  },
  accessToken: 'accessToken',
  timeout: 0,
  environment: Environment.Testing,
});

Environments

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

Fields

| Name | Description | | --- | --- | | production | - | | testing | Default |

Authorization

This API uses the following authentication schemes.

• basicAuth (Basic Authentication)
• apiKey (Custom Query Parameter)
• apiHeader (Custom Header Signature)
• OAuthCCG (OAuth 2 Client Credentials Grant)
• OAuthACG (OAuth 2 Authorization Code Grant)
• OAuthROPCG (OAuth 2 Resource Owner Credentials Grant)
• OAuthBearerToken (OAuth 2 Bearer token)
• CustomAuth (Custom Authentication)

List of APIs

• O Auth Authorization
• Authentication

Classes Documentation

• ApiResponse
• ApiError