使用指南
适用平台:陕西省重大疾病防控与大健康数据共享平台(REDCap 17.4.5) 维护单位:西安交通大学公共卫生学院流行病与卫生统计学系 读者:已获账号、具备项目设计权限的项目负责人与数据管理员 更新日期:2026-10-09
登录后打开您的项目。西安交通大学公共卫生学院维护的现网是 REDCap 17.4.5。脚本要从项目里读数据或写回数据时,用的是您自己的 API 令牌,不是登录密码。每人在每个项目里只有一个,一长串 32 位字符。怎么用它拉数据,见 数据导出实用指南。这篇只做三件事:申请、放好、作废。
1. 适用场景
- 统计脚本要按固定字段重复取数,网页导出不够用。
- 换了电脑或换了经手人,旧令牌必须停掉。
- 令牌出现在聊天、邮件或截图里,需要立刻换一把。
只是临时看几条记录,用报表和网页导出即可,不必申请令牌。
2. 操作步骤
- 打开 https://www.wcrcnet.cn/redcap/ 登录。页脚是 REDCap 17.4.5。
- 在 用户权限 里给这个账号勾上 API(导出)。脚本要写回记录时才另外勾 API(导入)。左侧没有 API,就是这项还没开。权限怎么改,见 43 用户权限与自定义角色。
- 左侧点 API。还没有令牌时,点 生成API令牌。页面若写成 请求API令牌,提交后等管理员开通,开通前脚本连不上。
- 令牌只在这一页显示给您自己。接口地址是
https://www.wcrcnet.cn/redcap/api/。 - 在您自己的电脑上把它放进用户环境变量,变量名用
REDCAP_API_TOKEN。脚本里只读这个变量。不要把令牌写进脚本文件、幻灯片、截图、微信或邮件。 - 人员离组,或怀疑别人看见了令牌:回到 API,删除它。确认框是 确实要删除API令牌?。还要继续用脚本时,再按提示重新生成,确认框是 确实要重新生成API令牌?。旧的那一把马上失效,脚本里的环境变量要改成新的。
3. 注意与权限
- 令牌的能力等于这个账号在本项目里的权限。只开了 API(导出) 的令牌不能改数据。人在某个 44 数据访问组 里时,这把令牌也只能碰到该组的记录。
- 本篇要的是项目级 32 位令牌。64 位的超级令牌由管理员另行发放,用来通过接口新建项目,不要在项目的 API 页上找。
- 别人若查看了您的令牌,系统会记下这次查看并给您发邮件。收到这样的邮件,按上一步删除并重新生成。
- 用本平台数据写论文,致谢按登录页上的文字抄。
4. 常见问题
左侧没有 API?
用户权限 里还没有 API(导出) 或 API(导入)。加上之后刷新项目,再看左侧。
点了请求,页面没有立刻给出令牌?
这一次走的是管理员审批。等开通通知,不要反复申请多把。每人每项目只有一个。
脚本报令牌不对,网页却能登录?
登录密码和令牌不是同一个东西。到 API 页核对当前这把是否还在;若刚重新生成过,把环境变量改成新值,再开一个新的终端运行脚本。
能不能把老师的令牌复制到学生电脑上?
不能。各用各的账号申请。老师离组时删除老师那一把,学生用自己的。
5. 建议记住的几条
- 用户权限 勾 API(导出),再打开左侧 API,点 生成API令牌 或 请求API令牌。
- 令牌放进环境变量
REDCAP_API_TOKEN,不写进文件和聊天。 - 离组或泄露后,在 API 页删除;还要用就重新生成,并换掉电脑上的旧值。
- 取数写法看 数据导出实用指南。
本篇为平台「REDCap使用指南」系列,按手册页体例编写。查看全部指南
陕公网安备61011302000964号
扫码关注公众号