Quickstart Guide
Get your first mock API running in under 5 minutes.
Step 1: Sign Up
- Navigate to app.surestage.com
- Create an account using email, Google, GitHub, or Microsoft SSO
- Complete the onboarding wizard to set up your first organization
Step 2: Create Your First Simulation
A simulation is an isolated Sandbox that hosts your mock API endpoints.
- From the dashboard, click New Simulation
- Give your simulation a name (e.g., "Payment API Sandbox")
- Choose a base path (e.g.,
/api/v1) - Click Create
Your simulation is now live with a unique URL like:
https://<simulation-id>.srstg.io/api/v1
Step 3: Add a Route
A route defines an endpoint pattern and its mock responses.
- Inside your simulation, click Add Route
- Set the method to
GETand path to/users - Add a response with status
200and body:
{
"users": [
{ "id": 1, "name": "Alice Johnson", "email": "alice@example.com" },
{ "id": 2, "name": "Bob Smith", "email": "bob@example.com" }
]
}
- Click Save
Step 4: Test Your Mock
curl https://<simulation-id>.srstg.io/api/v1/users
You should see your mock response returned.
Step 5: Import an Existing API (Optional)
Instead of building routes manually, import from:
- OpenAPI/Swagger spec (JSON or YAML)
- Postman Collection (v2.1)
- HAR file from browser dev tools
- cURL commands
Go to your simulation and click Import to get started.
What's Next?
- Key Concepts - Understand simulations, routes, responses, and state
- Web Application Guide - Deep dive into the dashboard
- CLI Installation - Set up the command-line tool
- Proxy & Record/Replay - Record real API traffic