开发者文档

计划统一领取概要

GET/api/publishing-plan-shares/:token

权限与前置条件

匿名可查看计划概要和剩余数量;登录后返回本人今日领取状态。

此接口仅支持浏览器登录,不接受 API Key。Cookie 写入仍需允许来源的 Origin 和 X-Requested-With: suren360。不能同时携带 Cookie 与 API Key。所有路径参数须使用真实 ID。

请求参数

token · 路径参数 · 必填字符串

Query 查询参数

无额外字段;联合结构请查看完整定义。

查看完整请求 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

调用示例

先通过浏览器统一登录,使用受控环境中的已有会话。 请替换部署地址与示例字段,不要将凭证粘贴到聊天或日志中。

cURL · 示例占位值需替换
curl --request GET \
  'https://YOUR_DEPLOYMENT_HOST/api/publishing-plan-shares/YOUR_token' \
  --cookie "$SUREN360_COOKIE"

响应结构

成功返回 HTTP 200 的 JSON 对象。下方为响应结构定义,不是虚构的业务数据。

字段类型必填约束
organizationobject是{"required":["name"],"additionalProperties":false}
projectstring是{}
deadlinestring是{"format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"}
totalinteger是{"minimum":0,"maximum":9007199254740991}
remaininginteger是{"minimum":0,"maximum":9007199254740991}
videoCountinteger是{"minimum":0,"maximum":9007199254740991}
imageTextCountinteger是{"minimum":0,"maximum":9007199254740991}
availabilitystring是{"enum":["available","daily_limited","exhausted","expired","stopped"]}
todayTaskToken联合类型是{"anyOf":[{"type":"string"},{"type":"null"}]}
查看完整响应 JSON Schema
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "organization": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "additionalProperties": false
    },
    "project": {
      "type": "string"
    },
    "deadline": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "total": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "remaining": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "videoCount": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "imageTextCount": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "availability": {
      "type": "string",
      "enum": [
        "available",
        "daily_limited",
        "exhausted",
        "expired",
        "stopped"
      ]
    },
    "todayTaskToken": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "organization",
    "project",
    "deadline",
    "total",
    "remaining",
    "videoCount",
    "imageTextCount",
    "availability",
    "todayTaskToken"
  ],
  "additionalProperties": false
}
查看错误码与重试规则