sdk - api (英语)

此库包含一个生成的 TypeScript 客户端 打开。它可用于任何Javascript/Typescript项目.

有关当前 REST API 的文档可参见: https://动态.xyz/docs/api-参考/概览

APIs 密码

• 斯德克阿皮语Name
  • 这些是专供 动态反应 SDK。这些API的几个终点需要: 日本 创建于 verify 或者说 signin 端点,是SDK环境中用户特有的. 这些API一般被用在一个客户网站或前端来增强客户的经验.
• 盘片 API
  • 这些端点被一个组织的管理人员用来更新网站设置和管理环境用户. 这些API需要 API 令牌 适用于特定环境。 这些API一般被用在一个客户端后端上,用来管理其所有用户的数据,并做出相应的设置变化来影响一个站点的所有用户.
  • 在仪表板API中最常用的API是: UsersApi
  • 您可以读取其他所有可用的 API 这里

实例

本节举例说明如何使用 SDKApi。这与使用其他可用的生成的API类似,例如 UsersApi 或者说 ExportsApi等 (中文(简体) ).

斯德克阿皮语Name

初始化一个新实例 SDKApi 类 :

import { Configuration, SDKApi } from '@dynamic-labs/sdk-api';

const sdkApi = (jwt: string) => {
  const settings = {
    basePath: ApiEndpoint.getBaseUrl(),
    headers: {
      'Content-Type': 'application/json',
    },
  };
  settings.headers.Authorization = `Bearer ${jwt}`;
  return new SDKApi(new Configuration(settings));
};

这样你就能用到它了

const response = await sdkApi(jwt).updateSelf({
  environmentId,
  userFields: fields, // { alias, firstName, lastName, username, ... }
});
// do something with the response