接口文档

https://api.orbitshield.com

stringToSign =
  METHOD    + "\n" +
  path      + "\n" +   // e.g. /api/v1/open/sites
  rawQuery  + "\n" +   // e.g. page=1&pageSize=20  (empty if none)
  timestamp + "\n" +
  nonce     + "\n" +
  hex( sha256(body) )   // body = "" if no request body

X-Api-Sign = hex( HMAC-SHA256(APP_SECRET, stringToSign) )

import crypto from "node:crypto";

const API_BASE = "https://api.orbitshield.com";
const APP_ID = "ak_xxxxxxxxxxxx";
const APP_SECRET = "your_app_secret";

async function callOpenApi(method, path, { query = "", body = "" } = {}) {
  const ts = Math.floor(Date.now() / 1000).toString();
  const nonce = crypto.randomBytes(8).toString("hex");
  const bodyHash = crypto.createHash("sha256").update(body).digest("hex");
  const stringToSign = [method, path, query, ts, nonce, bodyHash].join("\n");
  const sign = crypto.createHmac("sha256", APP_SECRET).update(stringToSign).digest("hex");

  const url = API_BASE + path + (query ? "?" + query : "");
  const res = await fetch(url, {
    method,
    headers: {
      "X-Api-Id": APP_ID,
      "X-Api-Timestamp": ts,
      "X-Api-Nonce": nonce,
      "X-Api-Sign": sign,
      "Content-Type": "application/json",
    },
    body: body || undefined,
  });
  return res.json();
}

// List sites
console.log(await callOpenApi("GET", "/api/v1/open/sites", { query: "page=1&pageSize=20" }));

import time, os, hmac, hashlib, secrets, json, urllib.request

API_BASE = "https://api.orbitshield.com"
APP_ID = "ak_xxxxxxxxxxxx"
APP_SECRET = b"your_app_secret"

def call(method, path, query="", body=""):
    ts = str(int(time.time()))
    nonce = secrets.token_hex(8)
    body_hash = hashlib.sha256(body.encode()).hexdigest()
    string_to_sign = "\n".join([method, path, query, ts, nonce, body_hash])
    sign = hmac.new(APP_SECRET, string_to_sign.encode(), hashlib.sha256).hexdigest()
    url = API_BASE + path + (("?" + query) if query else "")
    req = urllib.request.Request(url, data=body.encode() if body else None, method=method)
    req.add_header("X-Api-Id", APP_ID)
    req.add_header("X-Api-Timestamp", ts)
    req.add_header("X-Api-Nonce", nonce)
    req.add_header("X-Api-Sign", sign)
    req.add_header("Content-Type", "application/json")
    return json.load(urllib.request.urlopen(req))

print(call("GET", "/api/v1/open/sites", "page=1&pageSize=20"))

#!/usr/bin/env bash
API_BASE="https://api.orbitshield.com"
APP_ID="ak_xxxxxxxxxxxx"
APP_SECRET="your_app_secret"

METHOD="GET"; PATH_="/api/v1/open/sites"; QUERY="page=1&pageSize=20"; BODY=""
TS=$(date +%s)
NONCE=$(openssl rand -hex 8)
BODY_HASH=$(printf '%s' "$BODY" | openssl dgst -sha256 | awk '{print $2}')
STS=$(printf '%s\n%s\n%s\n%s\n%s\n%s' "$METHOD" "$PATH_" "$QUERY" "$TS" "$NONCE" "$BODY_HASH")
SIGN=$(printf '%s' "$STS" | openssl dgst -sha256 -hmac "$APP_SECRET" | awk '{print $2}')

curl -s "$API_BASE$PATH_?$QUERY" \
  -H "X-Api-Id: $APP_ID" \
  -H "X-Api-Timestamp: $TS" \
  -H "X-Api-Nonce: $NONCE" \
  -H "X-Api-Sign: $SIGN"

{ "code": 0, "message": "ok", "data": { /* ... */ } }

"https": {
  "certId": "12",
  "forceHttps": true,
  "http2": true,
  "hsts": true,
  "minTls": "1.2"
}

"origin": {
  "scheme": "https",
  "balance": "roundrobin",
  "passHost": "rewrite",
  "hostValue": "origin.example.com",
  "sni": "",
  "range": true,
  "timeout": 30,
  "keepalive": true,
  "nodes": [
    { "host": "1.2.3.4", "port": 443, "weight": 1, "role": "main", "line": "主线路" }
  ],
  "health": { "fails": 3, "interval": 10, "timeout": 5 }
}