Getting started
Choose how to install Shift-Left API (Cloud or Self-hosted), then complete initial setup so you can create projects and run API tests.
Help Center
Find installation steps, configuration guidance, and release notes—fast. Search across all Help Center content in one place.
Start with the basics, then refine runs for CI/CD reliability and coverage.
Choose Cloud or Windows self-hosting, install the Platform Installer, Engine, and Studio, and get MongoDB-ready for the Engine.
First-time setup—admin account, license, users, first project—and where to set base URL, auth, and test configuration in Shift-Left API.
Explore platform features, workflow concepts, and how the pieces fit together.
See what's new and what changed--feature highlights, fixes, and improvements.
Get the latest Shift-Left API installer for Windows and macOS.
Browse the latest updates and foundational docs.
Choose how to install Shift-Left API (Cloud or Self-hosted), then complete initial setup so you can create projects and run API tests.
Step-by-step guide to install Shift-Left API on Windows—Installer, Engine, Studio, MongoDB setup, and verification.
Where to configure base URL, authentication, and environment variables in Shift-Left API so test runs are stable and CI-ready.
Complete first-time setup—core preferences, licensing, users, and your first project—then validate the installation with a test run.
How Shift-Left API turns API contracts into organized endpoints, tests, executions, and reports across projects.
Create your first project in Shift Left Studio, add project details, and prepare the workspace for API import, test generation, and execution.
Import API definitions into your project using file upload or Swagger/OpenAPI URL, then confirm discovered endpoints before testing.
Navigate project dashboards, open features, and select endpoints so you can generate, edit, run, and review API test cases efficiently.
Configure environment values, authentication, data inputs, and project options so generated tests run reliably across dev, QA, and staging.
Use the project dashboard to browse imported features and perform manual create, read, update, and delete operations for feature-level organization.
Import endpoints from OpenAPI/Swagger sources, map them to features, and detect endpoint changes as your API evolves.
From a feature, view endpoint rows by method and path, open endpoint test screens, and perform manual endpoint CRUD operations.
After selecting an endpoint, confirm method, path, connectivity, authentication, and contract alignment before relying on the definition in broader workflows.
Use Generate Tests on the endpoint test-case screen to automatically create baseline scenarios from your API specification.
Open generated tests from endpoint view, edit parameters/body/headers/assertions, and save robust test-case definitions.
Define environments, variables, headers, and datasets so tests run consistently across dev/stage/prod without hardcoding secrets or setup.
Choose where tests run: Shift-Left Engine on server for CI/CD and schedules, or Shift-Left Agent locally for development and private APIs.
Run endpoint test cases from the actions column, monitor progress, and review detailed test-result summaries with assertions and logs.
From the main screen, open Execution and start New Test Run Pack to launch the pack wizard.
Create a standard execution pack in five wizard steps: pack details, test selection, execution preferences, notifications, and scheduling.
After creating a pack, run it now, edit configuration, monitor status, and manage lifecycle actions from the Execution list.
Open Reporting to browse execution history, use Run Type to distinguish Functional and Workflow runs, and open reports from the Execution Summaries list.
First reporting step for every run: execution metadata, pass/fail summary, and tables that link to deeper reports—layout differs for Functional vs Workflow runs.
Second reporting step for Workflow runs only: per-workflow node summary, node table, and View Report to open the detailed report for a node.
Functional run type: detailed evidence for one API test case—test summary, request/response panels, assertions, and logs.
Workflow run type only: detailed view for a workflow node with integration summary, node count cards, sequential node executions, and unified execution log.
Analytics turns execution data into role-aware dashboards and project-scoped metrics—use Dashboards for persona views and Project Analytics for a single project deep dive.
Use the Dashboards tab to pick a persona dashboard, set time range and focus project, and review KPIs such as latency percentiles, endpoints, pass rate, and slowest endpoints.
Use the Project Analytics tab to select a project, set the time window, and review overview metrics, status breakdowns, execution summary, and expandable trend and failure sections.
API mocks replace real backend calls during test runs or run as a standalone mock server—organized per project with static or dynamic responses.
Open API Mocks, pick a project, then create or generate mocks, start the mock server, and manage the list with search, grouping, columns, and row actions.
Workflows are integration tests: visual flows of API and logic nodes that model end-to-end journeys, with results surfaced under Reporting as Workflows run type.
Open Workflows, manage the Integration tests list with bulk actions and row tools, then build flows in the Workflow Test editor with Test details, Test library, and Node types.
Open Shift-Left API Platform Help to see version and build information for the application, Engine, Studio, and Agent, plus auto-update status and Check for Updates.
How the in-app Settings screen is organized: main tabs and sections map to System Administration documentation so you can jump to the right guide.
Settings > Configuration > Server Connection: point Studio at the Shift-Left Engine URL, view status, and reconfigure when you change environments.
Settings > Configuration > Proxy Settings: enable proxies separately for Shift-Left Engine and Shift-Left Agent based on execution mode.
Settings > Licensing & Users > License Management: status, features, validation details, deactivate or refresh, and update the license key.
Settings > Licensing & Users > User Management: search users, review limits, add users, and edit or delete accounts (role and status).
Settings > Licensing & Users > Role Permissions: pick a role, then allow or deny grouped capabilities; reset to default or save changes.
Settings > Licensing & Users > User Policies: registration rules, default role, max users per project, and password requirements.
Settings > Integrations > AI Settings: enable the AI engine, test-generation options, design techniques, and model/API configuration for the whole system.
Settings > Integrations > Public API: Swagger and base URL, enable API, rate limits, token expiry, and which roles may use the API.
Settings > Email > Email Settings: create SMTP/IMAP profiles (+ New profile) so notifications and automation can send mail.
Settings > Email > Email Templates: summary, detailed, and custom templates; search, category filter, and create notifications for test runs.
Settings > System & Monitoring > Audit Logs: summary tiles, rich filters, and a table of who did what, when, on which entity, with status and IP.
Settings > System & Monitoring > Debug Logging: master toggle, log level, outputs (file/console/database), context options, and sensitive-field redaction.
Documentation navigation improvements, faster Help Center discovery, and minor UI fixes released in February 2026.
We can help you scope coverage, stabilize test data, and wire up spec-first testing for your pipeline.