SDK 接入-轻识

Java SDK

安装

Uni Java SDK 使用 Maven 托管，可从公共 Maven 仓库中获得。

在项目中使用以下代码添加 Maven 依赖：


    com.apistd.uni
    uni-sdk
    0.0.4

或使用 Gradle：

implementation "com.apistd.uni:uni-sdk:0.0.4"

使用示例

以下示例展示如何使用 Uni Java SDK 快速调用服务。

发送短信


import com.apistd.uni.Uni;
import com.apistd.uni.UniException;
import com.apistd.uni.UniResponse;
import com.apistd.uni.sms.UniSMS;
import com.apistd.uni.sms.UniMessage;

import java.util.HashMap;
import java.util.Map;

public class Example {
    public static String ACCESS_KEY_ID = "your access key id";
    private static String ACCESS_KEY_SECRET = "your access key secret";

    public static void main(String[] args) {
        // 初始化
        Uni.init(ACCESS_KEY_ID, ACCESS_KEY_SECRET); // 若使用简易验签模式仅传入第一个参数即可

        // 设置自定义参数 (变量短信)
        Map templateData = new HashMap();
        templateData.put("code", "6666");

        // 构建信息
        UniMessage message = UniSMS.buildMessage()
            .setTo("your phone number")
            .setSignature("UniSMS")
            .setTemplateId("login_tmpl")
            .setTemplateData(templateData);

        // 发送短信
        try {
            UniResponse res = message.send();
            System.out.println(res);
        } catch (UniException e) {
            System.out.println("Error: " + e);
            System.out.println("RequestId: " + e.requestId);
        }
    }
}

Go SDK

安装

Uni Go SDK 提供 Go Module，可从公共 Github 仓库中获得。

在项目中添加 uni-go-sdk 作为依赖：

go get github.com/apistd/uni-go-sdk

使用示例

以下示例展示如何使用 Uni Go SDK 快速调用服务。

发送短信


package main

import (
    "fmt"
    unisms "github.com/apistd/uni-go-sdk/sms"
)

func main() {
    // 初始化
    client := unisms.NewClient("your access key id", "your access key secret") // 若使用简易验签模式仅传入第一个参数即可

    // 构建信息
    message := unisms.BuildMessage()
    message.SetTo("your phone number")
    message.SetSignature("UniSMS")
    message.SetTemplateId("login_tmpl")
    message.SetTemplateData(map[string]string {"code": "6666"}) // 设置自定义参数 (变量短信)

    // 发送短信
    res, err := client.Send(message)
    if (err != nil) {
        fmt.Println(err)
        return
    }
    fmt.Println(res)
}

Node.js SDK

安装

Uni Node.js SDK 使用 npm 托管，可从公共 npm 仓库中获得。

在项目中添加 unisms 作为依赖：

npm i unisms

或使用 Yarn：

yarn add unisms

使用示例

以下示例展示如何使用 Uni Node.js SDK 快速调用服务。

发送短信


import UniSMS from 'unisms'

// 初始化
const client = new UniSMS({
  accessKeyId: 'your access key id',
  accessKeySecret: 'your access key secret',  // 若使用简易验签模式请删除此行
})

// 发送短信
client.send({
  to: 'your phone number',
  signature: 'UniSMS',
  templateId: 'login_tmpl',
  templateData: {
    code: 8888,
  },
})
  .then(ret => {
    console.info('Result:', ret)
  })
  .catch(e => {
    console.error(e)
  })

如若遇到以下报错：

SyntaxError: Cannot use import statement outside a module

或报错：

TypeError: UniSMS is not a constructor

可以调整引用的方式为：

// import UniSMS from 'unisms'
const UniSMS = require('unisms').default

Python SDK

安装

Uni Python SDK 使用 PyPI 托管，可从公共 PyPI 仓库中获得。

在项目中使用 pip 添加 unisms 作为依赖：

pip install unisms

使用示例

以下示例展示如何使用 Uni Python SDK 快速调用服务。

发送短信


from unisdk.sms import UniSMS
from unisdk.exception import UniException

# 初始化
client = UniSMS("your access key id", "your access key secret") # 若使用简易验签模式仅传入第一个参数即可

try:
  # 发送短信
  res = client.send({
    "to": "your phone number",
    "signature": "UniSMS",
    "templateId": "login_tmpl",
    "templateData": {
      "code": 7777
    }
  })
  print(res.data)
except UniException as e:
  print(e)

PHP SDK

安装

Uni PHP SDK 使用 Packagist 托管，可从公共 Packagist 仓库中获得。

使用 Composer 在项目中添加 apistd/uni-sdk 作为依赖：

composer require apistd/uni-sdk

使用示例

以下示例展示如何使用 Uni PHP SDK 快速调用服务。

发送短信


use Uni\Common\UniException;
use Uni\SMS\UniSMS;

// 初始化
$client = new UniSMS([
  'accessKeyId' => 'your access key id',
  'accessKeySecret' => 'your access key secret' // 若使用简易验签模式请删除此行
]);

// 发送短信
try {
  $resp = $client->send([
    'to' => 'your phone number',
    'signature' => 'UniSMS',
    'templateId' => 'login_tmpl',
    'templateData' => [
      'code' => 7777
    ]
  ]);
  var_dump($resp->data);
} catch (UniException $e) {
  print_r($e);
}