@fsdkjs/fsdk-js

fsdk JS Client

The fsdk JS Client provides easy access to the fsdk API from a client written in Typescript.

Documentation

You can learn more about this client and how to use it our documentation.

To learn more about the API endpoints that this client allows you to access check out our API reference.

Installation

Install the package with:

npm install @fsdkjs/fsdk-js
# or
yarn add @fsdkjs/fsdk-js

Usage

Import fsdk as a default import and initiate it:

import fsdk from "@fsdkjs/fsdk-js"

const fsdk = new fsdk()

const { cart } = await fsdk.carts.create({})

Authentication

Authentication can be achieved in two ways using the fsdk-js client, either by utilizing API keys or by using cookie based authentication, each with their own unique use case.

Using API keys

API keys can only be used for admin functionality in fsdk because only users of the admin system have api keys. To use API keys for authentication the key should be used when fsdk-js is initialized with a config object as described below.

Using cookies

Authentication using cookies is done automatically by Axios when authenticating using the auth endpoints. After authentication all subsequent calls will be authenticated.

note: Cookie based authentication cannot be used in plain node.js applications due to the limitations of axios and useCredentials not setting the Cookie request header when set-cookie is present in the response headers. For pure node.js applications use authentication with api keys(see above)

Configuration

Initialize with config object

The package can be initialized with several options:

const fsdk = new fsdk({
  maxRetries: 3,
  baseUrl: "https://api.example.com",
})

Option	Default	Description
maxRetries	0	The amount of times a request is retried.
baseUrl	'http://localhost:9000'	The url to which requests are made to.
apiKey	''	Optional api key used for authenticating admin requests .