Skip to main content

WispHub API

High-performance FastAPI middleware connecting WispHub Net with third-party applications and conversational interfaces

Get StartedAPI Reference

Quick Start

Get WispHub API up and running in minutes

1

Set up environment variables

Create a .env file in your project root with your WispHub credentials:
WISPHUB_NET_KEY=your_api_key_here
WISPHUB_NET_HOST=https://api.wisphub.net
MAX_ACTIVE_TICKETS_PER_ZONE=3
2

Deploy with Docker

Build and run the containerized API:
docker build -t wisphubapi:latest .
docker run -d --name wisphub_api_server -p 8000:8000 --env-file .env wisphubapi:latest
The API will be available at http://localhost:8000
3

Make your first request

Test the health check endpoint:
curl http://localhost:8000/health

{
  "success": true,
  "action": null,
  "message": null,
  "data": {
    "status": "ok",
    "service": "WispHub Local API"
  }
}
4

Explore the API

Visit the interactive API documentation at http://localhost:8000/docs to explore all available endpoints.

Key Features

Powerful capabilities designed for high-performance integrations

LRU Caching

In-memory caching with custom TTL strategies drops response times to under 5ms for cached queries

Client Discovery

Flexible search with partial string matching when exact identifiers are unavailable

Identity Verification

Algorithmic verification comparing billing and address data against WispHub records

Dynamic Profiling

On-the-fly database updates to enrich client profiles with missing information

Ticket Management

Support ticket creation with zone limits to prevent service saturation

Network Diagnostics

Asynchronous ICMP ping diagnostics for connection troubleshooting

Explore by Topic

Dive deep into specific areas of the API

Architecture

Learn about the middleware design and caching strategy

Authentication

Understand how to authenticate with WispHub Net

Deployment

Deploy to production with Docker and environment configuration

Testing

Run unit tests and load testing with Pytest and Locust

Clients API

Search, verify, and update client information

Plans API

Retrieve internet plan details and pricing

Ready to Get Started?

Set up WispHub API in minutes and start building powerful integrations with WispHub Net

View Quickstart Guide