A keresés csak használatkor töltődik be. Alább minden kategória böngészhető.

Fiókok és munkaterületek

Kereskedelmi hozzáférés lekérése

Egy munkaterület számlázási fiókjának csomag- és kvótaadatai, valamint commercial_access_mode értéke (off, shadow vagy enforce).

POST /identity-api/commercial-access/status

Szerződés ellenőrizve: · sha256:563d2d581da0ad29

Áttekintés

Egy munkaterület számlázási fiókjának csomag- és kvótaadatai, valamint commercial_access_mode értéke (off, shadow vagy enforce).

A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.

Hitelesítés és engedélyek

Elfogadott hitelesítőadat-osztályok
user_session, delegated_oauth, personal_access_token
Delegált képesség
agent:operate
Minimális munkaterületi szerepkör
Ez a szerződés nem határoz meg minimális munkaterületi szerepkört; a tulajdonosi és engedélyellenőrzések továbbra is érvényesek.
Hozzáférési hatókör
A felhasználó számára engedélyezett erőforrások
Minden munkaterületre kiterjedő hozzájárulás szükséges
Nem
Állapotot módosít
Nem
A művelet befejezésekor
synchronous_http_response

A token csak a tulajdonosa jogait használhatja. Minden kérés ellenőrzi a munkaterületi tagságot, erőforrás-tulajdonjogot, kiválasztott munkaterületeket és megadott képességeket. A core és full profil a megjelenített eszközöket változtatja; hozzáférést nem ad.

Kérésmezők

A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.

Kérésmezők
Mező / ágTípus / kötelezőKorlátok
$objectA szülőn belül kötelező
  • additionalProperties: false
workspace_idstringA szülőn belül kötelező
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Teljes JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "workspace_id"
  ],
  "additionalProperties": false
}

Válasz és befejezés

Sikeres HTTP-állapotok: 200. A művelet befejezésekor: synchronous_http_response.

A sikeres HTTP-válasz jelentheti a kérés elfogadását, nem a befejezését. Háttérmunkánál mentsd a visszakapott azonosítót, és ugyanazt a műveletet ellenőrizd a befejezésig. Az időzített vagy elfogadott bejegyzés csak platformmegerősítés után közzétett; a kliens időtúllépése nem igazolja az eredményt.

A kötelező jelölés a szülőobjektumon és a kiválasztott ágon belül érvényes. A kötelező gyermek nem teszi kötelezővé az opcionális szülőt. Az alábbi szabályok és mezőnevek a szerződésből származnak.

Válasz és befejezés
Mező / ágTípus / kötelezőKorlátok
$objectA szülőn belül kötelező—
billing_account_idstringA szülőn belül kötelező
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
plan_keystringA szülőn belül kötelező
  • enum: ["free","founding_pro"]
plan_versionintegerA szülőn belül kötelező
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
payment_statestringA szülőn belül kötelező
  • minLength: 1
  • maxLength: 64
entitlement_sourcestringA szülőn belül kötelező
  • enum: ["default","stripe","internal_test","reconciliation","manual"]
has_stripe_customerbooleanA szülőn belül kötelező—
cycleobjectA szülőn belül kötelező—
cycle.period_startstringA szülőn belül kötelező
  • 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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
cycle.period_endstringA szülőn belül kötelező
  • 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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
cycle.reset_atstringA szülőn belül kötelező
  • 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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
quotaobjectA szülőn belül kötelező—
quota.successful_destination_publishesobjectA szülőn belül kötelező—
quota.successful_destination_publishes.limitintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.successful_destination_publishes.reservedintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.successful_destination_publishes.consumedintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.successful_destination_publishes.remainingintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.pending_scheduled_postsobjectA szülőn belül kötelező—
quota.pending_scheduled_posts.limitintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.pending_scheduled_posts.activeintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.pending_scheduled_posts.remainingintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.connected_social_accountsobjectA szülőn belül kötelező—
quota.connected_social_accounts.limitintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.connected_social_accounts.activeintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
quota.connected_social_accounts.remainingintegerA szülőn belül kötelező
  • minimum: 0
  • maximum: 9007199254740991
history_daysintegerA szülőn belül kötelező
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
capabilitiesobjectA szülőn belül kötelező
  • additionalProperties: {}
capabilities.*any JSON valueOpcionális / elem—
actor_user_idstringA szülőn belül kötelező
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
workspace_idstringA szülőn belül kötelező
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
billing_account_kindstringA szülőn belül kötelező
  • const: "personal"
commercial_access_modestringA szülőn belül kötelező
  • enum: ["off","shadow","enforce"]
Teljes JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "billing_account_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "plan_key": {
      "type": "string",
      "enum": [
        "free",
        "founding_pro"
      ]
    },
    "plan_version": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "payment_state": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "entitlement_source": {
      "type": "string",
      "enum": [
        "default",
        "stripe",
        "internal_test",
        "reconciliation",
        "manual"
      ]
    },
    "has_stripe_customer": {
      "type": "boolean"
    },
    "cycle": {
      "type": "object",
      "properties": {
        "period_start": {
          "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "period_end": {
          "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        },
        "reset_at": {
          "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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
        }
      },
      "required": [
        "period_start",
        "period_end",
        "reset_at"
      ]
    },
    "quota": {
      "type": "object",
      "properties": {
        "successful_destination_publishes": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "reserved": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "consumed": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "remaining": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "limit",
            "reserved",
            "consumed",
            "remaining"
          ]
        },
        "pending_scheduled_posts": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "active": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "remaining": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "limit",
            "active",
            "remaining"
          ]
        },
        "connected_social_accounts": {
          "type": "object",
          "properties": {
            "limit": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "active": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            },
            "remaining": {
              "type": "integer",
              "minimum": 0,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "limit",
            "active",
            "remaining"
          ]
        }
      },
      "required": [
        "successful_destination_publishes",
        "pending_scheduled_posts",
        "connected_social_accounts"
      ]
    },
    "history_days": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "capabilities": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "actor_user_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "billing_account_kind": {
      "type": "string",
      "const": "personal"
    },
    "commercial_access_mode": {
      "type": "string",
      "enum": [
        "off",
        "shadow",
        "enforce"
      ]
    }
  },
  "required": [
    "billing_account_id",
    "plan_key",
    "plan_version",
    "payment_state",
    "entitlement_source",
    "has_stripe_customer",
    "cycle",
    "quota",
    "history_days",
    "capabilities",
    "actor_user_id",
    "workspace_id",
    "billing_account_kind",
    "commercial_access_mode"
  ]
}

Hibák és biztonságos újrapróbálás

Ellenőrizd a HTTP-állapotot és a válasz törzsét. A 400 ellenőrzési hiba ZodError értéket tartalmazhat; a kezelőhibák az error, message és code mezőket használják. Őrizd meg a request_id vagy x-request-id értéket a diagnózishoz, hitelesítő adatok nélkül. Újrapróbálás előtt javítsd a 401/403 hozzáférési hibákat; 429 esetén kövesd a Retry-After értékét. Bizonytalan írás vagy 5xx válasz esetén előbb olvasd el a meglévő eredményt. Csak támogatott műveletnél használj újra idempotenciakulcsot; az újrapróbálás műveletenként eltér, és nem garantál pontosan egyszeri kézbesítést.

Hibaelhárítási útmutató

Példák

A példák sémákkal ellenőrzött képzeletbeli értékeket használnak. Az azonosítókat engedélyezettekre, a médiát kész tartalomelemekre, a dátumokat megerősített közzétételi időpontra cseréld. Írás beküldése előtt ellenőrizd a fiók jogosultságát. Ez az oldal nem küld API-kérést.

A szervereden állítsd a SOSOAPI_ACCESS_TOKEN értékét a művelet által elfogadott hitelesítő adatra, és tartsd távol a böngészőkódtól. Ügynökhöz a sosoapi auth login paranccsal jelentkezz be böngészőben, és hagyd, hogy a CLI frissítse a hitelesítő adatokat.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/commercial-access/status" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/commercial-access/status", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /identity-api/commercial-access/status < request.json

Szintetikus válaszpélda

{
  "billing_account_id": "11111111-1111-4111-8111-111111111111",
  "plan_key": "free",
  "plan_version": 1,
  "payment_state": "example",
  "entitlement_source": "default",
  "has_stripe_customer": false,
  "cycle": {
    "period_start": "2099-01-15T09:00:00Z",
    "period_end": "2099-01-15T09:00:00Z",
    "reset_at": "2099-01-15T09:00:00Z"
  },
  "quota": {
    "successful_destination_publishes": {
      "limit": 0,
      "reserved": 0,
      "consumed": 0,
      "remaining": 0
    },
    "pending_scheduled_posts": {
      "limit": 0,
      "active": 0,
      "remaining": 0
    },
    "connected_social_accounts": {
      "limit": 0,
      "active": 0,
      "remaining": 0
    }
  },
  "history_days": 1,
  "capabilities": {},
  "actor_user_id": "11111111-1111-4111-8111-111111111111",
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "billing_account_kind": "personal",
  "commercial_access_mode": "off"
}

MCP: sosoapi_get_commercial_access