volunteer-certificate

安装并启动项目:

Dependency Installation

python3 -m pip install --user -r requirements.txt

Prepare database file

You need to put data.json in the project root directory. You can copy it from sample data. Extra data can be added using frontend admin webpage.

cp config/data.json ./

Edit config file

Optionally you can make a file email.json from the template config/email.json.config and edit the configuration; make a file org.json from the template config/org.json.config and edit the configuration.

Start the server in development mode

To start the server, run the following command in project root directory

python3 app.py

To test whether the server works, you can use curl

curl http://localhost:5000/api/getUserInfo?token=token0

Startup shell(production mode)

Install gunicorn first by python3 -m pip install --users gunicorn. Also make sure the user you used to deploy the app does not have sudo privilege for security reason.

You can use shell script to start or stop the application

cd volunteer-certificate
# start up
./bin/start.sh

# shutdown
./bin/stop.sh

# restart
./bin/restart.sh

The convenient script will run the wsgi server in backend, which listens localhost:5000. Finally you need to configure your nginx proxy to forward request to localhost:5000.

	location / {
		# First attempt to serve request as file, then
		# as directory, then fall back to displaying a 404.
		proxy_pass http://localhost:5000/;
		proxy_redirect     off;
	}

志愿者证书

一、前端接口

所有接口按如下格式返回，只有code===0时表示接口处理正确，其余情况前端提示可参考具体code值和message内容

{
  "code": 0,
  "data": null,
   "message": "success"
}

错误值

code	错误
1	缺少name字段
2	token无效
3	已成功发送过邮件
4	制作图片或发送邮件时出错

1.通过token获取用户信息

类型：get请求

/api/getUserInfo?token=dsfasgdafgaggsdagdsg

成功：

{
  "code": 0,
  "data": {
      "email":"xxxx@yeah.net",                  //邮箱,在页面不可以编辑
      "name":"xxxxx",                           //称呼
   },
   "message": "success"
}

失败

{
    "code": 1,
    "data": "",
    "message": "user not in server"
}

2. 用户提交信息：

/api/submitUserInfo

入参

{
    "token":"dsfasgdafgaggsdagdsg",  // token
    "name":"new namw"                //修改后的称呼
}

结果同 1.

3.添加新名字（管理员）

/api/addUserData 入参

{
    "token":"abc",  // admin-token
    "email":["foo@example.org"]
}

结果同 1.

4. Upload template image

/api/uploadImage

Required Header:

Token: abc
Content-Type: multipart/form-data

name="template" data="image raw content"

Json response, same format as 1.

5. Update configuration

/api/updateOrgConfig

{
    "token":"abc",  // admin-token
    "name": "org_name",
    "website": "org_website",
    "name_horizontal_pos": "name_horizontal_pos",
    "name_vertical_pos": "name_vertical_pos",
    "username": "org_email_username",
    "password": "org_email_password"
}

Json response, same format as 1.

6. Email query

/api/email

{
   "token":"abc",
   "action": "send", // or query
}

Json response, same format as 1.

二、数据表

字段	类型	名称	描述
id	整型	自增主键
token	字符型	验证码	因为没有用户权限系统，所以用token作为本次活动权限标识，用uuid算法生成唯一串
name	字符型	称呼
email	字符型	邮箱
number	字符型	证书编号	在数据源导入时候已经生成
status	整型	状态	0：初始化 1 已经发送提醒邮件 2：用户已提交 3：图片已经生成 4：证书邮件已发出

三、数据流

第1步，活动组织者提交证书图片模板和相关参数

第2步，活动组织者提交组织相关信息、邮箱相关信息

第3步，活动组织者提交志愿者邮箱列表

第4步. 后端项目批量给用户邮箱发邮件

将为当前邮箱状态为0的邮箱生成token，并更新本行记录的token为新token 发送邮件给志愿者，每个邮件的关键内容为一个带有 token 的链接，比如： https://community.wuhan2020.org.cn/zh-cn/certification/index.html?token=dsfasgdafgaggsdagdsg

邮件发送完毕后，状态置为 1

第5步. 用户打开网页

调用接口1.通过token获取用户信息展示数据

第6步. 用户修改并提交数据，证书发到用户邮箱

调用接口**2.用户提交信息：**提交到后端

第7步. 后端服务生成图片，发送邮件

后端更新本行记录：name 为新称呼，状态置为 2

调用生成图片接口，更新pic_url，更新status 为3

调用发邮件接口 更新status 为4

状态2后每一次断掉可以重试

第8步，活动组织者通过指定接口查询用户邮件发送的状态

比如还有多少封邮件没发完