YesApi 接口文档

岩石 v1.4

接口路径(新)：http://hn216.api.okayapi.com/api/SVIP/Sqq2200833509_MyApi/AJieKou0509

接口路径(旧)：http://hn216.api.okayapi.com/?s=SVIP.Sqq2200833509_MyApi.AJieKou0509

接口描述： 请在这里填写接口的功能说明

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，查看我的app_key，如果还没有，可免费注册开通。
sign字符串可选公共参数接口签名，其中：
  • 使用动态签名，签名生成算法请见：如何生成签名，或直接使用封装好的SDK开发包，通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名，点击获取我的静态签名
  • 关闭签名，如果不需要签名，可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构，其中：
  • return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  • return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
井号字符串可选
井深整型可选
分析前重量浮点型可选
分析后重量浮点型可选
层位字符串可选
样品类别字符串可选
岩性字符串可选
S0浮点型可选
S1浮点型可选
S2浮点型可选
Tmax浮点型可选
PG浮点型可选
PC浮点型可选
GPI浮点型可选
OPI浮点型可选
TPI浮点型可选
HPI浮点型可选
S4浮点型可选
TOC浮点型可选
D浮点型可选
HI浮点型可选
Cp浮点型可选
RC浮点型可选
ST浮点型可选
PI浮点型可选
HCI浮点型可选
R0浮点型可选
地化亮点浮点型可选
轻重比浮点型可选
S1/TOC字符串可选
热解结论字符串可选
测井结论字符串可选
测试结论字符串可选
有机质类型字符串可选
有机质成熟度字符串可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

HTTP通用示例 
{
    "井号": "庆H33-1井",
    "井深": "3776",
    "分析前重量": "99.6",
    "分析后重量": "99.1",
    "层位": "延长组",
    "样品类别": "岩屑",
    "岩性": "灰褐色油斑细砂岩",
    "S0": "0.0319",
    "S1": "",
    "S2": "",
    "Tmax": "",
    "PG": "",
    "PC": "0.6869",
    "GPI": "",
    "OPI": "",
    "TPI": "",
    "HPI": "0.2657",
    "S4": "",
    "TOC": "",
    "D": "",
    "HI": "",
    "Cp": "",
    "RC": "",
    "ST": "",
    "PI": "",
    "HCI": "",
    "R0": "0",
    "地化亮点": "22.75090841",
    "轻重比": "2.749022283",
    "S1\/TOC": "",
    "热解结论": "含油水层",
    "测井结论": "",
    "测试结论": "",
    "有机质类型": "",
    "有机质成熟度": ""
}

接口返回及数据结构

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.井号字符串暂无描述
data.井深字符串暂无描述
data.分析前重量字符串暂无描述
data.分析后重量字符串暂无描述
data.层位字符串暂无描述
data.样品类别字符串暂无描述
data.岩性字符串暂无描述
data.S0字符串暂无描述
data.S1字符串暂无描述
data.S2字符串暂无描述
data.Tmax字符串暂无描述
data.PG字符串暂无描述
data.PC字符串暂无描述
data.GPI字符串暂无描述
data.OPI字符串暂无描述
data.TPI字符串暂无描述
data.HPI字符串暂无描述
data.S4字符串暂无描述
data.TOC字符串暂无描述
data.D字符串暂无描述
data.HI字符串暂无描述
data.Cp字符串暂无描述
data.RC字符串暂无描述
data.ST字符串暂无描述
data.PI字符串暂无描述
data.HCI字符串暂无描述
data.R0字符串暂无描述
data.地化亮点字符串暂无描述
data.轻重比字符串暂无描述
data.S1TOC字符串暂无描述
data.热解结论字符串暂无描述
data.测井结论字符串暂无描述
data.测试结论字符串暂无描述
data.有机质类型字符串暂无描述
data.有机质成熟度字符串暂无描述
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

特别注意：当前 hn216.api.okayapi.com 为临时接口测试域名！请先完成 绑定独立接口域名后 ，才能正式进行API调用。

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次