ONES API

概述

• ONES API 基于 REST 风格编写，大部分接口都需要在登录状态下使用。

• ONES 常见的对象有项目 project、工作项 task、工作项属性 field、工作项类型 issue_type、工作项状态 task_status 等等，一般这些对象都会拥有 ID，在 ONES API 体系中，我们称之为 UUID，注意这里的 UUID 与业界定义的 ID 是不同的，这是内部的命名方式，一般我们指的 UUID 是长度为8个字符或16个字符的串。

• 创建工作项的流程：先获取到项目 UUID 以及工作项类型的 UUID，然后调用创建工作项的接口，传入相关参数参数来创建工作项。

URI 结构

ONES REST API 通过 URI 路径提供对资源的访问，使用 {} 或 :name 将 URI 路径的一部分标记为可使用参数替换的部分，URI 路径遵循以下规则：

http(s)://{your-host-name}/project/api/project/{api-path}

例如：

https://my-host-name/project/api/project/auth/login
https://my-host-name/project/api/project/users/me
https://your-host-name/project/api/project/team/:teamUUID/projects/info

所有请求都是基于 http 或者 https。 {your-host-name}为 ONES 部署机器的域名 或者 ip:port。

通过授权

如果您需要调用 ONES API接口, 通常用户登录是必须的。您可以通过调用 ONES 用户登录接口完成用户登录。 如果您是合法用户，登录接口返回值会包含 user.uuid 和 user.token, 此二值用于 ONES 用户登录凭证。

ONES API 接口登录凭证作为 HTTP Header 为接口调用提供身份校验:

接口调用示例 - 通过授权

通过授权，调用获取当前用户信息接口。

curl -X GET \
    https://your-host-name/project/api/project/users/me \
    -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
    -H 'Ones-User-Id: DU6krHBN' \
    -H 'Referer: https://your-host-name' \
    -H 'cache-control: no-cache'

状态码说明