Skip to main content

API Reference

Hilt’s advanced docs are split into two layers:

  • merchant workflow docs in the main docs sections
  • deeper implementation docs in this advanced section

The goal is to keep the product understandable for merchants while still giving engineers enough detail to integrate against the same live system the app uses.

Base URLs​

Marketing site:  https://www.hilt.so
Merchant app:    https://app.hilt.so
API:             https://api.hilt.so
Docs:            https://docs.hilt.so
OpenAPI:         https://api.hilt.so/v1/openapi.json
Swagger UI:      https://api.hilt.so/v1/docs
ReDoc:           https://api.hilt.so/v1/redoc

Vocabulary bridge​

  • dashboard wording: templates
  • API and CLI wording: products

They refer to the same merchant object.

Authentication summary​

  • browser and app sessions use:
Authorization: Bearer <jwt>
  • server-side merchant integrations use:
X-Hilt-Key: hk_live_...

For most teams, the cleanest order is:

  1. launch the first flow in the merchant app
  2. inspect the account and product objects through the API
  3. create an API key for your backend
  4. automate lookups, support, and verification
  5. only then move more of the flow into your own backend if needed

That keeps your backend aligned with the same product surface the merchant already understands.

Reference map​

Copy-paste examples​

Includes:

  • cURL snippets
  • Node.js / TypeScript examples
  • Python examples
  • Rust examples for Solana-native teams

Auth, workspace, and keys​

Includes:

  • register and login
  • wallet auth
  • Google and GitHub OAuth
  • merchant workspace bootstrap
  • workspace updates
  • delivery readiness checks
  • API key creation and revocation

Products and checkout​

Includes:

  • product creation and updates
  • public checkout payloads
  • signed handoff links
  • Telegram and Discord connect
  • identity handshake
  • payment broadcast, confirmation, and polling
  • Phantom mobile notes

Members, receipts, support, and billing​

Includes:

  • membership operations
  • receipt retrieval and public proof
  • support tickets
  • Hilt subscription billing through Stripe
  • refund and reversal guidance
  • links into the webhook model for async settlement

Errors and operations​

Includes:

  • common HTTP statuses
  • checkout state transitions
  • retry guidance
  • delivery recovery guidance
  • rate limiting and operational notes

Sandbox and environment guidance​

Includes:

  • what is truly live today
  • what “sandbox” means in the current Hilt surface
  • how to test safely with tiny-value templates
  • local, staging, and production callback guidance

Security and secret handling​

Includes:

  • API key handling
  • JWT vs server-side auth boundaries
  • webhook signature verification
  • connector and bot secret handling
  • rate limit and quota guidance

CLI reference​

Includes:

  • full command list
  • flags and output modes
  • command-to-route mapping
  • example operational workflows

Terminology and release notes​

Launch contract​

If you stay inside the routes and flows documented in this advanced section, you are inside the supported launch contract for Hilt’s app, API, and CLI surfaces.