Skip to main content

Exposed Endpoints

Documentation endpoints​

  • /
    • Primary Docusaurus documentation home.
  • /docs, /docusaurus
    • Permanent legacy aliases that redirect to /.

Integration API endpoints​

  • POST /api/v1/oauth/integrations/hosted
    • Create a WispHive-hosted OAuth entry integration for an SME, Educational Institute, or ISP.
    • Requires X-API-Key header over HTTPS.
  • POST /api/v1/oauth/integrations/aaa-handoff
    • Create a signed AAA handoff callback integration for an SME, Educational Institute, or ISP.
    • Requires X-API-Key header over HTTPS.
  • GET /oauth/start/{integration_id}
    • Starts the hosted OAuth browser flow on a WispHive-owned auth domain.
  • POST /cp/rdt/{callback_slug}/{callback_token}
    • Accepts an authenticated AAA handoff callback from your backend.
    • Requires callback API key via X-API-Key (or X-WispHive-Token) and Idempotency-Key header.

No-code configuration option​

Teams that do not want to use API docs or write code can use the WispHive dashboard UI to configure providers, callback contracts, API keys, and onboarding settings end to end.

API key management (generation, rotation, and revocation) is dashboard-only.

Notes​

This documentation describes only the external contract exposed to clients and integration partners. Internal implementation details and service topology are intentionally omitted.