DocuSphere360 · Developer platform

Build governed PDF workflows with confidence.

Explore the DocuSphere360 PDF Studio interface contract for secure document sessions, previews, review comments, immutable revisions and Recovery360 draft synchronization.

UAT-gated contract · Production API on holdSeven guarded routes are now registered in UAT. Live document reads still require verified identity and trusted scan evidence; certified writes and recovery remain disabled. No production activation has occurred.
7 documented operations Tenant-aware access model Version-safe design
studio.bridge / referenceContract preview
DOCUMENTED REQUEST · NOT EXECUTABLE HERE
GET/{documentId}/studio/session

ILLUSTRATIVE CAPABILITY FLAGS
{
  "permissions": {
    "read": true,
    "save_revision": false
  },
  "recovery": {
    "draft_sync_enabled": false
  }
}
Clients must honor server-provided permissions and release gates.
Integration blueprint

From identity to governed revision.

A reference workflow for approved implementations. Each stage is subject to tenant permissions and explicit activation gates.

STEP 01

Authorize & scope

Establish verified identity, tenant entitlements, document ACLs and same-origin session context.

STEP 02

Open & review

Inspect capability flags, preview authorized PDF versions and read governed comments.

STEP 03

Revise with control

When certified, submit a PDF with its base version and SHA-256 fingerprint.

STEP 04

Recover safely

When enabled, synchronize encrypted drafts using generation preconditions and conflict handling.

API AVAILABILITY

Source contract versus running service

SurfaceNamespaceAvailability
Native DocuSphere360 PDF Studio bridge/api/docsphere360/v2/documents/{documentId}/studioUAT: seven guarded operations registered; production: not registered; write and draft-sync release gates remain closed
ERP360 embedded session authenticationSame-origin authenticated web session; verified identity and CSRF for mutationsContract design; application integration pending
Standalone Cloud API authorizationSeparate certified bearer/OIDC profile requiredNot certified for remote third-party access
Public API360 resource book/api/public/v1/docusphere360Distinct API adapter; must not be treated as the native editor runtime
API CONTRACT

Explore the Studio bridge operations

Search the seven native Studio bridge contracts below. Select an operation to review its behavior, prerequisites and release controls. These are documentation references, not live API calls.

Compare all seven documented operations in a table
MethodPath suffixFunction / gate
GET/{documentId}/studio/sessionAuthorized PDF session, tenant scope, editor and recovery availability
GET/{documentId}/studio/previewStream current or authorized historical PDF, optional ?version_id=UUID
GET/{documentId}/studio/commentsRead up to 100 governed review comments
POST/{documentId}/studio/saveNew canonical PDF revision; fail closed while editor/write gates disabled
GET/{documentId}/studio/draftRead owner-specific server draft; cloud sync disabled by default
PUT/{documentId}/studio/draftUpsert generation-controlled encrypted draft; cloud sync disabled by default
DELETE/{documentId}/studio/draftDiscard synchronized draft with generation precondition; cloud sync disabled by default
AUTHENTICATION

Identity, tenancy and CSRF

ERP-connected requests are designed for authenticated same-origin sessions with verified identity. Cookie-based mutations must include the application-approved CSRF token and use same-origin credentials. Cross-origin Cloud and machine-to-machine access must use a separately certified authorization profile; reusing a browser cookie for cross-origin access is not a supported shortcut.

Browser session example (illustrative — requires deployed bridge)
const response = await fetch(
  '/api/docsphere360/v2/documents/' + encodeURIComponent(documentId) + '/studio/session',
  { method: 'GET', credentials: 'same-origin',
    headers: { Accept: 'application/json' } }
);
if (!response.ok) throw new Error('Studio session unavailable: ' + response.status);
const session = await response.json();
// Honor session.permissions and session.editor.engine_bound.
// Never infer edit permission from a successful PDF preview.
SESSION RESPONSE

Use the server-provided capability flags

Representative JSON shape — values are illustrative
{
  "product": "docusphere360-pdf-studio",
  "repository": "docsphere360",
  "storage_mode": "canonical_document_versions",
  "document": {
    "id": "00000000-0000-4000-8000-000000000001",
    "mime_type": "application/pdf",
    "current_version": { "id": "00000000-0000-4000-8000-000000000002",
      "content_sha256": "<64-character-sha256>" }
  },
  "permissions": {
    "read": true,
    "recover_draft": false,
    "save_revision": false
  },
  "editor": { "engine_bound": false, "mode": "preview_and_versioned_revision" },
  "recovery": { "scope": "<opaque-recovery-scope>",
    "draft_sync_enabled": false,
    "draft_endpoint": "/api/docsphere360/v2/documents/{id}/studio/draft"
  },
  "urls": { "preview": ".../studio/preview", "comments": ".../studio/comments",
    "save": ".../studio/save", "versions": ".../versions",
    "download": ".../download" }
}

