Octopian-apis NPM

📝 Table of Contents

About
Getting Started
Usage
Built Using
Authors

🧐 About

The Transaction APIs SDK simplifies the integration of Octopian Cloud Services into your Node.js applications. With support for both JavaScript and TypeScript, this SDK provides seamless interaction with transaction-based services, leveraging well-defined input and output models. Whether you're working on a backend service, a CLI tool, or a full-stack application, this SDK ensures a consistent and efficient development experience.

Key Features:

Compatibility: Designed for both JavaScript and TypeScript projects.

Modular Design: Offers reusable input and output models to standardize API interactions.

Performance: Optimized for high-speed and reliable transaction processing.

Flexibility: Works across any Node.js environment.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

no prerequisites ready

Installing

A step by step series of examples that tell you how to get a development env running.

Use below command to install the SDK to your project

you will need to provide an API key that was generated by admin to authorize the APIs in the SDK, and the domain name (dns) that will be used for the application.

npm install octopian-apis

Initializing

In order to use the sdk after installation you need to initialize it, like below.

import { OctopianSDKConfig } from "octopian-apis";

OctopianSDKConfig.Init('Your-API-Key',"Domain-Name")

🎈 Usage

For detailed usage and services available in this SDK download our documentation

import {AuthenticationServices} from 'octopian-apis';

function LoginSample() {
  var Output = AuthenticationServices.Login({
    Username: 'username',
    Password: 'password',
    DomainName: 'domain name',
    ClientType: 'client type guid',
  });

  console.log(Output.Result);
}