#APIMaster Integration Workbench — Documentation Index

• Title: Documentation Index (landing page)
• Generated at: 2026-09-03
• Repository: api-workbench-pro
• Branch: main
• Revision: 0.10.1-rc.3
• Audience: Everyone — new users, API designers, integration engineers, ops/SRE, tech leads, auditors, and procurement/security reviewers
• Confidence: high
• Related documents: BUSINESSSSYSTEMREFERENCE.md · USER_MANUAL.md · PROCESS_FLOWS.md · NAVIGATION_TREE.md · TECHNICAL_ARCHITECTURE.md · FEATURE_CATALOG.md · READINESS_PLATFORM.md · ROLEEPERMISSIONMATRIX.md · DATAAFLOWANDDENTITYREFERENCE.md · CHANGEEINTELLIGENCEAPPENDIX.md · DOCCGENERATIONREPORT.md · HELPPMENUMASTERFILE.json · ARCHITECTURE.md · GDPR.md · README.md

#What is APIMaster Integration Workbench?

**APIMaster is a total integration intelligence workbench built around APIs and integration
contracts.** It covers the entire API lifecycle — **import → design → mock → map → run → govern →
ship-readiness** — inside a single browser app. There is no vendor workspace-sync backend or account
system: application-managed workspace state is browser-local by default. Explicit/configured remote
operations, same-origin asset loads, browser navigation and the APIMaster-owned first-party local
error negative control are recorded in the 11-record Trust manifest. The error boundary has no
remote sink by default.

That architectural choice makes the workspace local-first by default: primary workspace data is
kept in browser storage rather than synchronized to a vendor workspace backend. Explicitly initiated
or configured capabilities can still use the network—for example live REST/GraphQL/realtime calls,
URL imports, the local companion sandbox, schedules, and webhooks. Review the Trust page before
using those capabilities with sensitive data.

An integration is more than its endpoint definitions, and the product is organised accordingly, into
five capability domains:

Contract Intelligence is one domain, not the product. Its promise — _catch breaking API changes
before they break consumers_ — is precise and belongs to it; APIMaster also designs definitions,
models scenarios, describes event contracts and maps an estate's dependencies. See
NAVIGATION_TREE.md for how these map onto the seven sidebar groups.

Documentation currency (2026-09-03). Several documents in this set were written for revision
v0.9.0 and carry a Coverage note saying so. The capability areas added since —
SwaggerMaster, Event Intelligence, Workspace Blueprints and local multitenancy under
/access — are catalogued in FEATURE_CATALOG.md and
NAVIGATION_TREE.md, which are current.

• Canonical site: <https://apimaster.dev/>
• In-app help center: the Documentation Center at /docs renders this same documentation
• Compatibility identifiers: legacy apibox.* storage keys and useApiBoxStore symbols remain intentionally unchanged.

New here? Jump to Start here — by persona for the fastest path to
being productive in your role.

#The documentation set

The help center combines the core reference set with current security, recovery, legal-draft and
operations material. Every entry is grounded in the real routes, entities and code of APIMaster
Integration Workbench; verified facts are kept separate from inferred ones and every legal document
is visibly marked non-operative. The in-app Documentation Center (/docs) discovers and
renders these files; the Help Menu masterfile is the machine-readable
manifest that drives the in-app menu.

Newest addition (v0.9.1): the Readiness Platform Guide documents the
now ten-dimension Readiness Scorecard and the four dedicated readiness pages (API Inventory,
Resilience Lab, Agent Readiness, Compatibility Matrix) added since the v0.9.0 wave.

The Readiness Scorecard (/readiness) — now ten dimensions — and its dedicated check
surfaces (Governance & Lint, Security Posture, Trace Readiness, Drift Radar, Validation Engine,
API Inventory, Resilience Lab, Agent Readiness, Compatibility Matrix) are covered end-to-end in the
Readiness Platform Guide and enumerated in the
Feature Catalog; their end-to-end flows are in
Process Flows and their data/engine contract in
Technical Architecture.

Pre-existing provenance docs (preserved, cross-linked — not part of the numbered help set):
ARCHITECTURE.md, GDPR.md,
trust/security-overview.md,
trust/DPA-template.md. These are the source-of-truth provenance pages a
security or procurement reviewer reads; the help-center docs cross-link them and never duplicate
them.

Current production-readiness material:
Security disclosure policy,
Recovery and restore guide,
public uptime monitoring,
incident runbook and
communication templates. The
Privacy Notice,
Terms, Pilot SOW and
DPA are DRAFT — NOT LEGAL APPROVAL and do not clear any legal gate.

#Start here — by persona

APIMaster Integration Workbench is role-aware. You set your active role by impersonation in Settings
(/settings); each persona has a default role (see Role Permission Matrix).
Below is the fastest productive path for each.

