arrow_back Back to Documentation

Postman Collection

Get started quickly with our pre-configured Postman collection. Includes example requests for all scenarios and coverage types.

download Download Collection open_in_new Get Postman

What's Included

folder

Organized Folders

Requests organized into logical folders: Tax Calculations, Special Coverage Types, and Error Examples.

code

Pre-Built Examples

Ready-to-use examples for all 52 jurisdictions and special coverage scenarios like wet marine and fire insurance.

settings

Environment Variables

Pre-configured variables for base URL and API key - just add your credentials and start testing.

bug_report

Error Scenarios

Example requests that trigger common errors so you can test your error handling logic.

Quick Start Guide

  1. Download the Collection

    Click the download button above to get the postman_collection.json file.

  2. Open Postman

    Launch Postman and click Import in the top left corner.

  3. Import the Collection

    Drag the downloaded file into Postman or click Upload Files and select it.

  4. Set Your API Key

    Edit the collection variables and replace your_api_key_here with your actual API key from app.surpluslinesapi.com.

  5. Start Testing

    Open any request, click Send, and see the results!

Environment Variables

The collection uses these variables that you can customize:

Variable Default Value Description
baseUrl https://api.surpluslinesapi.com/v1 API base URL (production server)
apiKey your_api_key_here Your API key from the dashboard

Setting Variables

Click on the collection name, go to the Variables tab, and update the apiKey current value with your key.

Available Requests

folder

Tax Calculations

4 expand_more
POST Basic Calculation - Texas
POST California Calculation
POST New York Calculation
POST Florida Calculation
folder

Special Coverage Types

7 expand_more
POST Alaska - Wet Marine Coverage
POST Montana - Fire Insurance
POST Montana - Electronic Filing
POST South Dakota - Fire Insurance
POST Illinois - Fire Marshal Tax
POST Virginia - Workers Comp (Exempt)
POST Puerto Rico - Medical Malpractice (Exempt)
folder

Error Examples

4 expand_more
POST Missing State Parameter
POST Invalid State Name
POST Invalid Premium (Negative)
POST Missing API Key

Alternative Import Methods

Import via URL

You can also import directly from a URL in Postman:

Collection URL
https://surpluslinesapi.com/docs/postman/postman_collection.json

Import from OpenAPI

Alternatively, import the OpenAPI specification to auto-generate a collection:

  1. Go to Import in Postman
  2. Select Link tab
  3. Enter: https://surpluslinesapi.com/docs/openapi/surpluslines-openapi.json
  4. Click Continue and Import

Note

The pre-built Postman collection includes more example scenarios than the OpenAPI import. We recommend using the dedicated collection for the best experience.