用于 Typescript 和 Javascript 的 Changelly Fiat API SDK

这个SDK允许你和 变化中的菲亚特 API 在JavaScript和TypeScript中。 JavaScript开发者会找到一个功能齐全的库,其功能是方便的,可以将Tangelly fiat API内的所有方法调用自动化;使用TypeScript的开发者会找到对严格类型的丰富定义.

使用这个 SDK

1. 联合国 变化中的网站 如果你还没有账户的话.
2. 给我们写信 [email protected] (英语) 以获取 API 密钥。 指定您在 Changelly 网站上注册的电子邮件 .

说明. 如果你对SDK的整合有任何疑问, 不要犹豫,给我们写信 [email protected] (英语)。 。 。 .

这个教程会引导您通过创建项目的基础, 使用 Changelly Fiat API SDK .

1. 首先运行以下命令以创建默认 package.json 文件 :

> npm init --y

2. 如果您选择使用TypeScript,现在可以在此工程中添加TypeScript特性. 以下步骤将安装 TypeScript, 创建 tsconfig.json 文件,并获取大多数节点JS内置类型:

> npm install typescript
> npx tsc --init
> npm install -D @types/node

3. 通过节点包管理器将 Changelly Fiat API SDK 添加到您的项目中 :

> npm install @changelly/fiat-api-sdk-node

4. 设置环境变量的 API 密钥, 如 CHANGELLY_PRIVATE_KEY 财务报告和审定财务报表 CHANGELLY_PUBLIC_KEY 以便它不会致力于源控制.
5. 创建基本 index.ts 您创建 Changelly Fiat API 客户端的项目的文件 :

import { ChangellyFiatClient } from "@changelly/fiat-api-sdk-node";

const client = new ChangellyFiatClient({
  privateKey: process.env["CHANGELLY_PRIVATE_KEY"],
  publicKey: process.env["CHANGELLY_PUBLIC_KEY"],
});

6. 拨打API并检查结果 :

const providers = await client.getProviderList();
const currencies = await client.getCurrencyList();

console.log({ providers, currencies });

7. 更多信息见 文档。 。 。 .

API 参考

千变万化的密钥

Changelly Fiat API Node.js SDK类.

构造器

创建 ChangellyFiatClient 实例 .

new ChangellyFiatClient(
  params: ChangellyFiatClientParams
): ChangellyFiatClient

参数

• 段落数字 : 千变万化的图像

回返 千变万化的密钥

方法

• 签名
• 校验命令回调符号
• 获取提供列表
• 获取紧急列表
• 获得国家可操作性列表
• 获取输出
• 创建命令
• 验证钱包地址

签名

构建 X- Api- 签名 .

buildSignature(
  params: ChangellyBuildSignatureParams
): string;

参数

• 段落数字 : Changelly 构建签名程序

回返 字符串 – 变形X- Api 签名

校验命令回调符号

验证命令 X- Callback- Signal.

validateOrderCallbackSignature(
  signature: string,
  orderId: string
): boolean;

参数

• 签名数字 : 字符串 ——串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行串行.
• 顺序数字 : 字符串 - 更改订单标识符.

回返 布尔 - 回调签名有效吗?

获取提供列表

获取On-Ramp供应商的扩展信息给用户.

getProviderList(
  config?: AxiosRequestConfig
): Promise<ChangellyGetProviderListResponse[]>;

参数

• (可选) 配置数字 : Axios 请求配置

回返 承诺 <Changelly 获取保护列表响应[ >]

获取紧急列表

获取所支持的密码和fiat货币列表.

getCurrencyList(
  params?: ChangellyGetCurrencyListParams,
  config?: AxiosRequestConfig
): Promise<ChangellyGetCurrencyListResponse[]>;

参数

• (可选) 段落数字 : Changelly 获取当前列表
• (可选) 配置数字 : Axios 请求配置

回返 承诺 <变化中获取紧急响应[ >]

获得国家可操作性列表

获取支持加密购买的国家列表 .

getCountryAvailabilityList(
  params?: ChangellyGetCountryAvailabilityParams,
  config?: AxiosRequestConfig
): Promise<ChangellyGetCountryAvailabilityResponse[]>;

参数

• (可选) 段落数字 : Changelly Get Country AvailableParams 变形器 变形器 变形器 变形器 变形器 变形器 变形器 变形器
• (可选) 配置数字 : Axios 请求配置

回返 承诺 <Changelly Get Country Available Response (英语:Changlly Get Country Available Response) 变相得到国家应答[ >]

获取输出

获取 On-Ramp 供应商的购买报价列表 .

getOffers(
  params: ChangellyGetOffersParams,
  config?: AxiosRequestConfig
): Promise<ChangellyGetOffersResponse[]>;

