Foxbit Partner JavaScript/TypeScript SDK

This is the official Partner SDK provided by Foxbit for partners to interact with our private APIs using JavaScript or TypeScript.

Prerequisites

Ensure your environment meets the following requirements before using the SDK:

Environment

• Node.js (version 14 or higher recommended)
• NPM (comes bundled with Node.js)

Language Level

• ES5 (requires a Promises/A+ compatible library)
• ES6 or higher (recommended)

Module System Support

• CommonJS
• ES6 Modules

Installation

Install the SDK using NPM:

npm install @foxbit-group/rest-api-partner

How to Use

For endpoints that don't require authentication:

import { FiatGatewayApi } from "@foxbit-group/rest-api-partner";

// Create an instance of the API
const fiatGatewayApi = new FiatGatewayApi();

// Make API calls
fiatGatewayApi
  .listMarkets()
  .then((response) => {
    console.log("Markets:", response.data);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

For endpoints that require authentication:

import { Configuration, SubMemberApi } from "@foxbit-group/rest-api-partner";

// Initialize the configuration with your API key and secret
const config = new Configuration({
  apiKey: "YOUR_API_KEY",
  apiSecret: "YOUR_API_SECRET",
});

// Create an instance of the API
const subMemberApi = new SubMemberApi(config);

// Make API calls
subMemberApi
  .subMemberControllerListSubMembers()
  .then((response) => {
    console.log("Sub Members:", response.data);
  })
  .catch((error) => {
    console.error("Error:", error);
  });

Authentication

Some endpoints require authentication while others don't. Please refer to the examples above in the "How to Use" section.

The SDK will automatically:

1. Generate the current timestamp
2. Create the request signature using your API secret
3. Add the required headers to each request:
   • X-FB-ACCESS-KEY: Your API key
   • X-FB-ACCESS-TIMESTAMP: Current timestamp
   • X-FB-ACCESS-SIGNATURE: Signature generated from your API secret

Documentation for API Endpoints

You can find detailed documentation for each API endpoint in the Foxbit Partner API Documentation.

Note: Partner API documentation may require special access credentials. Please contact Foxbit support if you need access.

Partner Integration

This SDK is designed specifically for Foxbit partners. To become a partner and get access to the Partner API:

1. Contact the Foxbit business team at [email protected]
2. Complete the partner onboarding process
3. Receive your partner API credentials
4. Follow the integration guidelines provided by our team

Support

For partner-specific support, please contact [email protected].

About This SDK

This SDK was automatically generated using OpenAPI Generator.

Note: This SDK is actively maintained by the Foxbit team. For more information, visit https://foxbit.com.br.