开始使用 PayPal 服务器 SDK

导言

重要说明

• 可用特性 : 这个SDK目前只包含5个PayPal的API端点. 今后将增加更多的终点和功能.

资料

PayPal服务器SDK提供集成访问PayPal REST APIs. API端点分为不同的控制器:

• 命令控制器 : 命令 API v2
• 付款主计长: 付款 API v2
• 默认控制器 : 支付方法 Tokens API v3 在美国才有.
• 交易搜索控制器 : 交易搜索 API v1
• 订阅控制器 : 订阅 API v1

安装软件包

从项目目录中运行以下命令以从 npm 安装软件包 :

npm install @paypal/[email protected]

补充软件包详情见 @paypal/[email protected]的Npm页面。 。 。 .

初始化 API 客户端

说明: 可找到客户端的文档 在这里.

API 客户端可配置以下参数:

API客户端可初始化如下:

基于代码的客户端初始化

import { Client, Environment, LogLevel } from '@paypal/paypal-server-sdk';

const client = new Client({
  clientCredentialsAuthCredentials: {
    oAuthClientId: 'OAuthClientId',
    oAuthClientSecret: 'OAuthClientSecret'
  },
  timeout: 0,
  environment: Environment.Sandbox,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

基于配置的客户端初始化

import * as path from 'path';
import * as fs from 'fs';
import { Client } from '@paypal/paypal-server-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

见 基于配置的客户端初始化 详细情况.

环境客户端初始化

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from '@paypal/paypal-server-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

见 环境客户端初始化 详细情况.

环境

SDK可以被配置为使用不同的环境来进行API调用. 可用的环境有:

字段

授权

此API使用以下认证方案.

• Oauth2 (OAuth 2 Client Credentials Grant)

API 列表

• 命令
• 付款
• 默认
• 交易搜索
• 订阅

SDK 基础设施

配置

• Httpclient 选项
• 重试配置
• 代理设置
• 基于配置的客户端初始化
• 环境客户端初始化
• 部分日志选项
• 部分请求日志选项
• 部分响应记录选项
• 锁定界面

HTTP 密码

• Http 请求

公用事业

• 回复
• 痛苦