{ "components": { "schemas": { "Checkout": { "allOf": [ { "$ref": "#/components/schemas/Order" }, { "properties": { "checkout_url": { "format": "uri", "type": "string" }, "fulfillment": { "type": "string" } }, "required": [ "fulfillment" ], "type": "object" } ] }, "Credential": { "properties": { "license_key": { "description": "Somente para o SDK oficial; nunca autorize o acesso inspecionando este valor.", "type": "string", "x-sensitive": true }, "product_id": { "format": "uuid", "type": "string" }, "valid_until": { "format": "date-time", "type": [ "string", "null" ] }, "version": { "minimum": 1, "type": "integer" } }, "required": [ "product_id", "license_key", "valid_until", "version" ], "type": "object" }, "EntitlementStatus": { "properties": { "account_url": { "format": "uri", "type": "string" }, "code": { "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "max_retry_attempts": { "minimum": 0, "type": "integer" }, "message": { "type": "string" }, "next_action": { "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "retry_after_seconds": { "minimum": 0, "type": "integer" }, "status": { "enum": [ "ready", "pending", "expired", "suspended", "not_purchased" ], "type": "string" }, "synchronized": { "type": "boolean" }, "valid_from": { "format": "date-time", "type": [ "string", "null" ] }, "valid_until": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "product_id", "environment", "status", "code", "message", "next_action", "account_url", "synchronized", "retry_after_seconds", "max_retry_attempts" ], "type": "object" }, "Error": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "error", "request_id" ], "type": "object" }, "ExternalCapabilities": { "additionalProperties": false, "properties": { "connection_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "delivery_types": { "items": { "enum": [ "license_key", "activation_url", "instructions" ], "type": "string" }, "minItems": 1, "type": "array" }, "devices": { "const": false, "type": "boolean" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "identity_exchange": { "const": false, "type": "boolean" }, "protocol": { "const": "launch-external-licensing-v1", "type": "string" }, "purchase_types": { "items": { "enum": [ "perpetual", "fixed_term" ], "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "protocol", "connection_ref", "environment", "purchase_types", "delivery_types" ], "type": "object" }, "ExternalCapabilitiesResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ExternalCapabilities" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "ExternalConnection": { "additionalProperties": false, "properties": { "activation_origins": { "items": { "format": "uri", "type": "string" }, "type": "array" }, "allow_local_http": { "type": "boolean" }, "allow_private_network": { "type": "boolean" }, "base_url": { "format": "uri", "type": "string" }, "capabilities": { "$ref": "#/components/schemas/ExternalCapabilities" }, "connection_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "credential_stored": { "type": "boolean" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "key_id": { "type": "string" }, "last_check_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_checked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "provider": { "const": "custom_http", "type": "string" } }, "required": [ "id", "provider", "name", "base_url", "environment", "connection_ref", "key_id", "credential_stored", "allow_private_network", "allow_local_http", "activation_origins", "capabilities", "last_checked_at", "last_check_error" ], "type": "object" }, "ExternalConnectionInput": { "additionalProperties": false, "properties": { "activation_origins": { "items": { "format": "uri", "type": "string" }, "type": "array" }, "allow_local_http": { "default": false, "description": "Somente HTTP em loopback no sandbox é permitido.", "type": "boolean" }, "allow_private_network": { "default": false, "type": "boolean" }, "base_url": { "format": "uri", "maxLength": 512, "type": "string" }, "connection_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "key_id": { "maxLength": 64, "minLength": 1, "type": "string" }, "name": { "maxLength": 160, "minLength": 2, "type": "string" }, "provider": { "const": "custom_http", "type": "string" }, "signing_key": { "description": "Base64 padrão de 32-128 bytes aleatórios; obrigatório na criação, vazio mantém a chave existente na edição.", "maxLength": 180, "type": "string", "writeOnly": true } }, "required": [ "provider", "name", "base_url", "environment", "connection_ref", "key_id" ], "type": "object" }, "ExternalConnectionResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ExternalConnection" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "ExternalDelivery": { "additionalProperties": false, "properties": { "connection_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDeliveryValue" }, { "type": "null" } ] }, "entitlement_ref": { "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "status": { "enum": [ "pending", "ready", "unavailable" ], "type": "string" }, "version": { "minimum": 1, "type": "integer" } }, "required": [ "connection_ref", "environment", "entitlement_ref", "version", "status", "delivery" ], "type": "object" }, "ExternalDeliveryResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ExternalDelivery" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "ExternalDeliveryValue": { "additionalProperties": false, "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "type": { "enum": [ "license_key", "activation_url", "instructions" ], "type": "string" }, "value": { "description": "Conteúdo sensível; máximo de 4096 bytes UTF-8. Nunca registrar nos logs. Os URLs de ativação devem usar uma origem HTTPS configurada.", "maxLength": 4096, "type": "string" } }, "required": [ "type", "value", "expires_at" ], "type": "object" }, "ExternalError": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "request_id": { "type": "string" } }, "required": [ "error", "request_id" ], "type": "object" }, "ExternalMapping": { "additionalProperties": false, "properties": { "connection_id": { "format": "uuid", "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "plan_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "product_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "version_id": { "format": "uuid", "type": "string" } }, "required": [ "version_id", "environment", "connection_id", "product_ref", "plan_ref" ], "type": "object" }, "ExternalMappingInput": { "additionalProperties": false, "properties": { "plan_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "product_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "version_id": { "format": "uuid", "type": "string" } }, "required": [ "version_id", "product_ref", "plan_ref" ], "type": "object" }, "ExternalReceipt": { "additionalProperties": false, "properties": { "connection_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "entitlement_ref": { "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "error_code": { "anyOf": [ { "maxLength": 96, "type": "string" }, { "type": "null" } ] }, "event_id": { "format": "uuid", "type": "string" }, "payload_sha256": { "pattern": "^[0-9a-f]{64}$", "type": "string" }, "status": { "enum": [ "pending", "applied", "rejected", "manual_review" ], "type": "string" }, "version": { "minimum": 1, "type": "integer" } }, "required": [ "event_id", "connection_ref", "environment", "entitlement_ref", "version", "payload_sha256", "status", "error_code" ], "type": "object" }, "ExternalReceiptResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/ExternalReceipt" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "ExternalSnapshot": { "additionalProperties": false, "properties": { "account_ref": { "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "change_reason": { "enum": [ "purchase", "renewal", "upgrade", "refund", "reversal", "suspension", "resumption", "expiry", "reconciliation" ], "type": "string" }, "connection_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "desired_state": { "enum": [ "active", "suspended", "expired", "revoked" ], "type": "string" }, "entitlement_ref": { "pattern": "^[A-Za-z0-9_-]{1,128}$", "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "event_id": { "format": "uuid", "type": "string" }, "launch_plan_version_id": { "format": "uuid", "type": "string" }, "launch_product_id": { "format": "uuid", "type": "string" }, "plan_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "product_ref": { "pattern": "^[A-Za-z0-9_.-]{1,128}$", "type": "string" }, "schema": { "const": "launch-external-licensing-v1", "type": "string" }, "type": { "const": "entitlement.snapshot", "type": "string" }, "valid_from": { "format": "date-time", "type": "string" }, "valid_until": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "version": { "minimum": 1, "type": "integer" } }, "required": [ "schema", "event_id", "connection_ref", "environment", "type", "change_reason", "account_ref", "entitlement_ref", "launch_product_id", "launch_plan_version_id", "product_ref", "plan_ref", "version", "desired_state", "valid_from", "valid_until" ], "type": "object" }, "HealthResponse": { "properties": { "data": { "properties": { "status": { "const": "ok" } }, "required": [ "status" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" }, "IntegrationBundle": { "properties": { "checked_at": { "format": "date-time", "type": "string" }, "checks": { "items": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "required": [ "code", "status", "message" ], "type": "object" }, "type": "array" }, "config": { "additionalProperties": false, "properties": { "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "launch_product_id": { "format": "uuid", "type": "string" }, "licentivo_product_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "const": "" } ], "description": "Vazio somente quando uma verificação com falha não conseguiu resolver um mapeamento." }, "merchant_origin": { "format": "uri", "type": "string" }, "schema_version": { "const": 1, "type": "integer" } }, "required": [ "schema_version", "merchant_origin", "launch_product_id", "licentivo_product_id", "environment" ], "type": "object" }, "example_path": { "type": "string" }, "language": { "enum": [ "go", "python", "csharp", "java", "javascript", "rust", "ruby", "c", "cpp", "web" ], "type": "string" }, "product_config": { "$ref": "#/components/schemas/PublicProductConfig" }, "ready": { "type": "boolean" } }, "required": [ "ready", "config", "checks", "language", "example_path", "checked_at" ], "type": "object" }, "LaunchIdentity": { "additionalProperties": false, "properties": { "audience": { "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "identity_token": { "description": "Asserção de identidade de curta duração, de no máximo 120 segundos; nunca uma autorização de execução.", "type": "string" }, "launch_connection_id": { "format": "uuid", "type": "string" }, "licentivo_product_id": { "format": "uuid", "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "token_type": { "type": "string" } }, "required": [ "identity_token", "token_type", "product_id", "licentivo_product_id", "launch_connection_id", "environment", "audience", "expires_at" ], "type": "object" }, "LicensingConnections": { "additionalProperties": false, "properties": { "bindings": { "items": { "$ref": "#/components/schemas/ProductLicensingBinding" }, "type": "array" }, "connections": { "items": { "$ref": "#/components/schemas/ExternalConnection" }, "type": "array" }, "default_provider": { "description": "O único provedor de licenciamento ativo para todos os produtos e ambos os ambientes.", "enum": [ "licentivo", "custom_http" ], "type": "string" }, "mappings": { "items": { "$ref": "#/components/schemas/ExternalMapping" }, "type": "array" } }, "required": [ "connections", "bindings", "mappings", "default_provider" ], "type": "object" }, "LicensingConnectionsResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicensingConnections" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "LicensingProviderInput": { "additionalProperties": false, "properties": { "provider": { "enum": [ "licentivo", "custom_http" ], "type": "string" } }, "required": [ "provider" ], "type": "object" }, "LicensingSaved": { "additionalProperties": false, "properties": { "saved": { "const": true, "type": "boolean" } }, "required": [ "saved" ], "type": "object" }, "LicensingSavedResponse": { "additionalProperties": false, "properties": { "data": { "$ref": "#/components/schemas/LicensingSaved" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" }, "LicentivoConnectionInput": { "additionalProperties": false, "properties": { "api_key": { "description": "Obrigatório para a primeira conexão. Omita ou deixe vazio para manter a chave salva no servidor.", "type": "string", "writeOnly": true }, "webhook_secret": { "description": "Segredo opcional de 32–256 bytes. Omita ou deixe vazio para manter o segredo salvo.", "type": "string", "writeOnly": true } }, "type": "object" }, "Order": { "properties": { "action": { "type": "string" }, "amount_minor": { "type": "integer" }, "created_at": { "format": "date-time", "type": "string" }, "currency": { "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "id": { "format": "uuid", "type": "string" }, "paid_at": { "format": "date-time", "type": [ "string", "null" ] }, "plan_name": { "type": "string" }, "plan_version": { "type": "integer" }, "plan_version_id": { "format": "uuid", "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "product_name": { "type": "string" }, "product_slug": { "type": "string" }, "purchase_periods": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "id", "product_id", "product_name", "product_slug", "plan_version_id", "plan_name", "plan_version", "action", "status", "currency", "amount_minor", "purchase_periods", "created_at", "paid_at", "environment" ], "type": "object" }, "ProductLicensingBinding": { "additionalProperties": false, "properties": { "connection_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ] }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "licentivo", "custom_http" ], "type": "string" } }, "required": [ "product_id", "environment", "provider", "connection_id" ], "type": "object" }, "ProductLicensingInput": { "additionalProperties": false, "properties": { "connection_id": { "description": "UUID da conexão externa; obrigatório para custom_http.", "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "mappings": { "items": { "$ref": "#/components/schemas/ExternalMappingInput" }, "type": "array" }, "provider": { "description": "Deve corresponder ao provedor de licenciamento ativo em toda a instância. Configure-o primeiro com PUT /api/v1/admin/licensing/provider.", "enum": [ "licentivo", "custom_http" ], "type": "string" } }, "required": [ "provider", "environment" ], "type": "object" }, "PublicLaunchConfig": { "additionalProperties": false, "properties": { "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "launch_product_id": { "format": "uuid", "type": "string" }, "licentivo_product_id": { "format": "uuid", "type": "string" }, "merchant_origin": { "format": "uri", "type": "string" }, "schema_version": { "const": 1, "type": "integer" } }, "required": [ "schema_version", "merchant_origin", "launch_product_id", "licentivo_product_id", "environment" ], "type": "object" }, "PublicProductConfig": { "additionalProperties": false, "description": "Configuração pública sem dados sensíveis. A procedência da chave de assinatura deve ser verificada pelo comerciante.", "properties": { "app_version": { "type": "string" }, "base_url": { "format": "uri", "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "trusted_keys": { "additionalProperties": { "pattern": "^[A-Za-z0-9_-]{43}$", "type": "string" }, "maxProperties": 32, "minProperties": 1, "propertyNames": { "description": "Os identificadores de chaves têm 1–128 bytes UTF-8.", "minLength": 1, "type": "string", "x-maxBytes": 128 }, "type": "object" } }, "required": [ "product_id", "trusted_keys", "base_url" ], "type": "object" }, "PublicProductImport": { "additionalProperties": false, "description": "Configuração pública de produto do Launch, preenchida a partir do ID oficial do produto e das chaves públicas de assinatura. JSON legado com license_key/cache_path vazios e allow_http false é aceito e esses campos são removidos. Segredos preenchidos e campos desconhecidos são rejeitados.", "properties": { "allow_http": { "const": false }, "app_version": { "description": "No máximo 80 bytes UTF-8.", "type": "string", "x-maxBytes": 80 }, "base_url": { "format": "uri", "type": "string" }, "cache_path": { "const": "" }, "device_name": { "maxLength": 128, "type": "string" }, "license_key": { "const": "" }, "product_id": { "format": "uuid", "type": "string" }, "trusted_keys": { "additionalProperties": { "pattern": "^[A-Za-z0-9_-]{43}$", "type": "string" }, "maxProperties": 32, "minProperties": 1, "propertyNames": { "description": "Os identificadores de chaves têm 1–128 bytes UTF-8.", "minLength": 1, "type": "string", "x-maxBytes": 128 }, "type": "object" } }, "required": [ "product_id", "trusted_keys" ], "type": "object" }, "ReadinessResponse": { "properties": { "data": { "properties": { "code": { "enum": [ "DATABASE_NOT_CONFIGURED", "DATABASE_UNAVAILABLE", "DATABASE_SCHEMA_NOT_READY" ] }, "status": { "enum": [ "ready", "not_ready" ] } }, "required": [ "status" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" }, "RequestID": { "description": "Também retornado no cabeçalho de resposta X-Request-ID", "pattern": "^[a-f0-9]{32}$", "type": "string" }, "SessionGrant": { "properties": { "access_token": { "description": "Retornado somente no login desktop. Trate como segredo; nunca o coloque em URLs ou logs.", "type": "string", "x-sensitive": true }, "expires_at": { "format": "date-time", "type": "string" }, "kind": { "enum": [ "website", "desktop" ], "type": "string" }, "user": { "$ref": "#/components/schemas/User" } }, "required": [ "user", "kind", "expires_at" ], "type": "object" }, "SessionView": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "current": { "type": "boolean" }, "expires_at": { "format": "date-time", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "kind": { "enum": [ "website", "desktop" ], "type": "string" } }, "required": [ "id", "kind", "created_at", "expires_at", "current" ], "type": "object" }, "User": { "properties": { "email": { "format": "email", "type": "string" }, "full_access": { "type": "boolean" }, "id": { "format": "uuid", "type": "string" }, "password_change_required": { "type": "boolean" }, "role": { "enum": [ "customer", "admin", "operations", "support" ], "type": "string" }, "verified": { "type": "boolean" } }, "required": [ "id", "email", "verified", "role", "full_access", "password_change_required" ], "type": "object" } }, "securitySchemes": { "desktopBearer": { "description": "Sessão desktop opaca de auth/login com kind=desktop.", "scheme": "bearer", "type": "http" }, "websiteCookie": { "description": "Sessão de navegador. As alterações também exigem Origin correspondente e X-CSRF-Token de launch_csrf.", "in": "cookie", "name": "launch_session", "type": "apiKey" } } }, "info": { "description": "APIs de sistema, contas, licenciamento desktop, assistente de integração e compras básicas. Não é a API completa de administração de pessoal e webhooks de pagamento. O acesso em execução ainda deve passar pelo SDK oficial do Licentivo. A verificação de e-mail é obrigatória somente quando ativada pelo comerciante. Conexões de licenciamento personalizado e entrega ao cliente também são documentadas. Os endpoints dos receptores externos são especificados separadamente em external-licensing-openapi.json.", "license": { "identifier": "MIT", "name": "MIT" }, "title": "API de integração do Licentivo Launch", "version": "0.3.4-beta", "x-document-language": "pt" }, "openapi": "3.1.0", "paths": { "/api/v1/admin/connections/licentivo": { "post": { "operationId": "configureLicentivoConnection", "parameters": [ { "in": "header", "name": "X-CSRF-Token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicentivoConnectionInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": true, "description": "Identidade da conexão, capacidades verificadas e catálogo. Os segredos salvos nunca são retornados.", "type": "object" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "websiteCookie": [] } ], "summary": "Validar e salvar a conexão administrativa do Licentivo no servidor", "tags": [ "Licentivo connection" ] } }, "/api/v1/admin/identity-notifications/{id}/retry": { "post": { "operationId": "retryIdentityNotification", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "reason": { "maxLength": 500, "minLength": 2, "type": "string" } }, "required": [ "reason" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "Uma nova tentativa foi agendada para a notificação original" }, "403": { "description": "São necessárias permissões de administrador" }, "409": { "description": "A notificação foi concluída ou está em processamento" } }, "security": [ { "websiteCookie": [] } ], "summary": "Repetir a notificação de revogação de segurança da conta (administrador)" } }, "/api/v1/admin/integration/check": { "post": { "description": "Exige o papel admin. Chamadores pelo site devem fornecer Origin e X-CSRF-Token. ready=false informa configuração incompleta; nenhum campo secreto é retornado. licentivo_product_id pode estar vazio em um relatório incompleto.", "operationId": "checkApplicationIntegration", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "language": { "enum": [ "go", "python", "csharp", "java", "javascript", "rust", "ruby", "c", "cpp", "web" ], "type": "string" }, "product_id": { "format": "uuid", "type": "string" } }, "required": [ "product_id", "environment", "language" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/IntegrationBundle" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Ler automaticamente o mapeamento do software selecionado e as chaves públicas de assinatura para inicialização direta do SDK", "tags": [ "Application integration" ] } }, "/api/v1/admin/integration/context": { "get": { "description": "Exige o papel admin. Chamadores pelo site devem fornecer Origin e X-CSRF-Token. ready=false informa configuração incompleta; nenhum campo secreto é retornado. licentivo_product_id pode estar vazio em um relatório incompleto.", "operationId": "getIntegrationContext", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "additionalProperties": false, "properties": { "licensing_origin": { "type": "string" }, "merchant_origin": { "type": "string" } }, "required": [ "merchant_origin", "licensing_origin" ], "type": "object" }, "request_id": { "type": "string" } }, "required": [ "data" ], "type": "object" } } }, "description": "Contexto público da implantação; nenhuma configuração privada de inicialização" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Consultar a origem configurada do comerciante e a origem fixa de licenciamento", "tags": [ "Application integration" ] } }, "/api/v1/admin/licensing/connections": { "get": { "operationId": "listLicensingChoices", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicensingConnectionsResponse" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Listar conexões externas, vínculos de produtos e mapeamentos; as configurações do Licentivo mantêm a API existente", "tags": [ "Custom licensing" ] }, "post": { "operationId": "createExternalLicensingConnection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalConnectionInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalConnectionResponse" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Verificar e salvar uma conexão HTTP de licenciamento personalizada", "tags": [ "Custom licensing" ] } }, "/api/v1/admin/licensing/connections/{id}": { "put": { "operationId": "updateExternalLicensingConnection", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalConnectionInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalConnectionResponse" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Editar metadados/chaves de assinatura; destino, ambiente e política de rede são imutáveis", "tags": [ "Custom licensing" ] } }, "/api/v1/admin/licensing/connections/{id}/check": { "post": { "operationId": "checkExternalLicensingConnection", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalConnectionResponse" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Atualizar capacidades; last_check_error diferencia uma verificação com falha na resposta 200", "tags": [ "Custom licensing" ] } }, "/api/v1/admin/licensing/provider": { "put": { "operationId": "selectLicensingProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicensingProviderInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicensingSavedResponse" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Ativar um provedor de licenciamento para toda a instância; a troca exige migração quando existem pedidos de outros provedores", "tags": [ "Custom licensing" ] } }, "/api/v1/admin/products/{id}/licensing": { "put": { "operationId": "configureProductLicensing", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductLicensingInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicensingSavedResponse" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Configurar a conexão do produto e os mapeamentos de planos para um ambiente usando o provedor de licenciamento ativo", "tags": [ "Custom licensing" ] } }, "/api/v1/admin/refunds/{id}/reconcile": { "post": { "description": "O administrador confere o reembolso original e recupera a mesma operação após verificar a transação original, o valor e a moeda no recibo do canal. Sem recibo, só é possível repetir a solicitação idempotente original dentro de 23 horas após a aprovação original no Stripe/PayPal; após esse prazo, é necessário informar o identificador de reembolso do canal original. A operação é registrada na auditoria e não cria um novo identificador de operação de reembolso.", "operationId": "reconcileRefund", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "external_refund_id": { "maxLength": 128, "type": "string" }, "reason": { "maxLength": 500, "minLength": 2, "type": "string" } }, "required": [ "reason" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "A tarefa original voltou à fila" }, "403": { "description": "São necessárias permissões de administrador e credenciais CSRF válidas" }, "409": { "description": "Conflito de estado, recibo incompatível ou identificador de reembolso do canal original necessário" }, "503": { "description": "A consulta ao canal original está temporariamente indisponível" } }, "security": [ { "websiteCookie": [] } ], "summary": "Conferir e recuperar a tarefa de reembolso original" } }, "/api/v1/auth/complete-email": { "post": { "operationId": "completeAccountEmail", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "password": { "type": "string", "writeOnly": true }, "token": { "type": "string", "writeOnly": true } }, "required": [ "token" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "completed": { "type": "boolean" } }, "required": [ "completed" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [], "summary": "Concluir uma credencial de e-mail de uso único", "tags": [ "Application integration" ] } }, "/api/v1/auth/email": { "post": { "operationId": "requestAccountEmail", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" }, "kind": { "enum": [ "verify", "reset" ], "type": "string" } }, "required": [ "email", "kind" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [], "summary": "Solicitar um e-mail de verificação ou recuperação de senha", "tags": [ "Application integration" ] } }, "/api/v1/auth/identity-keys": { "get": { "operationId": "launchIdentityPublicKeys", "responses": { "200": { "description": "Chaves públicas Ed25519; nunca material privado de assinatura" } }, "summary": "Chaves públicas de assinatura fixadas para a identidade de contas do Launch" } }, "/api/v1/auth/login": { "post": { "description": "Defina kind=desktop para aplicações e omita o cabeçalho Origin do navegador. O login no site define cookies e omite access_token.", "operationId": "login", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" }, "kind": { "default": "website", "enum": [ "desktop", "website" ], "type": "string" }, "password": { "type": "string", "writeOnly": true } }, "required": [ "email", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/SessionGrant" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [], "summary": "Entrar no site ou no desktop", "tags": [ "Application integration" ] } }, "/api/v1/auth/logout": { "post": { "operationId": "logout", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": {}, "required": [], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "completed": { "type": "boolean" } }, "required": [ "completed" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Revogar a sessão atual; encerrar o SDK, limpar os dados locais e liberar o dispositivo continuam sendo ações distintas", "tags": [ "Application integration" ] } }, "/api/v1/auth/register": { "post": { "operationId": "registerCustomer", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "format": "email", "type": "string" }, "password": { "description": "12–128 bytes UTF-8 (o servidor conta bytes, não caracteres Unicode).", "type": "string", "writeOnly": true, "x-maxBytes": 128, "x-minBytes": 12 } }, "required": [ "email", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "accepted": { "type": "boolean" } }, "required": [ "accepted" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [], "summary": "Registrar um cliente; a verificação segue as configurações de e-mail do comerciante", "tags": [ "Application integration" ] } }, "/api/v1/licensing/documentation": { "get": { "operationId": "readExternalLicensingGuide", "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "Documento público" } }, "security": [], "summary": "Documentação pública de licenciamento externo" } }, "/api/v1/licensing/protocol": { "get": { "operationId": "readExternalLicensingProtocol", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Documento público" } }, "security": [], "summary": "Documentação pública de licenciamento externo" } }, "/api/v1/me": { "get": { "operationId": "currentUser", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "session_id": { "format": "uuid", "type": "string" }, "user": { "$ref": "#/components/schemas/User" } }, "required": [ "user", "session_id" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Consultar a conta autenticada", "tags": [ "Application integration" ] } }, "/api/v1/me/orders": { "get": { "operationId": "listOrders", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Order" }, "type": "array" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Listar os pedidos do cliente atual", "tags": [ "Application integration" ] } }, "/api/v1/me/products/{id}/delivery": { "get": { "operationId": "readOwnedExternalDelivery", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "environment", "required": true, "schema": { "enum": [ "sandbox", "live" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalDeliveryResponse" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Configuração/entrada inválida" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Autenticação necessária" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Administrador obrigatório, CSRF inválido ou escopo proibido" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Nenhum recurso próprio" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Mapeamento imutável, migração necessária ou compra não pronta" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Limite de taxa atingido" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Armazenamento/serviço externo indisponível" } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Consultar a entrega externa própria atual; nunca é uma decisão de autorização de execução", "tags": [ "Custom licensing" ] } }, "/api/v1/me/sessions": { "get": { "operationId": "listSessions", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "$ref": "#/components/schemas/SessionView" }, "type": "array" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Listar as sessões ativas da conta", "tags": [ "Application integration" ] } }, "/api/v1/me/sessions/{id}": { "delete": { "operationId": "revokeSession", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "completed": { "type": "boolean" } }, "required": [ "completed" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Revogar uma sessão própria", "tags": [ "Application integration" ] } }, "/api/v1/orders": { "post": { "description": "Os preços são calculados no servidor. Renovação e upgrade exigem uma cotação emitida pelo servidor. Siga o checkout hospedado; o retorno por redirecionamento não comprova o pagamento.", "operationId": "createCheckout", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "action": { "enum": [ "purchase", "renew", "upgrade" ], "type": "string" }, "environment": { "enum": [ "sandbox", "live" ], "type": "string" }, "idempotency_key": { "description": "Identificador estável da operação, com 16–80 bytes UTF-8. Reutilize a mesma chave nas novas tentativas da mesma operação.", "type": "string", "x-maxBytes": 80, "x-minBytes": 16 }, "plan_version_id": { "format": "uuid", "type": "string" }, "product_id": { "format": "uuid", "type": "string" }, "provider": { "enum": [ "stripe", "paypal", "waffo", "paddle" ], "type": "string" }, "purchase_periods": { "minimum": 1, "type": "integer" }, "quote_token": { "type": "string", "writeOnly": true } }, "required": [ "product_id", "plan_version_id", "environment", "provider", "idempotency_key" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Checkout" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Criar ou recuperar um checkout próprio usando uma chave de idempotência estável", "tags": [ "Application integration" ] } }, "/api/v1/orders/{id}": { "get": { "operationId": "getOrder", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Checkout" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Consultar um pedido próprio e o progresso da entrega", "tags": [ "Application integration" ] } }, "/api/v1/orders/{id}/reconcile": { "post": { "operationId": "reconcileOrder", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": {}, "required": [], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/Checkout" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] }, { "websiteCookie": [] } ], "summary": "Consultar o provedor de pagamento sobre um pedido próprio", "tags": [ "Application integration" ] } }, "/api/v1/software/products/{id}/credential": { "post": { "deprecated": true, "description": "Sessões de navegador não podem obter chaves de licença. Nenhum ID de usuário escolhido pelo cliente é aceito. 403 ENTITLEMENT_PENDING inclui Retry-After: 3; as novas tentativas devem ser limitadas. EXPIRED/SUSPENDED exigem ação do usuário. 404 ENTITLEMENT_NOT_PURCHASED indica que nenhum direito é possuído.", "operationId": "softwareCredential", "parameters": [ { "description": "ID do produto no Launch, não o ID do produto no Licentivo.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "environment": { "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [ "environment" ], "type": "object" } } }, "required": true }, "responses": { "410": { "description": "LICENSE_CREDENTIAL_REMOVED; nenhuma chave de licença é retornada" } }, "security": [ { "desktopBearer": [] } ], "summary": "Removido: os SDKs de contas devem usar o intercâmbio de identidade", "tags": [ "Application integration" ] } }, "/api/v1/software/products/{id}/identity": { "post": { "operationId": "exchangeAccountIdentity", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "environment": { "enum": [ "sandbox", "live" ], "type": "string" } }, "required": [ "environment" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/LaunchIdentity" } }, "type": "object" } } }, "description": "Somente contexto de identidade. O Licentivo decide a autorização." }, "401": { "description": "Sessão da conta rejeitada" }, "503": { "description": "Conexão de identidade indisponível" } }, "security": [ { "desktopBearer": [] } ], "summary": "Obter uma asserção de identidade de conta de curta duração para o SDK oficial" } }, "/api/v1/software/products/{id}/status": { "get": { "description": "Estas são informações de compra/sincronização, não uma autorização de execução.", "operationId": "softwareStatus", "parameters": [ { "description": "ID do produto no Launch, não o ID do produto no Licentivo.", "in": "path", "name": "id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "query", "name": "environment", "required": false, "schema": { "default": "live", "enum": [ "sandbox", "live" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "$ref": "#/components/schemas/EntitlementStatus" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Resposta de sucesso" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Campos, ID de produto ou ambiente inválidos." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "LOGIN_FAILED (login) ou AUTH_REQUIRED (sessão vencida/revogada). Remova as sessões rejeitadas; nunca recorra a uma alternativa após uma recusa explícita." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Proibido, verificação de e-mail obrigatória, alteração inicial de senha obrigatória ou recusa explícita de direitos." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "RATE_LIMITED; não repita tentativas em um loop sem espera.", "headers": { "Retry-After": { "description": "Segundos a aguardar antes de outra tentativa. Respeite este valor e limite o total de novas tentativas.", "schema": { "minimum": 0, "type": "integer" } } } }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Falha temporária do serviço ou do banco de dados. O acesso offline só é permitido por uma autorização assinada válida do SDK oficial." } }, "security": [ { "desktopBearer": [] } ], "summary": "Consultar o status que orienta ações para o cliente autenticado e o produto solicitado", "tags": [ "Application integration" ] } }, "/api/v1/system/status": { "get": { "operationId": "getSystemStatus", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "implemented": { "items": { "type": "string" }, "type": "array" }, "phase": { "const": "local-development" }, "product": { "const": "Licentivo Launch" }, "sales_enabled": { "const": false }, "version": { "type": "string" } }, "required": [ "product", "version", "phase", "sales_enabled", "implemented" ], "type": "object" }, "request_id": { "$ref": "#/components/schemas/RequestID" } }, "required": [ "data", "request_id" ], "type": "object" } } }, "description": "Fase de desenvolvimento e escopo de implementação atuais" } }, "summary": "Expor a versão e o escopo da implementação sem configuração ou credenciais" } }, "/healthz": { "get": { "operationId": "getLiveness", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } }, "description": "O processo HTTP está em execução" } }, "summary": "Atividade do processo, independente da disponibilidade do banco de dados" } }, "/readyz": { "get": { "operationId": "getReadiness", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadinessResponse" } } }, "description": "O banco de dados está pronto; isso não certifica a aceitação de pagamentos ou licenciamento" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadinessResponse" } } }, "description": "O banco de dados não está configurado, está indisponível ou não possui as tabelas obrigatórias" } }, "summary": "Verificar a conectividade MySQL e as tabelas GORM obrigatórias" } } }, "servers": [ { "description": "Substitua pela origem do seu comércio; HTTP é permitido somente para desenvolvimento sandbox em loopback.", "url": "https://shop.example.com" } ] }