Overview #
Once Shift Left API is installed (either Cloud or On-Premises), a few initial configuration steps ensure your environment is ready for smooth test creation, execution, and collaboration. This quick setup helps your team start testing APIs within minutes.
Step 1. Basic Platform Configuration : #
After logging in for the first time, review and set up core platform preferences such as time zone, language, and logging level.
These settings ensure consistency across all test runs and reports.
💡 Recommendation: Enable debug logging during early setup to capture detailed diagnostic information.
Step 2. Login User Configuration : #
- Use the admin credentials provided during installation or registration.
- Update your password and enable multi-factor authentication (MFA) for added security.
- Review user profile settings for email notifications, display preferences, and access roles.
Step 3. Add License Key : #
- Navigate to Settings → License Management.
- Enter the license key provided by your Account Manager.
- Once validated, your environment will unlock the corresponding features and test capacity.
🔑 Note: If you’re using a trial key, you can upgrade anytime by contacting support.
Step 4. Add Users : #
Invite your team members to collaborate:
- Go to User Management → Add New User.
- Assign roles such as Admin, Tester, or Viewer based on responsibilities.
- Configure access levels to projects and dashboards.
👥 Tip: Use role-based access control (RBAC) for secure, organized team management.
Step 5. Add Your First Project : #
- Click “New Project” and provide a name and short description.
- Define your API base URL, environments (Dev, QA, Staging, Prod), and authentication method (e.g., API Key, OAuth).
- Add API endpoints manually or import via OpenAPI/Swagger specifications.
Step 6. Configure Environment Variables & Test Parameters : #
- Define global variables like base URLs, tokens, and headers.
- Set up environment-specific configurations for flexible test reuse.
- Establish test parameters and thresholds to monitor API health and performance.
Step 7. Run Your First Test : #
- Select a test or test pack and click “Run Now.”
- Verify the setup by checking the execution logs and result summary dashboard.
- Confirm test results and performance metrics to ensure the environment is ready.
Quick Tip : #
For larger teams or multi-project environments, configure Role-Based Access Control (RBAC) early. It helps streamline user permissions, enhance security, and maintain visibility across projects.