#API Designer (default role: editor)

You import specs and shape endpoints, schemas and scenarios.

1. User Manual → the shell + the API Catalog & Import (/catalog, /import)
2. Process Flows → Import OpenAPI and _Endpoint design → scenarios →
3. Feature Catalog → Data Packs (/data-packs), Scenarios
4. Feature Catalog → run a Governance & Lint (/governance) pass on your

#Integration Engineer (default role: editor)

You wire APIs together with field mappings and run scenario suites.

1. User Manual → API Explorer (/api-explorer) and Mapping Studio
2. Process Flows → Mapping build → review → production lock and _Schema
3. Feature Catalog → Mapping Reviews (/mapping-reviews), Prevalidation
4. Change Intelligence Appendix → understand which modules a spec

#Ops / SRE (default role: operator)

You run, configure browser-open schedules, smoke-test and monitor — but cannot change locked
production mappings. Browser close/sleep stops continuous in-app ticking; the local one-shot runner
requires a separate explicit invocation.

1. Feature Catalog → Environments (/environments), Gateway Smoke
2. Process Flows → Gateway export → smoke and _Scheduled run tick →
3. Feature Catalog → Drift Radar (/drift-radar) and
4. Role Permission Matrix → what production locks deny you and why.

#Tech Lead / Owner (default role: owner)

You own production locks, govern reviews, and decide what ships.

1. Feature Catalog → the Readiness Scorecard (/readiness) and its
2. Change Intelligence Appendix → the change-intelligence loop and
3. Process Flows → Mapping → review → lock and Readiness check → PDF.
4. Role Permission Matrix and GDPR.md → governance model

#Auditor / Viewer (default role: viewer)

You inspect, verify and export evidence — read-only.

1. Feature Catalog → Audit Log (/audit), Trust Center (/trust).
2. Process Flows → Evidence bundle export (audit-grade).
3. GDPR.md and trust/security-overview.md → the
4. Data Flow & Entity Reference → verify browser-local storage

#Procurement / Security reviewer

You assess risk before adoption.

1. GDPR.md → GDPR Art. 5 / 25 / 32 mapped to architectural answers.
2. ARCHITECTURE.md → the ordered 11-record Trust manifest, runner boundary and
3. trust/security-overview.md and trust/DPA-template.md.
4. Data Flow & Entity Reference → the verifiable storage-key
5. Security disclosure policy and
6. Review the clearly non-operative legal drafts only as

#The whole app at a glance

The navigation groups every route. Use this as a map; each module has a full section in the
Feature Catalog, and the complete route tree is in
Navigation Tree.

flowchart TD
  subgraph WS[Workspace]
    O["/ Overview"]
    CAT["/catalog · Import"]
    EXP["/api-explorer"]
    GQL["/graphql"]
    RT["/realtime"]
    TMF["/tmf"]
  end
  subgraph MOD[Modeling]
    DP["/data-packs"]
    SC["/scenarios"]
    MAP["/mappings"]
    MR["/mapping-reviews"]
    ERR["/errors"]
    SD["/schema-diff"]
  end
  subgraph RUN[Runtime]
    ENVR["/environments"]
    PRE["/prevalidation"]
    EXEC["/execution"]
    GS["/gateway-smoke"]
    CI["/ci-gate"]
    SCH["/schedules"]
    MF["/mock-forge"]
  end
  subgraph INTEL[Intelligence]
    INS["/insights"]
    CHI["/change-intelligence"]
    OAI["/openai"]
    AEX["/explorer"]
  end
  subgraph RDY[Readiness]
    RScore["/readiness"]
    GOV["/governance"]
    SECP["/security-posture"]
    TR["/trace-readiness"]
    DR["/drift-radar"]
    VE["/validation-engine"]
    INV["/api-inventory"]
    RL["/resilience-lab"]
    AR["/agent-readiness"]
    CM["/compatibility-matrix"]
  end
  subgraph GOVN[Governance]
    AUD["/audit"]
    TRUST["/trust"]
    ENT["/enterprise"]
    SET["/settings"]
    HELP["/help · /docs"]
  end
  WS --> MOD --> RUN --> RDY
  RUN --> INTEL
  RDY --> GOVN

_Diagram: the navigation groups (Workspace, Modeling, Runtime, Intelligence, Readiness, Governance)
and the rough left-to-right lifecycle flow. Detail routes (/api/$apiId,
/api/$apiId/endpoint/$endpointId, advanced /import) and the public, full-bleed routes
(/welcome, /pricing) sit outside these groups._

#Where to read these docs

• In the app: open the Documentation Center at /docs — it renders this exact docs
• In the repo / on GitHub: browse the docs/ folder. Start with this index, then follow
• Programmatically: the Help Menu masterfile lists every document

To learn how this documentation system is wired and how to extend it, see
docs/README.md.