接口快速入门

2. 快速入门

2.1 获取 API 账号

如需使用 API,请先申请 API 账号。联系邮箱:

iloveofd@163.com

2.2 获取 Token

curl -X POST 'https://api.iloveofd.cn/api/login' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "your_username",
    "password": "your_password"
  }'

返回:

{
  "code": 200,
  "token": "your_token"
}
  • 除登录接口外,其他 API 均需要在 Header 中携带 Token。

  • Token 默认有效期为 20 天。

  • Token 是 API 身份凭证,请勿将 Token 暴露在:前端代码、浏览器源码、JavaScript、日志、Git 仓库、公共代码仓库。


2.3 获取文件上传授权

curl 'https://api.iloveofd.cn/api/auth' \
  -H 'token: your_token'

接口返回 BOS 临时访问凭证。


2.4 上传文件

使用 /api/auth 返回的临时授权信息,将文件通过 PUT 上传至 BOS。

使用 UUID 作为文件 Key,例如:

2642efca-cd38-46ec-bf3c-d1a2af8dea84.caj

2.5 创建任务

curl -X POST 'https://api.iloveofd.cn/api/create' \
  -H 'Content-Type: application/json' \
  -H 'token: your_token' \
  -d '{
    "taskType": "OFD2PDF",
    "strPairs": {},
    "ossPendingFiles": [
      {
        "fileKey": "2642efca-cd38-46ec-bf3c-d1a2af8dea84.ofd",
        "fileName": "example.ofd"
      }
    ]
  }'

成功后获取 requestId。


2.6 查询任务

curl 'https://api.iloveofd.cn/api/status/{requestId}' \
  -H 'token: your_token'

当:

{
  "taskStatus": {
    "status": "COMPLETED"
  }
}

表示任务完成。


2.7 获取结果

curl 'https://api.iloveofd.cn/api/detail/{requestId}' \
  -H 'token: your_token'

从:

task.ossProcessedFiles[].fileUrl

获取结果文件下载地址。