• API概述
  • API资源
  • 鉴权方式
  • 错误返回值

一、接口简介

接口是提供给团队用户用于在自有平台进行数据管理和集成的工具,普通用户只能在平台进行数据管理。

二、接口使用指南

(1)在平台注册团队用户,等待审核,审核通过后平台后管理平台分配用于调用接口accesskey,secretkey
(2)生成相应的token和policy,通过http POST请求进行接口访问

三、接口域名

https://noi.link

四、接口测试

正式注册数据接口为:/api/data_add,对应测试接口为:/api2/data_add,其它接口同理。测试数据不会在平台直接显示,但是可以通过测试接口获得,请测试成功后再使用正式接口。

五、请求方式

(1)http POST(application/x-www-form-urlencoded,multipart/form-data)
(2)token在http hearder中设置
(3)policy是body中的参数 (4)返回值JSON格式字符串

描述 请求 请求参数 返回值

获取模版列表

/api/model_list

(1)token:包含在http Header中

(2)policy:Base64加密 json字符串 包含属性:

  page:分页
  limit:每页返回数据
  type: 类别 1 自己上传模版 2所有模版

code:状态码
error:错误描述
data: 数据

获取数据列表

/api/data_list

(1)token:包含在http Header中

(2)policy:Base64加密 json字符串 包含属性:

  page:分页
  limit:每页返回数据

code:状态码
error:错误描述
data: 数据

注册数据

/api/data_add

(1)token:包含在http Header中

(2)policy:Base64加密 json字符串 包含属性:

  data_info:元数据json字符串
  data_from:数据来源
  data_copyright:版权
  data_modelid:模版id

code:状态码
error:错误描述
data: 数据

获取数据详情

/api/data_info

(1)token:包含在http Header中

(2)policy:Base64加密 json字符串 包含属性:

  id:noi号不用包含'NOI:'前缀

code:状态码
error:错误描述
data: 数据

获取数据注册历史

/api/data_histroy

(1)token:包含在http Header中

(2)policy:Base64加密 json字符串 包含属性:

  id:noi号不用包含'NOI:'前缀

code:状态码
error:错误描述
data: 数据

1.生成待签名的原始字符串:

policy = {...}(请求参数json)

2.对 JSON 编码的原始字符Base64 编码,得到待签名字符串:

encodedPolicy = base64_encode(policy)

3.使用SecertKey对上一步生成的原始字符串计算HMAC-SHA1签名:

sign = hmac_sha1(encodedPolicy, "<SecretKey>")

4.对签名进行URL 安全的 Base64 编码:

encodedSign = base64_encode(sign)

5.将 AccessKey 和 encodedSign 用英文符号 : 连接起来:

accessToken = "<AccessKey>:<encodedSign>"

6.accessToken便是请求所需要的token

code:返回的错误码,用来定位错误场景; error:包含详细的错误信息。

code 描述
200 成功
400 请求报文格式错误 包括上传时,上传表单格式错误
401 认证授权失败 错误信息包括密钥信息不正确;数字签名错误;授权已超时
403 权限不足,拒绝访问
404 资源不存在 包括空间资源不存在;镜像源资源不存在
502 错误网关
503 服务端不可用
504 服务端操作超时
599 服务端操作失败
601 用户账号被冻结
0
需要帮助?

NOI产品顾问为你服务

我是徐州锋,立即扫码加我吧!

帮助群:4321785974

服务邮箱:service@noi.com