Managing Your Listing
How the pieces of a marketplace listing fit together under the /api/partner surface.
Your marketplace listing is what practices see, evaluate, and install in the Hint Marketplace. Everything that composes a listing lives under the /api/partner/* namespace and is authenticated with your Partner API key.
Most partners manage their listing through the Hint partner portal; this guide describes the underlying resource model so the API and the portal read the same way.
The resource model
A listing is a small tree of resources:
- Backend -- your partner configuration. It owns your partner-level webhook endpoints and is the default target when you create backend-scoped resources. Most partners have a single backend and never think about it; a
backendparameter lets you target a specific one when you run more than one. See Backends. - Products -- the individual listings a practice can install. A partner can publish more than one product. Everything below hangs off a product. See Products.
- Installations -- a practice's connection to one of your products. Installations are covered in Integration Activation; this guide focuses on the listing itself.
A product and its content
Each product carries the content that renders on its marketplace page and the entry points it exposes inside Hint:
| Resource | Path | What it is |
|---|---|---|
| Product | /api/partner/products | The listing itself -- name, description, and status. |
| App surfaces | /api/partner/products/:id/app/surfaces | The embedded entry points your app exposes inside Hint. |
| Testimonials | /api/partner/products/:id/testimonials | Customer testimonials shown on the listing. |
| Highlights | /api/partner/products/:id/highlights | Short value-proposition callouts. |
| Links | /api/partner/products/:id/links | Outbound links (marketing site, docs, support). |
| Overview | /api/partner/products/:id/overview | The long-form product overview (a single record). |
| Preconditions | /api/partner/products/:id/preconditions | Requirements a practice must meet before installing. |
| Categories | /api/partner/products/:id/categories | The marketplace categories the product is filed under. |
Browse the shared category catalog with GET /api/partner/products/categories, then attach the ones you want to a product with POST /api/partner/products/:id/categories -- send { "name": "..." } to create-and-attach by name, or { "category_id": "..." } to attach an existing catalog entry.
App surfaces
Surfaces are the entry points your embedded app exposes inside Hint. Each surface has a type that tells Hint where it belongs:
core_page-- a top-level page in your app's navigationclinical_interaction-- an embed within a clinical interactionclinical_chart-- an embed within the patient chartsettings-- a configuration surface
Surfaces are managed under a product's app. The app also tracks the operational pieces of an embedded product:
- Services -- the backing services your app registers, each with its delivery logs.
- Revisions -- versioned snapshots of the app configuration.
See Building an App for how surfaces render and how the handshake passes context into them.
Publishing
When a product's content is ready, request review with POST /api/partner/products/:id/request_review. Hint reviews the listing before it becomes installable in the Marketplace.
Reference
The full request and response shapes for every resource above live under Partner Endpoints in the API reference.
Updated 23 days ago