标准企业族谱页面接口规范文档.docx

PAGE 5 标准企业族谱页面接口规范文档 V1.0 目录 TOC \o 1-3 \h \z \u 1 接口介绍 3 1.1 简介 3 1.2 申明 3 2 接入指南 3 2.1 接入方式 3 2.2 安全验证 3 2.3 响应方式 4 3 接口描述 4 3.1 请求地址 4 3.2 请求方式 4 3.3 请求参数 4 3.3.1 请求参数说明 4 3.3.2 请求样例 5 3.4 返回结果 5 接口介绍 简介 企业族谱页面接口提供一键打开企业族谱页面，免去用户登录。本接口基于RESTful Web Services理念设计，为使本接口的使用者详细了解服务接口调用方法和规范，特编制此接口使用说明文档。 申明 本文档仅提供给授权开发商设计相关接口服务使用，未经允许不得对外布。 本文档中可能存在技术部分错误或印刷不清晰，我们会定期进行更改并发布新版本，对资料中描述的产品改进或更改，不在另行通知。 接入指南 接入方式 接口须使用HTTPS协议访问，请求参数为用户名、密码和企业名称（加密后的字符串）。 安全验证 用户购买接口服务后，风险雷达会提供apikey，apikey用于加密企业名称，加密算法为DES（Data Encryption Standard）。用户通过接口将用户名和加密后的企业名称发送给风险雷达，风险雷达接收到用户请求后，获取请求参数，根据用户名查找用户的apikey，使用用户的apikey对企业名称进行解密，如果解密成功，就跳转该企业的详情页面。 响应方式 接口返回结果为企业详情页面。 接口描述 请求地址 请求方式 GET、POST方式请求。 请求参数 为了保证客户数据的安全性，各接口参数需加密传输，加密算法为DES。 请求参数说明 参数名称 是否必须 参数类型 参数说明 userName 是 String 用户名称 keyPwd 是 String 用户密码，使用apikey进行加密，生成密文，例如“5796cGlMdh/SrKFk730Adg==” enterpriseName 是 String 企业名称，使用apikey进行加密，生成密文，例如“d3jeMH3jxXct89NPIoojAMiwU73BfYMcuzwHRU1a2xE=” 请求样例 enterpriseName、keyPwd为加密后的字符串。 注意：如果使用GET方式发送请求，需要将keyPwd、enterpriseName中的“+”转换为“%2B”。 返回结果