SDK 使用说明

各语言 SDK 的安装、配置和基本使用示例

概述

闪链签官方提供 5 种主流语言的 SDK，封装了签名计算、请求构造、响应解析、错误处理、重试机制等通用逻辑。使用 SDK 可显著降低集成复杂度。

所有 SDK 的源代码均托管在 GitHub（github.com/flashsign），使用 MIT 开源协议。欢迎提交 Issue 和 Pull Request。

Java SDK

适用于 Java 8+ 环境，已发布至 Maven 中央仓库。

安装

XML

<dependency>
  <groupId>cn.flashsign</groupId>
  <artifactId>flashsign-sdk</artifactId>
  <version>1.2.0</version>
</dependency>

Gradle:

Groovy

implementation 'cn.flashsign:flashsign-sdk:1.2.0'

快速使用

Java

FlashSignClient client = new FlashSignClient.Builder()
    .appKey(System.getenv("FLASHSIGN_APP_KEY"))
    .appSecret(System.getenv("FLASHSIGN_APP_SECRET"))
    .env(Env.SANDBOX)
    .connectTimeout(10, TimeUnit.SECONDS)
    .readTimeout(30, TimeUnit.SECONDS)
    .build();

CreateContractResponse resp = client.createContract(request);

Python SDK

适用于 Python 3.8+ 环境，已发布至 PyPI。

安装

Bash

pip install flashsign-sdk

快速使用

Python

import os
from flashsign_sdk import FlashSignClient

client = FlashSignClient(
    app_key=os.environ['FLASHSIGN_APP_KEY'],
    app_secret=os.environ['FLASHSIGN_APP_SECRET'],
    env='sandbox'
)

resp = client.create_contract(contract_name='测试合同', ...)

Node.js SDK

适用于 Node.js 16+ 环境，已发布至 npm。支持 CommonJS 和 ESM 两种模块规范。

安装

Bash

npm install flashsign-sdk

快速使用

JavaScript

const FlashSignClient = require('flashsign-sdk');

const client = new FlashSignClient({
  appKey: process.env.FLASHSIGN_APP_KEY,
  appSecret: process.env.FLASHSIGN_APP_SECRET,
  env: 'sandbox',
});

const resp = await client.createContract({ contractName: '测试合同', ... });

Go SDK

适用于 Go 1.19+ 环境。

安装

Bash

go get github.com/flashsign/flashsign-sdk-go@latest

快速使用

client := flashsign.NewClient(flashsign.Config{
    AppKey:    os.Getenv("FLASHSIGN_APP_KEY"),
    AppSecret: os.Getenv("FLASHSIGN_APP_SECRET"),
    Env:       flashsign.EnvSandbox,
    Timeout:   30 * time.Second,
})

PHP SDK

适用于 PHP 8.0+ 环境，已发布至 Packagist。

安装

Bash

composer require flashsign/sdk

快速使用

PHP

use FlashSign\FlashSignClient;

$client = new FlashSignClient([
    'appKey'    => getenv('FLASHSIGN_APP_KEY'),
    'appSecret' => getenv('FLASHSIGN_APP_SECRET'),
    'env'       => 'sandbox',
]);

$resp = $client->createContract([...]);

合同签署接口

错误码参考

FlashSignClient client = new FlashSignClient.Builder() .appKey(System.getenv("FLASHSIGN_APP_KEY")) .appSecret(System.getenv("FLASHSIGN_APP_SECRET")) .env(Env.SANDBOX) .connectTimeout(10, TimeUnit.SECONDS) .readTimeout(30, TimeUnit.SECONDS) .build(); CreateContractResponse resp = client.createContract(request);

import os from flashsign_sdk import FlashSignClient client = FlashSignClient( app_key=os.environ['FLASHSIGN_APP_KEY'], app_secret=os.environ['FLASHSIGN_APP_SECRET'], env='sandbox' ) resp = client.create_contract(contract_name='测试合同', ...)

const FlashSignClient = require('flashsign-sdk'); const client = new FlashSignClient({ appKey: process.env.FLASHSIGN_APP_KEY, appSecret: process.env.FLASHSIGN_APP_SECRET, env: 'sandbox', }); const resp = await client.createContract({ contractName: '测试合同', ... });

client := flashsign.NewClient(flashsign.Config{ AppKey: os.Getenv("FLASHSIGN_APP_KEY"), AppSecret: os.Getenv("FLASHSIGN_APP_SECRET"), Env: flashsign.EnvSandbox, Timeout: 30 * time.Second, })

use FlashSign\FlashSignClient; $client = new FlashSignClient([ 'appKey' => getenv('FLASHSIGN_APP_KEY'), 'appSecret' => getenv('FLASHSIGN_APP_SECRET'), 'env' => 'sandbox', ]); $resp = $client->createContract([...]);