Changes
Comparing empty → 160dc49.
| @@ -1,0 +1,30 @@ | ||
| 1 | +--- | |
| 2 | +title: Intro | |
| 3 | +sort: 1 | |
| 4 | +tags: [overview] | |
| 5 | +--- | |
| 6 | + | |
| 7 | +# Intro | |
| 8 | + | |
| 9 | +ZephyrCart is a headless commerce platform: storefronts call our HTTP API, we own carts, checkouts, | |
| 10 | +orders, customers, and the tax + payment plumbing behind them. There is no admin UI you embed; the | |
| 11 | +expectation is that you build your own. | |
| 12 | + | |
| 13 | +## What this documentation covers | |
| 14 | + | |
| 15 | +- The HTTP API at `https://api.zephyrcart.io/v1` | |
| 16 | +- Webhook events and signature verification | |
| 17 | +- Official SDKs (TypeScript, Python, Go, Ruby) and the language-agnostic OpenAPI spec | |
| 18 | +- Reference architectures for the three deployment shapes we actively support | |
| 19 | + | |
| 20 | +## What it does not cover | |
| 21 | + | |
| 22 | +- The marketing site at `zephyrcart.io` (out of scope; talk to the growth team) | |
| 23 | +- The legacy `v0` API — scheduled for end of life 2026-12-31, migration guide forthcoming | |
| 24 | +- Internal runbooks (those live on the [intranet](../intranet/index.md), authenticated) | |
| 25 | + | |
| 26 | +## A note on conventions | |
| 27 | + | |
| 28 | +Every endpoint in this documentation is shown with `curl` because every visitor can read it. | |
| 29 | +Language-specific snippets follow in the [SDK section](integrations/index.md). When an example | |
| 30 | +uses a placeholder we wrap it in angle brackets, e.g. `<api-key>` — never copy it verbatim. | |