一、产品介绍
可部署至「本地服务器」或「专有云服务器」的WEB API服务,支持身份证号段归属查询及格式校验服务,在专有网络环境下部署应用,保障数据私密性,提供一键启动软件部署包私有化方案。详情可点击: https://www.juhe.cn/papi/idcard 进行了解。
二、使用教程
下载部署包
- 通过聚合官方网站下载对应的MacOS版本私有部署包(*目前暂支持64位系统),比如下载的压缩包版本为:
jidcard-1.0.0-macos11-x86_64.tar.gz
,将压缩包上传至服务器。 - 进入压缩包所在的文件目录,通过
tar
命令解压,比如所在目录为:/Users/juhe/Downloads/
# 进入目录
cd /Users/juhe/Downloads/
# 解压
tar zxvf jidcard-1.0.0-macos11-x86_64.tar.gz
# 进入程序目录
cd jidcard-1.0.0-macos11-x86_64
解压私有部署包后,进入程序目录,可以看到如下文件:
文件目录介绍:
-- data/idcard_1.0.0.json 为数据文件 (当然您也可以直接进行数据修改、更新或封装成其他程序服务)
-- docs/index.html 为接口调用基本说明文档
-- server 为服务主程序
启动API服务
1. 进入程序目录
cd jidcard-1.0.0-macos11-x86_64
2. 启动服务
./server
3. 服务默认的端口为8369
,如果该端口被占用或需自定义端口,启动时可以使用--port
参数指定端口,例如:
./server --port 8368
4. 如需系统后台不挂断地运行,可以使用nohup
命令启动服务,例如:
nohup ./server 2>&1 &
您也可以使用其他的比如supervisor等管理工具实现。
如启动结果如下图显示, 说明启动服务成功!
调用API服务
本地API服务启动成功后,您即可通过提供的API地址进行接口请求了。
比如上一步示例启动的服务 (具体服务的IP和端口以实际为准)
,您可以通过:
接口文档地址
(浏览器访问,查看完整接口文档说明)
http://127.0.0.1:8369/docs
或
http://10.0.49.15:8369/docs
接口请求地址
API接口地址:
http://127.0.0.1:8369/query
或
http://10.0.49.15:8369/query
API接口参数简易参照 (GET请求接口,进行调用):
API接口请求参数示例:
# GET参数中idcard的值即为需要查询的身份证号
http://10.0.49.15:8369/query?idcard=330328199001021100
接口响应内容示例:
{
"code": 0,
"msg": "success",
"result": {
"sex": "女",
"age": "31",
"birthday": "1990年01月02日",
"address": "浙江省温州市文成县",
"is_valid": "2",
"valid_msg": "身份证号校验位错误"
}
}
*具体接口返回格式及说明,请参照接口文档