Getting Started
Getting Started
Orient yourself — what Starship is, who the API is for, and the shortest path from zero to your first delivered voucher
Getting Started
This section is designed for a specific reader: a backend engineer who just got API credentials and needs to understand enough to integrate correctly in a single afternoon. If that's you, read the five pages in this section in order. By the end you will have:
- A mental model for how Starship fulfills orders (synchronously from cache, or async via admin-gated vendor fallback)
- A live
curlplacing an order against the sandbox - A plan for your sandbox-to-production promotion
Read these, in order
| # | Page | What you'll learn |
|---|---|---|
| 1 | Introduction | What Starship is, who uses it, what the API can and can't do |
| 2 | Integration Journey | Visual roadmap of the 4 stages every integration goes through |
| 3 | Quickstart | 5 minutes: authenticate → list products → quote → order → retrieve vouchers |
| 4 | Environments | Sandbox vs. production hosts, IP whitelisting, credentials per env |
| 5 | Versioning & Stability | What's guaranteed to stay stable, how we announce breaking changes |
Already oriented? Skip ahead
- Core Concepts — the "why does it behave this way" reference you'll return to
- Authentication — API key, HMAC signing, key rotation
- Reference Data — error codes, request headers, enum tables
Or jump straight to an endpoint group: Products, Orders, Wallets, Payouts, Webhooks.