⚙️SeeR: Configuring Your APIs – The Foundation of Brilliance!

Welcome to the heart of SeeR!

We'll walk you through each step of the configuration process, ensuring a smooth and delightful experience.

Your Configuration Journey: Step-by-Step! 👣

SeeR guides you through a clear, six-step process, which you'll see reflected in the progress bar at the top of the interface. Let's conquer each one!

Step 1: Upload Spec

This is where your API's journey into SeeR begins! You'll import your OpenAPI definition, and SeeR will get to know your API.

1. Name Your Agent: First, give your API project a meaningful "Agent Name." This helps you easily identify and manage it later in SeeR. Tip: Choose a name that clearly represents your API, like "User Management API" or "Payment Gateway Service."

2. Upload Your API Specification File: It's time to bring in your API's blueprint!

   • Drag & Drop: Drop your OpenAPI file (.json, .yaml, .yml) into the green area.

   • Or Click to Select: You can also click inside the upload box to choose a file from your system. SeeR supports standard OpenAPI 3.0 formats for a seamless experience.

3. Confirm Upload: Once your file is selected, click the "Upload File" button. SeeR will validate the file and confirm if it's acceptable.

   

   Upload

   ✅ Successful Upload

   If your file passes validation, you'll see a 100% progress bar and proceed to the next step.

   

   Upload

   ❌ Swagger Validation Failed

   If your file is missing the servers section or the URL is unreachable, SeeR will show an error like below:

   

   Swagger Validation Error – Missing servers

   Fix it by adding a valid servers block like this:

   servers:
     - url: https://api.example.com/v1

Step 2: Configure Endpoints

After a successful upload, SeeR presents you with all the API endpoints it discovered! This is your hub for customizing each request.

1. Explore Discovered APIs: You'll see a clear list of every API endpoint that SeeR extracted from your OpenAPI file. Each entry shows its HTTP method (GET, POST, PUT, etc.) and its path.

   

   Swagger API ENDPOINTS

   • This overview helps you quickly navigate to the API you want to configure.

2. Deep Dive into an API: To configure a specific API, click the "View" button next to its entry. This will expand its detailed settings.

   

   Expanded Endpoint View

   You'll find several tabs here, allowing granular control over your request:

   • Headers – Add or edit custom headers.

   • Params – Configure path and query parameters

   • Body – Define the request body (JSON)

   • Example Response – Displays the sample response extracted from swagger

   • Pre-requisite – Select another API call that should run before this one, like link setup calls or token fetch APIs

3. Customize Your Request Details:

   • Headers Tab: 📝 Control the HTTP headers sent with your request.

     Add New Header: Click "+ Add Header" to add a new key-value pair and Save Headers

     Edit Existing Header: Click on any header’s Key or Value field to modify it.

     Delete a Header: Click "Remove" next to any existing header. Below, we removed the Authorization header:

     Use this tab to add API keys, bearer tokens, or any custom headers your service requires.

   • Params Tab: 🏷️ Manage different types of parameters for your API call.

     The Params tab allows you to configure input parameters required by your API, including those in the URL path and query string.

     Start by Clicking "Edit Params": Click the Edit Params button to open the parameter configuration panel.

     Choose Parameter Type: Once open, you’ll see options to add either + Add Path Params or + Add Query Params.

     • Path Parameters: Values embedded in the URL path, e.g., /users/{id}

     • Query Parameters: Appended after a ? in the URL, e.g., ?limit=10

     Save Parameters: After adding your desired parameters, click the Save button.

     Edit Existing Parameters: You can edit both the Key and Value fields directly. In this example, we changed the id value from 20166 to 30166, and renamed limit to limit_id:

     Define dynamic values for your API requests with ease—perfect for scenarios where parameter inputs drive test variations.

   • Body Tab: ✉️ Craft the Request Payload

     The Body tab allows you to define or modify the data payload sent with your API request — most commonly used with POST, PUT, or PATCH methods.

     Start by Clicking "Edit Body": Click the Edit Body button to begin modifying the request payload.

     Edit or Add Fields: Use the built-in JSON editor to modify the request body. In this example, we added a new field token_id and updated existing data.

     JSON Format Required: The request body should always be in valid JSON structure. SeeR automatically validates the format as you type.

     Flexible Editing: You can: - Add new keys and values - Update existing fields - Remove unused data

     This tab is perfect for simulating different request scenarios, including form submissions, nested objects, and edge-case payloads.

   • Example Response Tab: 💡 Quick Reference for Expected Output

     This tab provides a static preview of an Example Response based on your OpenAPI specification (if defined). It helps you understand what the API is expected to return for the configured request.

     

     Example Response

     • The response is shown in JSON or XML format.

     • Useful for aligning test assertions or understanding response structure.

     Note: This tab is read-only and meant for reference only — it cannot be edited.

