SmsCode 微服务使用教程

SmsCode 微服务使用教程

smscode 专为需要【手机短信验证码】使用场景而设计的微服务(Micro service)，如：用户注册、找回密码、用户身份验证、验证码登录等等。支持阿里大于(短信)、云通信、互亿无线 项目地址: https://gitcode.com/gh_mirrors/sms/smscode

1. 项目介绍

SmsCode 是一个专为手机短信验证码使用场景设计的微服务。它支持用户注册、找回密码、用户身份验证、验证码登录等功能。该项目基于 Go 语言开发，具有高性能、易部署的特点，并且支持多种短信通道，如阿里大于、云通信、互亿无线等。

2. 项目快速启动

环境准备

• 安装 Go 语言环境（版本 1.5+）
• 确保已配置 Go 模块支持

获取项目代码

go get -u github.com/xluohome/smscode

编译与运行

cd $GOPATH/src/github.com/xluohome/smscode
./build && ./smscode

Docker 部署

• 编写 Dockerfile

FROM golang:1.15
RUN go mod download
COPY . /smscode
WORKDIR /smscode
RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o smscode .
CMD ["./smscode"]

• 构建镜像

docker build -t smscode .

• 运行容器

docker run -p 8080:8080 smscode

3. 应用案例和最佳实践

配置文件

项目使用 conf.yaml 作为配置文件，以下是配置文件示例：

bind: 0.0.0.0:8080
timezone: PRC
timeout: 5
vendors:
  alidayu:
    appkey: 20315570
    appSecret: 87hfgfg75775765787878
    issendbox: false
  yuntongxun:
    AccountSid: 8a48b55e434514c9c31921a039b
    AccountToken: 61434dc2b245435eadf82d381fa3f
    AppId: aaf98f8fsdafd2678c9d07875040f
    SoftVersion: 2013-12-26
    RestURL: https://app.cloopen.com:8883
# 更多配置...

发送验证码

curl -X POST http://localhost:8080/send -d "service=register&mobile=15336860197"

验证验证码

curl -X POST http://localhost:8080/checkcode -d "service=register&mobile=15336860197&code=123456"

设置用户UID

curl -X POST http://localhost:8080/setuid -d "service=register&mobile=15336860197&uid=123456"

删除用户UID

curl -X POST http://localhost:8080/deluid -d "service=register&mobile=15336860197&uid=123456"

信息查询

curl -X POST http://localhost:8080/info -d "service=register&mobile=15336860197"

4. 典型生态项目

SmsCode 微服务可以与各种业务系统整合，为用户提供手机短信验证功能。以下是一些典型的生态项目：

• 用户身份验证系统
• 社交登录服务
• 电商平台注册验证
• 金融服务平台身份认证

通过整合 SmsCode，这些项目可以简化验证流程，提高用户体验，并确保账户安全。

smscode 专为需要【手机短信验证码】使用场景而设计的微服务(Micro service)，如：用户注册、找回密码、用户身份验证、验证码登录等等。支持阿里大于(短信)、云通信、互亿无线 项目地址: https://gitcode.com/gh_mirrors/sms/smscode