API 参考 / admin

写平台配置(平台超管)

PUT /api/v1/admin/settings · adminUpdateSettings

全量覆盖平台配置(注册开关 / 全站公告 / 运维外链 / 首页致谢)。opsLinks 的 url 必须 https,非法返回 422。 写审计 platform.settings.update(metadata 只记变更 key 摘要,不含敏感值明文)。要求平台超管。

本接口要求浏览器会话。Bearer API Token 无法调用——Token 的生命周期管理必须在网页端完成。

请求体

allowSignups(必填)
boolean
announcement(必填)
string
opsLinks(必填)
PlatformOpsLink[]
opsLinks[].label(必填)
string
opsLinks[].url(必填)
string
acknowledgements(必填)
PlatformAcknowledgement[]
acknowledgements[].icon(必填)
enum;取值:heart / code / database / git / box / sparkles / shield / users / rocket / book / server / workflow
acknowledgements[].name(必填)
string
acknowledgements[].url
string
acknowledgements[].enabled(必填)
boolean

响应字段 · 200

allowSignups(必填)
boolean
announcement(必填)
string
opsLinks(必填)
PlatformOpsLink[]
opsLinks[].label(必填)
string
opsLinks[].url(必填)
string
acknowledgements(必填)
PlatformAcknowledgement[]
acknowledgements[].icon(必填)
enum;取值:heart / code / database / git / box / sparkles / shield / users / rocket / book / server / workflow
acknowledgements[].name(必填)
string
acknowledgements[].url
string
acknowledgements[].enabled(必填)
boolean
smtp(必填)
PlatformSmtpSettings
smtp.host(必填)
string
smtp.port(必填)
integer
smtp.username(必填)
string
smtp.from(必填)
string
smtp.fromName(必填)
string
smtp.useTls(必填)
boolean
smtp.passwordConfigured(必填)
boolean
sentry(必填)
PlatformSentrySettings
sentry.frontendDsn(必填)
string
sentry.environment(必填)
string
sentry.backendDsnConfigured(必填)
boolean
attachmentStorage(必填)
PlatformAttachmentStorageSettings
attachmentStorage.endpoint(必填)
string
attachmentStorage.region(必填)
string
attachmentStorage.bucket(必填)
string
attachmentStorage.accessKeyId(必填)
string
attachmentStorage.usePathStyle(必填)
boolean
attachmentStorage.keyPrefix(必填)
string
attachmentStorage.secretAccessKeyConfigured(必填)
boolean
attachmentStorage.configured(必填)
boolean
support(必填)
PlatformSupportSettings
support.enabled(必填)
boolean
support.projectId(必填)
string
support.actorUserId(必填)
string
support.defaultOwnerId(必填)
string
support.feishuGroupLink(必填)
string
support.feishuGroupQrUrl(必填)
string
support.contactEmail(必填)
string
support.chatGreeting(必填)
string
support.chatFallbackReply(必填)
string
support.cannedReplies(必填)
SupportCannedReply[]
support.cannedReplies[].keywords(必填)
string[]
support.cannedReplies[].reply(必填)
string
loginThrottle
PlatformLoginThrottleSettings
loginThrottle.accountBurst(必填)
integer
loginThrottle.accountRefillPerMinute(必填)
number
loginThrottle.ipBurst(必填)
integer
loginThrottle.ipRefillPerMinute(必填)
number
publicDemo
PlatformPublicDemoSettings
publicDemo.enabled(必填)
boolean
publicDemo.projectIds(必填)
string[]
siteRoadmap
PlatformSiteRoadmapSettings
siteRoadmap.intro(必填)
string
siteRoadmap.updatedOn(必填)
string
siteRoadmap.buckets(必填)
SiteRoadmapBucket[]
siteRoadmap.buckets[].kind(必填)
enum;取值:shipped / now / next / later
siteRoadmap.buckets[].title(必填)
string
siteRoadmap.buckets[].theme(必填)
string
siteRoadmap.buckets[].enabled(必填)
boolean
siteRoadmap.buckets[].items(必填)
SiteRoadmapItem[]
siteCredits
PlatformSiteCreditsSettings
siteCredits.intro(必填)
string
siteCredits.groups(必填)
SiteCreditGroup[]
siteCredits.groups[].title(必填)
string
siteCredits.groups[].description(必填)
string
siteCredits.groups[].enabled(必填)
boolean
siteCredits.groups[].people(必填)
SiteCreditPerson[]
siteHome
PlatformSiteHomeSettings
siteHome.videoUrl(必填)
string

错误

请求示例(curl)

curl -X PUT "https://你的项目.workflow.games/api/v1/admin/settings" \
  -H "Authorization: Bearer wfp_…" \
  -H "content-type: application/json" \
  --data '{"allowSignups":true,"announcement":"示例文本","opsLinks":[{"label":"示例文本","url":"https://example.com"}],"acknowledgements":[{"icon":"heart","name":"示例标题","enabled":true}]}'

响应示例

HTTP/1.1 200
{
  "allowSignups": true,
  "announcement": "示例文本",
  "opsLinks": [
    {
      "label": "示例文本",
      "url": "https://example.com"
    }
  ],
  "acknowledgements": [
    {
      "icon": "heart",
      "name": "示例标题",
      "enabled": true
    }
  ],
  "smtp": {
    "host": "示例文本",
    "port": 1,
    "username": "示例标题",
    "from": "示例文本",
    "fromName": "示例标题",
    "useTls": true,
    "passwordConfigured": true
  },
  "sentry": {
    "frontendDsn": "示例文本",
    "environment": "示例文本",
    "backendDsnConfigured": true
  },
  "attachmentStorage": {
    "endpoint": "示例文本",
    "region": "示例文本",
    "bucket": "示例文本",
    "accessKeyId": "018f3c2e-0000-7000-8000-000000000000",
    "usePathStyle": true,
    "keyPrefix": "示例文本",
    "secretAccessKeyConfigured": true,
    "configured": true
  },
  "support": {
    "enabled": true,
    "projectId": "018f3c2e-0000-7000-8000-000000000000",
    "actorUserId": "018f3c2e-0000-7000-8000-000000000000",
    "defaultOwnerId": "018f3c2e-0000-7000-8000-000000000000",
    "feishuGroupLink": "https://example.com",
    "feishuGroupQrUrl": "https://example.com",
    "contactEmail": "[email protected]",
    "chatGreeting": "示例文本",
    "chatFallbackReply": "示例文本",
    "cannedReplies": [
      {
        "keywords": [],
        "reply": "示例文本"
      }
    ]
  }
}

合同真值:OpenAPI 3.1(0.1.0)。

相关:Agent 接入指南 · 使用指南 · API 参考索引

Workflow 正在加载…