环境


PaymentKit SDK 在两种不同的模式下运行:生产模式用于处理真实交易,测试模式用于开发和测试。每个 API 请求都在这些环境之一中执行。默认情况下,SDK 在生产模式下初始化。

在开发期间使用测试模式来构建和验证您的集成至关重要,以免影响您的生产数据或产生真实费用。

以编程方式配置#

您可以使用 payment.environments 对象上提供的方法,在您的应用程序中动态切换生产模式和测试模式。这是管理环境的推荐方法。

设置生产模式#

要明确激活生产模式,请使用 setLivemode 方法。所有后续的 API 调用都将被定向到生产环境。

Setting Live Mode

import payment from '@blocklet/payment-js';

// 激活生产模式以进行生产交易
payment.environments.setLivemode(true);

设置 setLivemode(false) 等同于激活测试模式。

设置测试模式#

要为开发激活测试模式,请使用 setTestmode 方法。这可以确保所有 API 调用都在沙盒中进行,并且不会与您的生产数据交互。

Setting Test Mode

import payment from '@blocklet/payment-js';

// 激活测试模式以进行开发和测试
payment.environments.setTestmode(true);

设置 setTestmode(false) 等同于激活生产模式。

检查当前模式#

您可以通过编程方式检查 SDK 当前配置为使用哪种模式。

检查生产模式#

如果 SDK 当前处于生产模式,getLivemode 方法将返回 true

Checking Live Mode

import payment from '@blocklet/payment-js';

const isLive = payment.environments.getLivemode();
console.log(`SDK is in Live Mode: ${isLive}`);
// 预期输出:SDK is in Live Mode: true

检查测试模式#

如果 SDK 当前处于测试模式,getTestmode 方法将返回 true

Checking Test Mode

import payment from '@blocklet/payment-js';

payment.environments.setTestmode(true);

const isTest = payment.environments.getTestmode();
console.log(`SDK is in Test Mode: ${isTest}`);
// 预期输出:SDK is in Test Mode: true

工作原理#

一旦您设置了环境模式,所有通过 SDK 发出的后续 API 调用都将自动在请求中包含必要的 livemode 参数。这可以确保您的请求被路由到正确的 PaymentKit 环境,而无需在每次调用中都指定它。

Example API Call in Test Mode

import payment from '@blocklet/payment-js';

// 确保 SDK 处于测试模式
payment.environments.setTestmode(true);

console.log(`Operating in Test Mode: ${payment.environments.getTestmode()}`);

async function listTestCustomers() {
  try {
    // 此 API 调用将被发送到测试环境
    const customers = await payment.customers.list({ pageSize: 5 });
    console.log('Fetched test customers:', customers.data);
  } catch (error) {
    console.error('Error fetching test customers:', error.message);
  }
}

listTestCustomers();

正确管理您的环境是实现安全可靠集成的关键一步。现在您已经了解了如何配置 SDK,可以继续实施支付流程了。


接下来,深入了解实现常见支付工作流程的实用指南。