# @gofynd/fdk-client-javascript 中文文档

规范地址：https://npmcn.com/package/%40gofynd/fdk-client-javascript/

版本：3\.36\.0
npm 元数据更新时间：2026-10-23T13:26:46.969Z
中文译文更新时间：2026-11-16T18:10:08.949Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gofynd/fdk-client-javascript
原文对照：https://npmcn.com/package/%40gofynd/fdk-client-javascript/?lang=original
项目主页：https://github.com/gofynd/fdk-client-javascript#readme
源码仓库：https://github.com/gofynd/fdk-client-javascript

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：10.4 MB，337 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2023-01-19T07:07:06.658Z
- 最新版本发布：2026-10-23T13:26:46.549Z
- 近 30 天下载量：10118（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：162（近 12 个月 29 个）

## 中文简介

![GitHub package.json version](https://img.shields.io/github/package-json/v/gofynd/fdk-client-javascript?style=plastic) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gofynd/fdk-client-javascript/Node.js%20CI?style=plastic) \[吉他\]

## 安装

```sh
npm install @gofynd/fdk-client-javascript
```

也可以使用：`pnpm add @gofynd/fdk-client-javascript`、`yarn add @gofynd/fdk-client-javascript`、`bun add @gofynd/fdk-client-javascript`

## README

# FDK Javascript

![GitHub package.json version](https://img.shields.io/github/package-json/v/gofynd/fdk-client-javascript?style=plastic) ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gofynd/fdk-client-javascript/Node.js%20CI?style=plastic) ![GitHub](https://img.shields.io/github/license/gofynd/fdk-client-javascript?style=plastic) [![Coverage Status](https://coveralls.io/repos/github/gofynd/fdk-client-javascript/badge.svg)](https://coveralls.io/github/gofynd/fdk-client-javascript)

Javascript 的 FDK 客户端

## 开始

启动 Fynd 平台的 Javascript 开发 SDK

### 使用量

#### 节点

```bash
npm install @gofynd/fdk-client-javascript
```

用这种方法,你可以 `require` fdk - 客户端 - javascript 像这样:

```js
const {
  ApplicationClient,
} = require("fdk-client-javascript");
```

#### 浏览器

您可以从 CDN 装入 fdk-client-javascript 的应用程序浏览器捆绑; `ApplicationClient` 财务报告和审定财务报表 `ApplicationModels` 将附加在浏览器上 `window` 对象.

```html
<script src="https://cdn.jsdelivr.net/gh/gofynd/fdk-client-javascript@<version>/dist/application.js"></script>
```

安装特定版本

```html
<script src="https://cdn.jsdelivr.net/gh/gofynd/fdk-client-javascript@1.1.0/dist/application.js"></script>
```

```js
const { ApplicationClient } = window;
```

### 日志

对于日志支持用户可以通过 `logLevel` 内 `ApplicationClient` 或者说 `PlatformClient` 在宣布的时候.

```
Available logging levels: TRACE, DEBUG, INFO, WARN, ERROR.

Default log level: ERROR
```

### 样本使用 - 应用程序客户端

```javascript
const applicationClient = new ApplicationClient({
  applicationID: "YOUR_APPLICATION_ID",
  applicationToken: "YOUR_APPLICATION_TOKEN",
  locationDetails: "LOCATION_DETAILS_OBJECT"
});

applicationClient.setLocationDetails({ 
  pincode:"385001",
  country: "India",
  city:  "Ahmedabad",
  location: {longitude: "72.585022", latitude: "23.033863"}
  });


async function getProductDetails() {
  try {
    const product = await applicationClient.catalog.getProductDetailBySlug({
        slug: "product-slug"
      });
    console.log(product.name);
  } catch (err) {
    console.log(err);
  }
}

getProductDetails();
```

### 样本使用量 - 平台客户端

```javascript
const { PlatformClient } = require("fdk-client-javascript");

async function getData() {
  try {
    const client = new PlatformClient({
      companyId: "COMPANY_ID",
      apiKey: "API_KEY", 
      apiSecret: "API_SECRET", 
      domain: "DOMAIN",
      useAutoRenewTimer: true // Setting `true` will use timer based logic to refresh the access token. With `false` will issue refresh token just before any api call when it is expired. 
    });

    const token = await platformClient.getAccesstokenObj({
      grant_type: 'client_credentials'    
    })
    
    platformClient.setToken(token);

    // API's without application_id
    const tickets = await client.lead.getTickets();
    console.log("tickets", tickets);

    // API's with application_id
    const customers = await client
      .application("APPLICATION_ID")
      .user.getCustomers();
    console.log("customers", customers);
  } catch (err) {
    console.log(err);
  }
}

getData();
```

* * *

### 样本使用 - 请求功能.

请求功能允许您轻松地自定义 API 请求 。 两者都有 `platform` 财务报告和审定财务报表 `application` 客户端.

```javascript

let auditLog = await client.request({
    url: `/service/platform/audit-trail/v1.0/company/1/logs`,
    method: 'GET',
});

```

这个 `request` 函数接受一个带有以下可能按键的对象:

-   **方法** (字符串):使用HTTP方法(如"GET","POST","PUT","DELETE").
-   **url 密码** (字符串):请求的URL端点.
-   **查询** (对象):在请求的URL中包含查询参数.
-   **机构** (对象):请求发送的有效载荷.
-   **页眉** (对象):请求中包含的额外头.

* * *

### 饼干

代码片段会代表你读写曲奇  
以后的请求中会附上饼干.

```javascript
const { FdkAxios } = require('@gofynd/fdk-client-javascript');
const { wrapper } =  require("axios-cookiejar-support");
const { CookieJar } = require("tough-cookie");


wrapper(FdkAxios);
const cookieJar = new CookieJar();
FdkAxios.defaults.jar = cookieJar;


module.exports = cookieJar
```

从 CookieJar 实例中获得存储的饼干

```javascript
const cookieJar = require('path/to/cookieJar') // replace with actual path

let cookies = await cookieJar.getCookies("https://api.fynd.com");
```

* * *

### 页眉

#### 添加请求信头

要在调用方法时包含请求头, 请添加 `requestHeaders` 第一个参数中的对象.

```javascript
const requestHeaders = {
  "x-api-version": "1.0"
}

const options = {
  responseHeaders: true
}

const [response, headers] = await platformClient.application("<APPLICATION_ID>").theme.getAllPages({theme_id: "<THEME_ID>", requestHeaders: requestHeaders}, options);
```

#### 获取回复信头

要获取响应头,只需设置 `responseHeaders` 选项到 `true` 当唤作理想方法时. 以下是说明如何实现这一目标的例子:

```javascript
const options = {
  responseHeaders: true
}
const [response, headers] = await platformClient.application("<APPLICATION_ID>").theme.getAllPages({theme_id: "<THEME_ID>"}, options);

console.log("[API RESPONSE]: ", response);
console.log("[RESPONSE HEADERS]: ", headers);
```

* * *

### 日志曲线

在控制台上打印所有网络呼叫的卷曲命令 `applicationClient` 或者说 `platformClient`,设置日志级别以调试.

```javascript
const {
  ApplicationClient,
} = require("fdk-client-javascript");

let applicationClient = new ApplicationClient({
  applicationID: "YOUR_APPLICATION_ID",
  applicationToken: "YOUR_APPLICATION_TOKEN",
  logLevel: "debug"
});

let response = await applicationClient.theme.getAppliedTheme(); 
console.log("Active Theme: ", response.information.name);
```

上述代码将登录控制台的卷轴命令

```bash
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.36.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
Active Theme: Emerge
```

* * *

### 类型脚本

fdk-client-javascript包括了Typescript定义.

```typescript
import { ApplicationClient } from "fdk-client-javascript";
```

## 常见问题

### @gofynd/fdk-client-javascript 是什么？

\[吉他\]

### 如何安装 @gofynd/fdk-client-javascript？

在项目目录运行 npm install @gofynd/fdk-client-javascript，或使用 pnpm add / yarn add / bun add。

### @gofynd/fdk-client-javascript 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gofynd/fdk-client-javascript 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @gofynd/fdk-client-javascript 可以商用吗？

@gofynd/fdk-client-javascript 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gofynd/fdk-client-javascript 的下载量有多少？

根据 npm 官方下载统计，@gofynd/fdk-client-javascript 在 2026/10/17 – 2026/11/15 这 30 天内被下载 10,118 次，日均约 337 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gofynd/fdk-client-javascript 还在维护吗？

最新版本 3\.36\.0 发布于 2026/10/23（24 天前）；至今共发布 162 个版本，其中过去 12 个月发布了 29 个；首次发布于 2023/01/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

