Onion OpenAPI 接口文档

const crypto = require('crypto');

/**
 * 生成 OpenAPI 签名
 * @param {string} apiKey - API Key ID
 * @param {string} secret - API Key Secret
 * @returns {object} - 包含 timestamp, signature, api_key 的对象
 */
function generateSignature(apiKey, secret) {
    const timestamp = String(Math.floor(Date.now() / 1000));
    const signStr = `api_key=${apiKey}×tamp=${timestamp}`;

    const mac = crypto.createHmac('sha256', secret);
    mac.update(signStr);
    const signature = mac.digest('hex');

    return {
        timestamp,
        signature,
        api_key: apiKey
    };
}

// 示例
const apiKey = 'your_api_key_id';
const secret = 'your_api_key_secret';
const { timestamp, signature, api_key } = generateSignature(apiKey, secret);

console.log(`timestamp=${timestamp}`);
console.log(`signature=${signature}`);
console.log(`api_key=${api_key}`);

package main

import (
    "crypto/hmac"
    "crypto/sha256"
    "encoding/hex"
    "fmt"
    "strconv"
    "time"
)

// GenerateSignature 生成签名
func GenerateSignature(apiKey, secret string) (timestamp, signature, apiKeyOut string) {
    timestamp = strconv.FormatInt(time.Now().Unix(), 10)
    signStr := fmt.Sprintf("api_key=%s×tamp=%s", apiKey, timestamp)

    mac := hmac.New(sha256.New, []byte(secret))
    mac.Write([]byte(signStr))
    signature = hex.EncodeToString(mac.Sum(nil))

    return timestamp, signature, apiKey
}

func main() {
    apiKey := "your_api_key_id"
    secret := "your_api_key_secret"

    timestamp, signature, apiKeyOut := GenerateSignature(apiKey, secret)

    fmt.Printf("timestamp=%s\n", timestamp)
    fmt.Printf("signature=%s\n", signature)
    fmt.Printf("api_key=%s\n", apiKeyOut)
}

import hmac
import hashlib
import time

def generate_signature(api_key, secret):
    """
    生成 OpenAPI 签名
    @param api_key: API Key ID
    @param secret: API Key Secret
    @return: dict 包含 timestamp, signature, api_key
    """
    timestamp = str(int(time.time()))
    sign_str = f"api_key={api_key}×tamp={timestamp}"

    signature = hmac.new(
        secret.encode('utf-8'),
        sign_str.encode('utf-8'),
        hashlib.sha256
    ).hexdigest()

    return {
        'timestamp': timestamp,
        'signature': signature,
        'api_key': api_key
    }

# 示例
api_key = 'your_api_key_id'
secret = 'your_api_key_secret'
result = generate_signature(api_key, secret)

print(f"timestamp={result['timestamp']}")
print(f"signature={result['signature']}")
print(f"api_key={result['api_key']}")

##### 完整调用示例

使用签名参数发送 POST 请求获取 Token：

```bash
# 1. 生成签名
timestamp=1711234567
signature=abc123def456...
api_key=your_api_key_id

# 2. 发送请求（api_key 在 query 参数中）
curl -X POST "https://openapi.yctou.net/openapi/token?api_key=your_api_key_id" \
  -H "X-Timestamp: ${timestamp}" \
  -H "X-Signature: ${signature}"

// Node.js 完整示例
const crypto = require('crypto');
const https = require('https');

function generateSignature(apiKey, secret) {
    const timestamp = String(Math.floor(Date.now() / 1000));
    const signStr = `api_key=${apiKey}×tamp=${timestamp}`;

    const mac = crypto.createHmac('sha256', secret);
    mac.update(signStr);
    const signature = mac.digest('hex');

    return { timestamp, signature, api_key: apiKey };
}

async function getToken(apiKey, secret) {
    const { timestamp, signature, api_key } = generateSignature(apiKey, secret);

    const url = new URL('https://openapi.yctou.net/openapi/token');
    url.searchParams.append('api_key', api_key);

    const options = {
        hostname: 'openapi.yctou.net',
        path: '/openapi/token',
        method: 'POST',
        headers: {
            'X-Timestamp': timestamp,
            'X-Signature': signature
        }
    };

    return new Promise((resolve, reject) => {
        const req = https.request(options, (res) => {
            let data = '';
            res.on('data', (chunk) => data += chunk);
            res.on('end', () => resolve(JSON.parse(data)));
        });
        req.on('error', reject);
        req.end();
    });
}

// 使用
const apiKey = 'your_api_key_id';
const secret = 'your_api_key_secret';
getToken(apiKey, secret).then(console.log);

### Bearer Token 认证

用于所有业务接口 (`/v1/*`)。

获取 Token 后，使用 Bearer Token 方式访问其他接口。

**请求头**

**示例**

```bash
curl -X GET "https://openapi.yctou.net/openapi/v1/vault?page=1&size=10" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

{
  "code": 0,
  "message": "success",
  "data": {}
}

curl -X POST "https://openapi.yctou.net/openapi/token?api_key=your_api_key_id" \
  -H "X-Timestamp: 1711234567" \
  -H "X-Signature: abc123..." 

{
  "code": 0,
  "message": "success",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_at": 1711234567
  }
}

{
  "code": 0,
  "message": "success",
  "data": {
    "key_id": "1234567890"
  }
}

{
  "code": 0,
  "message": "success",
  "data": {
    "total": 100,
    "hits": [
      {
        "key_id": "1234567890",
        "account": "test@example.com",
        "account_id": "",
        "alias": "测试账号",
        "description": "测试描述",
        "status_id": 1,
        "type_id": 0,
        "is_empty_pwd": 0,
        "update_time": 1700000000,
        "apps": [
          {
            "team_application_id": "1",
            "name": "应用名称",
            "url": "https://app.com",
            "group_status_id": 1,
            "status_id": 1
          }
        ]
      }
    ]
  }
}

{
  "code": 0,
  "message": "success",
  "data": null
}

{
  "code": 0,
  "message": "success",
  "data": {
    "node_list": [
      {
        "id": 1,
        "name": "分类1"
      },
      {
        "id": 2,
        "name": "分类2"
      }
    ]
  }
}

{
  "code": 0,
  "data": {
    "apps": [
      {
        "team_application_id": 1,
        "name": "应用名称",
        "category_ids": [1, 2]
      }
    ],
    "categories": [
      {
        "id": 1,
        "name": "分类名称"
      }
    ]
  }
}

{
  "code": 0,
  "data": {
    "hits": [
      {
        "id": "1",
        "dept_id": "1",
        "name": "部门名称",
        "is_group": true,
        "is_grant": true,
        "member_count": 10,
        "total_member_count": 100,
        "children": []
      }
    ]
  }
}

{
  "code": 0,
  "data": {
    "hits": [],
    "total": 0
  }
}