Products
Product lifecycle from creation to live gateway traffic.
Product lifecycle from creation to live gateway traffic.
A Farther Shore product is the sellable version of an API. It combines product identity, upstream routing, docs, plans, pricing, subscriber access, and gateway runtime policy.
| Stage | What happens |
|---|---|
| Draft | You define the product, meters, plans, portal copy, and upstream settings. |
| Configured | The product has enough information to compile runtime rules. |
| Published | Core publishes product and entitlement artifacts for the gateway. |
| Live | Subscribers call the product through the gateway with API keys. |
| Operated | Usage, denied requests, billing, docs, and plans are maintained over time. |
The product wizard captures the information needed to create the first runtime shape:
Start simple. A product with one upstream, one meter, and one plan is easier to validate than a complete pricing catalog.
When you publish a product, core compiles the builder-facing model into runtime artifacts. Those artifacts describe what the gateway needs to know:
The gateway reads published runtime artifacts instead of calling core for every request.
Once live, the product behaves like a protected API:
Some edits are safe to make often, such as portal text or docs. Other edits can change runtime behavior and should be treated like a launch:
After a runtime-impacting edit, test with a real subscriber key before assuming production traffic is healthy.
Product docs are not the same as platform docs. Product docs explain how to use a specific API. They should include:
See Update product docs for the managed product docs flow.