4. Mastering Pre-requisite APIs (Advanced Feature!): SeeR lets you chain API calls together — ideal for dynamic workflows like login → access user profile → perform an action. With Pre-requisite APIs, you can automate these dependencies.

   🔍 Why Use Pre-requisites?

   In real scenarios, one API depends on another.

   Example: You first call /mock-login to get a token, and then use that token in /mock-user-info.

   Manually copying values between calls is inefficient. SeeR automates it through Pre-requisites + Variable Extraction.

   🔸 Step 1: Select a Pre-requisite API

   In the Pre-requisite tab of your main API (e.g., /mock-user-info), you’ll find a dropdown to select other APIs execpt this.

   Dropdown shows all other APIs in your spec (excluding the one currently being configured).

   🔸 Step 2: Run the Pre-requisite API

   After selecting the API (e.g., /mock-login), click Run. You’ll see the full API response if it succeeds (200 status code).

   

   Run API – Success

   SeeR displays the live response of the selected pre-requisite.

   

   Run API – Success

   🔸 Step 3: Extract a Key from Response

   You’ll now see a field to extract a value using JSONPath syntax. This can be a token, user ID, or status code.

   • Type a path like $.response_body.token

   • Click Extract

   Shows error when JSONPath is incorrect or not matched.

   Displays successful value extraction from a valid JSONPath.

   🔸 Step 4: Save as a Variable

   After successfully extracting the desired value from the pre-requisite response, assign a meaningful and unique variable name such as access_token . Then click Save to store it for later use.

   Confirmation step to name and store the extracted value.

   Once saved, navigate to the Saved Variables tab to review all active variables in your workflow.

   Variables saved here can be reused seamlessly across different API configurations.

   🔸 Step 5: Reuse Variable in Main API

   Now go back to Headers, Params, or Body of your main API, and insert the saved variable where needed.

   • Headers (e.g., authorization: Bearer #access_token)

   • Params (e.g., token: #access_token)

   • Body (e.g., use it inside JSON payload value like {#access_token})

   🔁 Important: When reusing any saved variable, it must be prefixed with #

   Example:

   #access_token

   

   Saved Variable Header

   

   Saved Variable Body

   

   Saved Variable Params

   This lets SeeR dynamically replace values at runtime based on your extracted test flow.

5. Manage Your Configured Elements 🧩

   At the top of the Configure Endpoints screen, you’ll find three key tabs to manage your setup:

   • API Endpoints: View and configure all endpoints discovered from your OpenAPI file.

   • Saved Variables: Access variables you’ve extracted from previous API responses.

   • Pre-requisite APIs: Create and manage custom pre-requisite APIs that are not part of your Swagger spec.

   A single place to track and manage all your API configurations.

   🧪 Why Use the "Pre-requisite APIs" Tab?

   While each API supports linking another as a pre-requisite, this tab gives you extra flexibility — useful when:

   • You want to test an API not included in your Swagger

   • You need to call an external or temporary API (e.g., a login or token service)

   ➕ Add a Custom Pre-requisite API

   Click Pre-requisite APIs > + Create New, and define the API manually:

   • Choose method (GET, POST, etc.)

   • Enter base URL and path

   • Add headers, params, Content Type(JSON, Form data) and body

   Create any supporting API outside your documented spec.

   Once created, you can:

   • See it listed in the Pre-requisite tab of any API endpoint

   • Run it like other APIs and extract values using JSONPath

   • Save extracted values as variables

   • Reuse those variables in any API (headers, params, body) using the syntax: your_variable

   🔄 This unlocks real-world testing flexibility beyond what’s defined in your API docs.

Step 3: Execute APIs

This step is a quick review of the APIs SeeR has discovered and is ready to process.

1. API Discovery Overview: You'll arrive at an "API Discovery" screen. Here, SeeR lists all the APIs it found from your specification, along with their HTTP methods and their initial status (e.g., 200, 400).

   

   Execute API

   This table gives you a concise summary of the APIs that are now loaded in SeeR.

2. Proceed to Next Step: Review the list to ensure everything looks correct, then click the "Next" button to move forward in the configuration process.

Step 4: Custom Instructions

This optional but powerful step allows you to provide specific guidance to SeeR for how it should generate tests and analyze your APIs.

1. Enter Your Specific Instructions: In the provided text area, you can type any unique requirements or instructions you have for SeeR's automated processes.

   

   Custom Instructions
2. Submit or Skip:

   • Click "Submit" to save your custom instructions and apply them.

   • Click "Skip" if you don't have any specific instructions at this time.

   

   Submit or Skip

   • These instructions help SeeR tailor its intelligent test generation to your exact needs!

Step 5: Link Your GitHub Repository & Enable CI

Connecting your GitHub repository to SeeR unlocks powerful capabilities:

• Continuous API monitoring

• Automated test generation

• Real-time impact analysis

---

🔧 Quick Setup in SeeR

In the SeeR UI (Step 5: Link Repository):

1. Enter your:

   • GitHub Access Token 👉 Not sure how to create it? See our GitHub Integration Guide

   • Repository URL (e.g., https://github.com/org/repo)

   • Branch to monitor (e.g., main, staging)

   • Folder to Monitor (e.g., src)

   • Framework (e.g., Python, Java)

2. Click Connect Repository to complete the link. You can also choose to skip this step if not using CI right away, SeeR will still begin generating tests based on your uploaded Swagger file.

Connect SeeR with your GitHub repo and code structure.

---

⚙️ Enable CI with GitHub Actions (Optional, Recommended)

To auto-trigger tests on code pushes:

1. In GitHub, add a new workflow file: .github/workflows/code-impact.yml

2. Paste the SeeR-generated YAML into it (shown in the UI)

3. Add the required repository secrets in GitHub:

Secret Name	Example Value / Source
IMPACT_API_URL	https://stg-gateway.qyrus.com:8243/impact-dispatcher/v1
API_ACCESS_TOKEN	Bearer 90540897-748a-3ef2-b3a3-c6f8f42022da
PROJECT_ID	From SeeR → ... next to agent name → Copy Job ID
GITHUB_TOKEN	Same token used in Step 5

1. After then click on Run Auto Tests 🚀 button

📌 SeeR uses these secrets to securely execute tests triggered by GitHub events.

🧩 Want full YAML code, scopes, and troubleshooting tips? 👉 Check the complete GitHub Integration Guide

---

➡️ Next Up: Run Automated Tests