参数

• 段落数字 : Changelly Get Offers-Params (英语)
• (可选) 配置数字 : Axios 请求配置

回返 承诺 <变化中获取任务响应[ >]

创建命令

创建加密定购单并获得重定向URL到购买页面. 如果请求中未提供任何可选参数,则会在响应中以"null"值返回.

createOrder(
  data: ChangellyCreateOrderParams,
  config?: AxiosRequestConfig
): Promise<ChangellyCreateOrderResponse>;

参数

• 数据数字 : 变化中生成命令
• (可选) 配置数字 : Axios 请求配置

回返 承诺 <变化中生成命令响应[ >]

验证钱包地址

检查给定的钱包地址和(可选)额外ID对给定的货币是否有效 .

validateWalletAddress(
  data: ChangellyValidateWalletAddressParams,
  config?: AxiosRequestConfig
): Promise<ChangellyValidateWalletAddressResponse>;

参数

• 数据数字 : 变化中ValideWallet AddressParams (英语)
• (可选) 配置数字 : Axios 请求配置

回返 承诺 <ChangellValidateWallet 地址地址响应[ >]

类型

• 千变万化的图像
• Changelly 构建签名程序
• Changelly 获取保护列表响应
• Changelly 获取当前列表
• 变化中获取紧急响应
• Changelly Get Country AvailableParams 变形器 变形器 变形器 变形器 变形器 变形器 变形器 变形器
• Changelly Get Country Available Response (英语:Changlly Get Country Available Response) 变相得到国家应答
• Changelly Get Offers-Params (英语)
• 变化中获取任务响应
  • 成功提议
  • 失败的报价
• 变化中生成命令
• 变化中生成命令响应
• 变化中ValideWallet AddressParams (英语)
• ChangellValidateWallet 地址地址响应
• 变化状态
• Changelly Payment MethodOffer 游戏
• 变化中的错误细节

千变万化的图像

interface ChangellyFiatClientParams {
  publicKey: string;
  privateKey: string;
  callbackPublicKey?: string;
  baseUrl?: string;
}

属性

Changelly 构建签名程序

interface ChangellyBuildSignatureParams {
  baseUrl?: string;
  pathname: ChangellyRequestUrl | string;
  params?:
    | ChangellyGetCurrencyListParams
    | ChangellyGetCountryAvailabilityParams
    | ChangellyGetOffersParams;
  data?: ChangellyCreateOrderParams | ChangellyValidateWalletAddressParams;
}

属性

Changelly 获取保护列表响应

interface ChangellyGetProviderListResponse {
  code: ChangellyProvider;
  name: string;
  trustPilotRating: string;
  iconUrl: string;
}

属性

Changelly 获取当前列表

interface ChangellyGetCurrencyListParams {
  type?: ChangellyCurrency;
  providerCode?: ChangellyProvider;
}

属性

变化中获取紧急响应

interface ChangellyGetCurrencyListResponse {
  ticker: string;
  name: string;
  type: ChangellyCurrency;
  extraIdName: string | null;
  iconUrl: string;
  precision: string;
}

属性

Changelly Get Country AvailableParams 变形器 变形器 变形器 变形器 变形器 变形器 变形器 变形器

interface ChangellyGetCountryAvailabilityParams {
  providerCode?: ChangellyProvider;
}

属性

Changelly Get Country Available Response (英语:Changlly Get Country Available Response) 变相得到国家应答

interface ChangellyGetCountryAvailabilityResponse {
  code: ChangellyProvider;
  name: string;
  states?: ChangellyState[];
}

属性

Changelly Get Offers-Params (英语)

interface ChangellyGetOffersParams {
  providerCode?: ChangellyProvider;
  externalUserId?: string;
  currencyFrom: string;
  currencyTo: string;
  amountFrom: string;
  country: string;
  state?: string;
  ip?: string;
}

属性

变化中获取任务响应

可以成功而失败.

成功提议

interface Offer {
  providerCode: ChangellyProvider;
  rate: string;
  invertedRate: string;
  fee: string;
  amountFrom: string;
  amountExpectedTo: string;
  paymentMethodOffers: ChangellyPaymentMethodOffer[];
}

属性

失败的报价

interface Offer {
  providerCode: ChangellyProvider;
  errorType:
    | ChangellyErrorType.Timeout
    | ChangellyErrorType.Unavailable
    | ChangellyErrorType.Limits
    | ChangellyErrorType.Country
    | ChangellyErrorType.State
    | ChangellyErrorType.Currency
    | ChangellyErrorType.PaymentMethod
    | ChangellyErrorType.InvalidOffer;
  errorMessage: string;
  errorDetails: ChangellyErrorDetails[] | null;
}

属性

变化中生成命令

