第一章 场景——数据就在那儿但用不了周二上午十点运营部门的小王在企业微信上发来一条消息张工我们这周要做客户复购率分析需要客户订单表、商品信息表和会员积分表字段清单我发你。附件里列了三十多个字段横跨CRMCustomer Relationship Management客户关系管理系统、ERPEnterprise Resource Planning企业资源计划系统和营销活动平台三个独立数据库。张工看了一眼消息心里默默列了一下工作清单先确认这三个系统的数据库只读账号还在不在、分别登录查询表结构和字段名是否匹配、找开发排期写一个RESTful API服务把数据整合出来、配一套鉴权机制防止未授权访问、再写一份接口文档给小王对接——这套流程走下来保守估计两天。而小王那边复购率分析的报告周五就要交。这个场景在多数企业的IT部门几乎每天都在上演。数据治理的前几步——梳理数据资源、采集汇聚、建仓存储、质量管控——都在推进但到了最后用出去这一步往往卡在了一个手工开发的瓶颈上。让业务部门直接连数据库是不现实的安全风险和权限管控都不可控把数据导出成Excel文件传递又丧失了实时性和可追溯性而走正规的API开发流程开发和测试周期又太长。APIApplication Programming Interface应用程序编程接口是当下最灵活的跨系统数据共享方式因为调用方不需要知道底层数据库的结构只需要按约定好的请求格式发送一个HTTP请求就能获取数据数据库账号密码完全不暴露。但手工开发API意味着每个数据共享需求都要经历需求评审→代码开发→安全审计→接口文档→联调测试的完整软件工程流程效率低、安全控制靠人工保障容易遗漏。龙石数据中台的数据共享模块在设计上正是针对这一瓶颈。它对应理、采、存、管、用五阶方法论中用促共享重应用阶段的核心能力——选择数据源后通过可视化界面编写SQLStructured Query Language结构化查询语言生成API再通过鉴权Authentication身份验证、IP白名单IP Allowlist来源限制、流量控制Rate Limiting调用量限制三道防线保障访问安全整个配置过程不需要写一行代码。第二章 前置条件——API发布前要准备好什么一、共享库数据源已接入确认数据源接入中共享库的数据源已配置并连接正常。数据中台采用五层分层架构来源库SRCSource直接从业务系统接入原始数据贴源库ODSOperational Data Store保存镜像数据治理库DWData Warehouse完成清洗和标准化应用库ADSApplication Data Store存放面向业务场景的汇总数据共享库DSData Sharing是数据中台对外提供数据共享服务的统一出口。自助API默认从共享库DS层读取数据对外提供服务因为DS层的数据已经过了完整的数据质量校验和标准化处理。但不仅限于DS层——也可选择DW层或ADS层作为数据源。检查路径为「数据集成→数据源接入」确认连接状态为正常。二、了解目标数据表结构明确要共享的表名、字段清单以及哪些字段需要脱敏处理Data Masking如身份证号、手机号、银行卡号等。自助API支持主子表嵌套返回同时提供字段转换规则引擎支持值映射Value Mapping、日期格式化、正则表达式、默认值填充以及字符串脱敏等多种后处理能力。提前梳理好敏感字段清单可以在API配置过程中一次性完成。前置条件确认位置说明共享库数据源已接入数据集成→数据源接入连接状态正常了解表结构和敏感字段数据治理→元数据管理明确哪些字段需脱敏第三章 操作步骤——创建API服务与自助API3.1 创建API服务第一步是创建一个API服务。API服务是多个API的逻辑分组容器——同一个业务域下的多个API如客户域下的客户信息查询、订单查询、积分查询等统一归属到一个API服务下管理。进入「数据共享→API共享→服务维护」点击新增服务。服务名称英文如customer会作为API访问地址的前缀——假设数据中台部署在http://192.168.1.100:8080服务名称为customer则该服务下所有API的访问地址都以http://192.168.1.100:8080/customer/开头。服务名称要求全平台唯一建议按业务域命名字母开头、长度控制在32位以内。创建服务的同时即可配置流控管理这是访问控制的第一道防线。流控包含两个核心指标并发数同一时刻系统正在处理的请求数量上限数值范围1-9999和日最大访问量一天内系统处理的总请求数上限数值范围1-9999。配置完成后点击上线按钮使服务生效。配置项填写内容说明服务名称英文如customer作为API地址前缀字母开头1-32位服务显示名称中文如客户数据服务管理界面识别用并发数1-9999服务级并发数上限日最大访问量1-9999服务级日调用总量上限3.2 新增自助API进入「数据共享→API共享→API管理」点击新增自助API。自助APISelf-Service API是通过自定义SQL语句直接从数据库查询数据并返回结果的API属于零代码开发模式——配置者只需编写SQL和设置基本参数平台自动生成完整的RESTful接口。自助API采用六步引导式配置流程第一步设置API基本信息配置项说明API名称中文如客户订单查询接口请求方法GET查询类/ POST提交数据或复杂查询鉴权模式签名模式HMAC-SHA1动态签名/ 简易模式仅校验AppKey/ 不鉴权API路径URL访问路径全平台唯一如/customer/order/query第二步配置查询SQL语句选择数据源推荐DS层编写SQL。SQL中使用${参数名}占位符引用查询参数——当调用方发起API请求时URL中传递的参数值会自动填入SQL占位符位置。例如SQL写为SELECT * FROM customer_order WHERE customer_id ${customerId}调用方请求/customer/order/query?customerId12345时实际执行的SQL会替换为SELECT * FROM customer_order WHERE customer_id 12345。自助API支持主子表嵌套返回的高级特性。主表设置数据集标识如student子表引用主表标识作为前缀如${student.no}平台自动组织嵌套JSON结构。第三步转换规则设置对敏感字段或需要格式化的字段添加转换规则。平台内置的规则类型包括值映射、日期格式化、字符串脱敏等。脱敏Data Masking是共享场景下使用频率最高的转换规则——以身份证号脱敏为例设置开始位置4、结束位置14、替换内容*则原始值320102199001011234输出为320**********1234。第四步测试API填写测试值点击测试验证SQL逻辑、参数映射和转换规则。第五步流量控制为该API单独设置并发数和日最大访问量。API级流控优先级高于服务级流控。建议对核心业务API单独设置更严格的阈值。第六步下载API文档平台自动生成完整API文档包括请求方法、请求类型、鉴权模式、输入/返回参数清单和返回示例。调用方无需人工沟通即可完成对接。3.3 了解其他API类型穿透APIProxy API将已有的第三方API注册到数据中台统一纳管平台作为代理层实现地址转换、统一鉴权、调用日志。编排APIOrchestration API通过拖拽式可视化画布组装复杂的API流程。组件库包括Restful API调用、WebService调用、数据库表查询/输出/更新、JSON/XML报文互转、条件判断、流程分支等。编排API适用于跨系统数据聚合和跨多库事务性操作。第四章 操作步骤——配置访问控制策略访问控制是API共享安全的基石。龙石数据中台提供三道防线构成纵深防护体系鉴权验证调用者身份——“你是谁”→IP白名单/黑名单控制访问来源——“从哪来”→流量控制限制调用频次——“用多少”。4.1 第一道防线API鉴权进入「数据共享→API共享→API授权」平台采用统一的AppKey SecretKey应用密钥对授权模式。三种鉴权模式鉴权模式技术原理适用场景安全等级签名模式HMAC-SHA1对请求参数动态生成签名每次签名不同可防重放攻击交易数据、个人信息、财务数据★★★简易模式仅校验AppKey是否有效不校验参数是否被篡改内部系统间非敏感数据查询★★☆不鉴权不采取身份验证措施公开数据、测试环境★☆☆配置建议涉及个人信息的API必须用签名模式内部非敏感数据可用简易模式测试阶段临时不鉴权需同时开启白名单限制。4.2 第二道防线IP白名单/黑名单进入「数据共享→API共享→白名单 / 黑名单」。白名单Allowlist开启后仅允许列表内IP发起请求遵循最小权限原则。黑名单Blocklist将非法或异常IP加入后直接拒绝请求。推荐白名单为主、黑名单为辅的组合策略。配置白名单时注意如果API前有负载均衡器或API网关务必把网关的出口IP也加入白名单。4.3 第三道防线流量控制流量控制从调用频次维度保护后端服务稳定性层级控制指标配置位置服务级流控并发数 日最大访问量API服务维护API级流控并发数 日最大访问量新增/编辑API并发数防洪峰型攻击——瞬间大量并发请求。日最大访问量防渗透型消耗——持续低频但高总量的异常调用。两项指标缺一不可生产环境务必两项都设置。第五章 验证结果——发布后的监控与调用API发布上线后可通过平台内置测试功能、Postman或cURL三种方式调用验证。重点检查返回字段完整性、数据准确性、脱敏效果。进入「数据共享→API共享」三个维度可视化监控分析维度展示内容服务维度每日调用量成功/失败、历史总量、趋势图用户维度每个AppKey调用者的调用量和趋势——识别异常增长API维度每个API的调用量和趋势——定位热点接口平台还提供API集监控功能配置可用性监测检查状态码200、正确性监测检查响应报文关键内容、响应时间监测检测是否超阈值。任一项触发异常自动通过微信/短信/邮件告警。第六章 配置速查模板配置维度配置项填写内容说明服务维护服务名称英文如customer作为API地址前缀并发数1-9999服务级并发上限日最大访问量1-9999服务级日调用上限自助API请求方法GET / POST查询用GET提交用POST鉴权模式签名/简易/不鉴权敏感数据用签名数据源共享库DS/治理库DW/应用库ADS推荐DS层SQL语句SELECT ... WHERE field ${param}支持占位符绑定参数转换规则脱敏位置替换内容身份证位置4-14替换*值映射原始值→目标值F→女、M→男访问控制白名单IP地址列表仅允许白名单IP访问黑名单IP地址列表拒绝黑名单IP访问第七章 避坑指南与方法论收尾避坑指南坑一测试时选不鉴权上线后忘记切回签名模式。测试阶段为了调试顺畅选了不鉴权上线检查清单漏了鉴权确认——API在公网没有任何身份验证。正确做法测试环境用简易模式白名单限制测试IP组合避免裸奔。坑二流控只配了并发数没配日最大访问量。并发数挡洪峰日最大访问量挡渗透。Bug脚本每秒1次请求并发数永远不会触发但24小时就是86400次调用。两项缺一不可。坑三白名单配了业务服务器IP漏了API网关IP。API通过网关对外暴露时到达数据中台的TCP连接源IP是网关IP而非业务服务器IP。配置白名单时需列出调用链上所有中间节点的出口IP。从开发两天到配置十分钟回到开头场景。没有数据中台之前每次对外共享一个数据接口需要确认数据源→排期→写Controller/Service/DAO代码→配鉴权→写文档→联调测试→部署上线最快两天。借助龙石数据中台的数据共享模块流程简化为进入资产目录→找到目标表→新建自助API→编写SQL→选择鉴权模式→开启白名单→设置流控→测试发布八个步骤全程在可视化界面完成十分钟以内。后续的调用量统计、调用方管理、质量监控、异常告警全部由平台自动运转。方法论收尾龙石数据中台遵循理、采、存、管、用五阶方法论。API共享模块是用阶段的核心能力载体——它不是简单地把数据扔出去而是在服务维护→鉴权授权→黑白名单→双层流控→多维调用分析→持续质量监控的完整机制框架下实现数据在用得出去和管得住之间取得平衡。在江苏某数据局的共享交换平台中全市百余个政务节点、近4万个交换任务、千余个API服务稳定运行在某211大学智慧校园项目中跨部门数据申请从天/周级线下审批缩短到分钟级在线自助获取。数据共享的价值不在于技术有多复杂而在于访问有多简单、管控有多精细。FAQ1. 三种鉴权模式怎么选签名模式基于HMAC-SHA1动态签名防重放攻击适用于交易数据、财务数据、个人信息。简易模式仅校验AppKey适用于内部非敏感数据。不鉴权需同时开启白名单保护。2. 白名单和鉴权能同时开启吗可以两者是互补的安全维度。同时开启时请求须同时满足AppKey合法和来源IP在白名单内。3. 并发数和日最大访问量分别控制什么并发数控制同一时刻请求数上限防洪峰日最大访问量控制全天总请求数上限防渗透。不填写代表无限制生产环境建议两项均设置合理阈值。4. 自助API和穿透API有什么区别自助API是通过SQL从数据库直接查询生成全新API零代码新建。穿透API是将已有第三方API注册到平台统一纳管不改原逻辑。5. API服务下线后能恢复吗服务下线后该服务下所有API立即停止响应。再次点击上线恢复——不会丢失配置信息不影响AppKey/SecretKey授权关系不清理调用统计。