Do not synthesize server capability booleans. When editor.engine_bound or permissions.save_revision is false, offer preview/review only. When draft_sync_enabled is false, do not indicate that a local checkpoint has been synchronized to the server.

DOCUMENT PREVIEW & COMMENTS

Current or historical preview and review data

GET .../studio/preview returns same-origin PDF bytes with Content-Type: application/pdf, X-Content-SHA256, Cache-Control: private, no-store and frame restrictions. The optional version_id must be an authorized version belonging to the same document.

GET .../studio/comments reads up to 100 non-deleted annotations within the resolved tenant. The source returns comments with identifiers, version/page references, text, state, creator and timestamp. Read access does not confer write permission.

GOVERNED VERSION WRITES

Optimistic concurrency; immutable revision

When separately certified and enabled, POST .../studio/save requires a multipart PDF file (maximum 64 MiB in the candidate controller) plus base_version_id and a 64-character base_sha256. An optional version_label is limited to 64 characters.

Form payload fields (do not execute on inactive service)
file: <binary application/pdf>
base_version_id: <UUID of the current PDF version>
base_sha256: <64 hex characters of the current bytes>
version_label: "Reviewed changes"  # optional

If the authoritative PDF changed since the client opened it, the service returns 409 PDF_STUDIO_VERSION_CONFLICT. If revision-write or native-editor certification gates are disabled, it returns 503 PDF_STUDIO_REVISION_GATE_HOLD. A successful authorized write creates a new canonical version; it does not overwrite prior history.

RECOVERY360 DRAFT CONTRACT

Encrypted draft synchronization, when authorized

The three .../studio/draft operations use a tenant/user/document-scoped server record. The server draft is encrypted at rest and remains separate from the approved PDF version. The source controller refuses all draft operations until the sync flag is enabled and the recovery migration is installed.

PUT draft — representative request body
{
  "schema": 1,
  "base_version_id": "00000000-0000-4000-8000-000000000002",
  "base_sha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "note": "Review these figures before publishing",
  "operations": [],
  "updated_at": 1790000000000,
  "generation": 1,
  "expected_generation": 0
}
FieldDescriptionLimit / behavior
schemaDraft contract versionInteger 1
base_version_idAuthoritative PDF version at edit timeUUID; must match document baseline
base_sha256Baseline integrity fingerprintExactly 64 hexadecimal characters
noteReview draft contentUp to 30,000 characters
operationsFuture certified editor event recordsUp to 500; each event up to 8 KiB
updated_atClient checkpoint timestampNumeric
generationClient checkpoint counterNumber; server acknowledges its own generation
expected_generationLast server-acknowledged counterCompare-and-swap precondition
payload sizeJSON checkpoint sizeMaximum 256 KiB

Server drafts in the candidate are configured for 30-day expiry by default; governed purge procedures are still subject to release approval. A stale base revision returns 409 RECOVERY_BASE_VERSION_CONFLICT; concurrent generation returns 409 RECOVERY_GENERATION_CONFLICT; oversized data returns 413; the disabled release gate returns 503 RECOVERY_SYNC_GATE_HOLD.

ERROR HANDLING

Fail closed and preserve correlation context

Status / codeMeaningClient response
401 / 403No session, tenant entitlement or object ACLReauthenticate or request authorization; do not retry blindly
404Not found or security-trimmed objectDo not infer access from guessed IDs
409Baseline revision or recovery generation conflictRefresh metadata; reconcile before retrying
413Draft or operation exceeds limitsReduce eligible draft size; do not silently truncate
415Document is not a PDFOffer a supported PDF conversion workflow
419CSRF validation rejected a cookie-based mutationRefresh the authorized session; do not disable CSRF
422Invalid format or validation failureCorrect request; preserve the original document
503Release/provider/editor or recovery gate not enabledShow unavailable; do not claim success

Clients should retain safe request identifiers, status codes and redacted diagnostics. Do not log document plaintext, draft note text, credentials or private encryption material.

SPECIFICATION & INTEGRATION

Download the source-contract OpenAPI and implementation notes

Integrators should certify authentication, object ACLs, CSRF, content streaming, concurrency conflicts, malware scanning, privacy, upload limits, key custody, crash recovery and rollout/rollback before making any authenticated production calls.

Continue working with PDF Studio

Browse the documentation or check verified releases and available platform installers.