Gateway

Hyphen Gateway is the public front door for SaaS and hybrid deployments.

Example gateway URL: https://your-hyphen.example.com

What it does

  • authenticates API keys and management tokens
  • manages publishable keys for browser-facing SDK surfaces
  • maps keys to tenants and injects tenant context upstream
  • applies request-level rate limiting
  • exposes self-serve signup and tenant management APIs
  • serves browser-safe platform assets such as the SDK bundle

Key routes

Public

  • GET /health
  • POST /gateway/signup
  • GET /sdk/v1.js

Tenant management (Authorization: Bearer YOUR_MANAGEMENT_TOKEN)

  • GET /gateway/account
  • POST /gateway/account/regenerate-token
  • GET /gateway/orgs
  • POST /gateway/orgs
  • PUT /gateway/orgs/:orgId
  • GET /gateway/orgs/:orgId/keys
  • POST /gateway/orgs/:orgId/keys
  • DELETE /gateway/orgs/:orgId/keys/:keyId
  • POST /gateway/orgs/:orgId/keys/:keyId/rotate
  • GET /gateway/orgs/:orgId/usage
  • GET /gateway/licenses

Platform administration

Administrative routes are available in deployments where platform-level account, licensing, and usage management are enabled.

Licensing

  • POST /licensing/validate
  • GET /licensing/public-key

Runtime proxy calls

For runtime API calls, send:

  • Authorization: Bearer YOUR_API_KEY

Gateway forwards the request to the engine with tenant headers injected server-side.

Browser-safe delivery

Gateway also powers browser-safe Hyphen surfaces.

Load the SDK from the same gateway host:

html
<script src="https://your-hyphen.example.com/sdk/v1.js"></script>