type ChangellyCreateOrderParams = {
  externalOrderId: string;
  externalUserId: string;
  providerCode: ChangellyProvider;
  currencyFrom: string;
  currencyTo: string;
  amountFrom: string;
  country: string;
  state?: string;
  ip?: string;
  walletAddress: string;
  walletExtraId?: string;
  paymentMethod?: ChangellyPaymentMethod;
  userAgent?: string;
  metadata?: Record<string, unknown>;
};

属性

变化中生成命令响应

interface ChangellyCreateOrderResponse {
  redirectUrl: string;
  orderId: string;
  externalUserId: string;
  externalOrderId: string;
  providerCode: ChangellyProvider;
  currencyFrom: string;
  currencyTo: string;
  amountFrom: string;
  country: string;
  state: string | null;
  ip: string | null;
  walletAddress: string;
  walletExtraId: string | null;
  paymentMethod: ChangellyPaymentMethod | null;
  userAgent: string | null;
  metadata: Record<string, unknown> | null;
  createdAt: string;
}

属性

变化中ValideWallet AddressParams (英语)

interface ChangellyValidateWalletAddressParams {
  currency: string;
  walletAddress: string;
  walletExtraId?: string;
}

属性

ChangellValidateWallet 地址地址响应

interface ChangellyValidateWalletAddressResponse {
  result: boolean;
  cause: "walletAddress" | "walletExtraId" | null;
}

属性

变化状态

interface ChangellyState {
  code: string;
  name: string;
}

属性

Changelly Payment MethodOffer 游戏

interface ChangellyPaymentMethodOffer {
  amountExpectedTo: string;
  method: ChangellyPaymentMethod;
  methodName: string;
  invertedRate: string;
  fee: string;
}

属性

变化中的错误细节

interface ChangellyErrorDetails {
  cause: string;
  value: string;
}

属性

编号

• 变化中请求 Url
• 变化中提供
• 变化中
• 变化中的错误类型
• 千变万化支付方法

变化中请求 Url

enum ChangellyRequestUrl {
  ProvderList = "/v1/providers",
  CurrencyList = "/v1/currencies",
  CountryAvailability = "/v1/available-countries",
  GetOffers = "/v1/offers",
  CreateOrder = "/v1/orders",
  ValidateWalletAddress = "/v1/validate-address",
}

成员

• 演示列表数字 : “/v1/提供者”
• 货币列表数字 : "/v1/曲线"
• 脆弱性数字 : “/v1/可用国家”
• 获取输入数字 : "/v1/offers" (韩语)
• 创建命令数字 : "/v1/订单"
• 校验钱包地址数字 : "/v1/验证地址"

变化中提供

enum ChangellyProvider {
  Moonpay = "moonpay",
  Banxa = "banxa",
  Wert = "wert",
}

成员

• 月薪数字 : "月薪"(月薪)
• 班克萨数字 : "班克萨"
• 脏数字 : "废物"

变化中

enum ChangellyCurrency {
  Crypto = "crypto",
  Fiat = "fiat",
}

成员

• 密码数字 : 催眠术
• 菲亚特数字 : "虚构"

变化中的错误类型

enum ChangellyErrorType {
  Validation = "validation",
  Timeout = "timeout",
  Unavailable = "unavailable",
  Limits = "limits",
  Country = "country",
  State = "state",
  Currency = "currency",
  PaymentMethod = "paymentMethod",
  InvalidOffer = "invalidOffer",
  Unauthorized = "unauthorized",
  TooManyRequests = "tooManyRequests",
  InternalServerError = "internalServerError",
}

成员

• 验证数字 : "验证" ——验证错误.
• 超时数字 : "超时" 向提供者提出的请求未在规定时间内完成.
• 无法获取数字 : "没有" ——请求在提供者端失败.
• 限制数字 : "限制" ——指定的实收金额低于或超过有色货币的最高价值.
• 国家数字 : "国家" - 指定国家不由提供者支持.
• 状态数字 : "状态" ——向美国索取报价,但没有提供州参数.
• 货币数字 : "货币" ——指定货币对不由提供者支持.
• 支付方法数字 : "支付方法" - 提供者不支持指定的支付方法.
• 无效操作数字 : "无效的Offer" ——On-Ramp供应商退回无效报价.
• 未经授权数字 : 未经批准 — 未经授权的错误
• 太多请求数字 : "很多请求" — 太多请求出错
• 内务人员错误数字 : "内部服务员" — 内部服务器出错

千变万化支付方法

enum ChangellyPaymentMethod {
  Card = "card",
  Sepa = "sepa_bank_transfer",
}

成员

• 纸牌数字 : "卡"(卡)
• 塞帕语Name数字 : "sepa bank transfer" (银行转让)