Skip to content

Latest commit

 

History

History
77 lines (50 loc) · 2.07 KB

README.md

File metadata and controls

77 lines (50 loc) · 2.07 KB
Raw

Stateset Node.js Library

The Stateset Node.js Library provides convenient access to the Stateset API from applications written in server-side JavaScript.

Installation

Install the package with:

npm install stateset-node --save

Usage

The package needs to be configured with your account's secret key, which is available in the Stateset Cloud Platform Dashboard.

Get started with the Stateset API

  1. Go to the Stateset Cloud Platform Dashboard.
  2. Login with your Stateset account.
  3. Create an API key.
  4. Try the Node.js quickstart

Usage example

See the Node.js quickstart for complete code.

  1. Install the SDK package
npm install stateset-node
  1. Initialize the client
import stateset from 'stateset-node';

const client = new stateset({apiKey: process.env.STATESET_API_KEY});
  1. Make an API call
try {
  const response = await client.returns.list();
  const returns = response.returns;
  console.log(returns);
} catch (error) {
  console.error('Error fetching returns:', error);
}

Try out a sample app

This repository contains sample Node and web apps demonstrating how the SDK can access and utilize the Stateset API for various use cases.

To try out the sample Node app, follow these steps:

  1. Check out the Stateset Node.js Library repository.
  2. Obtain an API key from the Stateset Cloud Platform Dashboard.
  3. Navigate to the samples folder and run npm install.
  4. Set your API key as an environment variable: export STATESET_API_KEY=YOUR_API_KEY.
  5. Open the sample file you're interested in, e.g., returns_list.js.
  6. Run the sample file: node returns_list.js.

Documentation

See the Stateset API Documentation for complete documentation.

Contributing

See CONTRIBUTING.md for more information on contributing to the Stateset Node.js Library.

License

The contents of this repository are licensed under the Apache License, version 2.0.