@arrowsphere/api-client

ArrowSphere nodejs-api-client package

This package provides a Node.js HTTP client for ArrowSphere's public API. It should be the only way to make calls to ArrowSphere's API with Node.js code.

To use this package, you need valid access to ArrowSphere, with a valid API key.

Installation

Install the latest version with

npm install @arrowsphere/api-client

Basic usage

const { PublicApiClient } = require('@arrowsphere/api-client')

const URL = 'https://your-url-to-arrowsphere.example.com'
const API_KEY = 'your API key in ArrowSphere'

const client = new PublicApiClient().setUrl(URL).setApiKey(API_KEY)

client
  .getWhoamiClient()
  .getWhoami()
  .then((result) => console.log(result))

TypeDoc documentation

To generate the TypeDoc documentation and explore it, use the following command

npm run doc

The output documentation should be located in the docs/ folder, just open the index.html file in any local browser.

Specific API clients

General

• CheckDomain

• WhoAmI

• Campaign

• Cart

• Catalog

• Consumption

• Contact

• Customers

• Licenses

• Orders

• Subscriptions

• Support Center

• SecurityScore

Licenses

• Find Licenses
• Get License