Origin X Documentation

天行有常,不为尧存,不为桀亡。——荀子《天论》

资源请求接口

资源请求接口主要在认证授权接口之后执行,它需要经历一个初始化的流程,初始化主要包含:

1. 初始化

地址:http://<HOST>:<PORT>/app/name/:name

HTTP方法:GET

参数名 说明
name 访问的应用资源的名称,单独访问时固定,平台有接口可读取所有的应用列表。

Response

{
    "data": {
        "key": "239975a7-f164-43b3-a9d1-4516f98c1948",
        "name": "vie.app.ox",
        "code": "ox",
        "title": "测试应用",
        "domain": "ox.engine.cn",
        "appPort": 5000,
        "urlEntry": "/login/index",
        "urlMain": "/home/dashboard",
        "path": "ox",
        "route": "/ox",
        "active": true,
        "sigma": "ENhwBAJPZuSgIAE5EDakR6yrIQbOoOPq",
        "language": "cn"
    }
}

上述响应信息中,核心信息如下

字段名 说明
key 资源请求专用自定义请求头:X-AppId
sigma 资源请求专用自定义请求头:X-Sigma
language (保留)多语言环境专用请求头:X-Lang

2. 资源请求

资源请求只需要提供核心请求头的基础信息即可立即访问 ox 中的接口,需要消费的请求头可参考具体接口的基础说明。

请求头 说明
X-Sigma 多租户环境标识符
X-AppId 多应用环境标识符
X-AppKey 敏感资源标识符
X-Lang 多语言环境标识符
Authorization 格式如:Bearer <access_token>,安全标识符

安全标识符是通过认证授权接口拿到的令牌组装完成,有几点需要说明: