# Obtenir les droits commerciaux URL canonique : https://sosoapi.ai/fr/docs/api/identity-api-commercial-access-status Contrat : sha256:563d2d581da0ad29 Lire le forfait et les quotas du compte de facturation d’un espace de travail, ainsi que son commercial_access_mode (off, shadow ou enforce). POST /identity-api/commercial-access/status ## Authentification et autorisations - **Types d’identifiants acceptés:** user_session, delegated_oauth, personal_access_token - **Capacité déléguée:** agent:operate - **Rôle minimal dans l’espace de travail:** Aucun rôle minimal d’espace de travail dans ce contrat ; les contrôles de propriété et d’autorisation s’appliquent toujours. - **Périmètre d’accès:** Ressources auxquelles cet utilisateur est autorisé à accéder - **Consentement pour tous les espaces requis:** Non - **Modifie l’état:** Non - **Lorsque l’opération est terminée:** synchronous_http_response Un jeton ne peut utiliser que les droits de son propriétaire. Chaque requête vérifie l’appartenance à l’espace, la propriété des ressources, les espaces sélectionnés et les capacités accordées. Les profils core et full modifient les outils affichés ; ils n’accordent aucun accès. ## Champs de requête ```json { "$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 } ``` ## Réponse et achèvement Statuts HTTP de réussite : 200 Une réponse HTTP réussie peut signifier qu’une requête est acceptée plutôt que terminée. Pour le travail en arrière-plan, conservez l’identifiant renvoyé et suivez la même opération jusqu’à sa fin. Une publication programmée ou acceptée n’est publiée que lorsque la plateforme le confirme ; une expiration côté client ne détermine pas le résultat. ```json { "$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" ] } ``` ## Erreurs et nouvelles tentatives sûres Vérifiez le statut HTTP et le corps de réponse. Une erreur de validation 400 peut contenir un ZodError ; les erreurs des gestionnaires utilisent les champs error, message et code. Conservez request_id ou x-request-id pour le diagnostic, sans identifiants secrets. Corrigez les erreurs d’accès 401/403 avant de réessayer et respectez Retry-After pour 429. Si une écriture est incertaine ou renvoie 5xx, lisez d’abord le résultat existant. Réutilisez une clé d’idempotence uniquement lorsque c’est pris en charge ; le comportement des nouvelles tentatives varie selon l’opération et ne garantit pas une diffusion exactement une fois. ## Exemples Ces exemples utilisent des valeurs fictives vérifiées contre les schémas. Remplacez les identifiants par ceux que vous êtes autorisé à utiliser, les médias par des ressources prêtes et les dates par l’heure confirmée. Vérifiez l’éligibilité du compte avant toute écriture. Cette page n’envoie aucune requête API. Définissez SOSOAPI_ACCESS_TOKEN sur votre serveur avec un identifiant accepté par cette opération et gardez-le hors du code navigateur. Pour un agent, utilisez sosoapi auth login pour vous connecter dans le navigateur et laissez la CLI actualiser ses identifiants. request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111" } ``` cURL ```bash 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 ```js // 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 ```bash npx sosoapi api post /identity-api/commercial-access/status < request.json ``` Exemple de réponse fictive ```json { "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" } ``` ## Outils et guides associés MCP: sosoapi_get_commercial_access [Référence API](https://sosoapi.ai/fr/docs/api)