# JENNi Brand portal API

**Canonical:** https://apis.io/apis/jennipro-com/jennipro-com-brand-portal-api/  
**Provider:** JENNi — https://apis.io/providers/jennipro-com/  
**Base URL:** https://prod.jennipro.net

JENNi Brand portal API is one of 12 APIs that [JENNi](https://apis.io/providers/jennipro-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Brand portal. The published artifact set on APIs.io includes an OpenAPI specification.

What a signed-in BRAND user sees at the brands host: their brand profile (name, accent colour, site URL), publishable widget keys bound to their origins, a coverage preview of their site, shopper demand by 3-digit ZIP prefix, and the orders their widget tag produced. Called with a partner access token (`Authorization: Bearer …`), never an API key. The tenant is always the signed-in account: a tenant in a query or body is ignored. provider-bff forwards profile and key calls to identity-service, coverage and demand to product-availability-service and orders to order-j; every body is re-mapped through a fixed allow-list, so no shopper name, e-mail, phone, street or full postal code is ever returned. Ships dark behind `ENABLE_BRAND_PORTAL`.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| GET | `/provider/v1/portal/brand/catalog` | List your products and local coverage |
| GET | `/provider/v1/portal/brand/coverage` | Read the last coverage run |
| GET | `/provider/v1/portal/brand/demand` | Read shopper demand |
| POST | `/provider/v1/portal/brand/install-check` | Check the widget snippet is installed |
| GET | `/provider/v1/portal/brand/install-status` | See where your widget has been seen |
| GET | `/provider/v1/portal/brand/installs` | See how to add JENNi to your site |
| GET | `/provider/v1/portal/brand/installs/wordpress.zip` | Download your WordPress plugin |
| POST | `/provider/v1/portal/brand/installs/{platform}/complete` | Finish a one-click install |
| POST | `/provider/v1/portal/brand/installs/{platform}/start` | Start a one-click install |
| GET | `/provider/v1/portal/brand/keys` | List your publishable widget keys |
| POST | `/provider/v1/portal/brand/keys` | Mint a publishable widget key |
| POST | `/provider/v1/portal/brand/keys/{id}/transitions` | Revoke a publishable key or change its origins |
| POST | `/provider/v1/portal/brand/onboarding/website` | Set up your site in one step |
| GET | `/provider/v1/portal/brand/orders` | List orders your widget produced |
| GET | `/provider/v1/portal/brand/profile` | Read your brand profile |
| PUT | `/provider/v1/portal/brand/profile` | Save your brand profile |
| POST | `/provider/v1/portal/brand/site-coverage` | Run a coverage probe on your site |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/jennipro-com/openapi/jennipro-com-brand-portal-api-openapi.yml

## Other JENNi APIs (11)

- [JENNi Account API](https://apis.io/apis/jennipro-com/jennipro-com-account-api/)
- [JENNi Catalog API](https://apis.io/apis/jennipro-com/jennipro-com-catalog-api/)
- [JENNi Channel API](https://apis.io/apis/jennipro-com/jennipro-com-channel-api/)
- [JENNi Events API](https://apis.io/apis/jennipro-com/jennipro-com-events-api/)
- [JENNi Inventory API](https://apis.io/apis/jennipro-com/jennipro-com-inventory-api/)
- [JENNi Portal API](https://apis.io/apis/jennipro-com/jennipro-com-portal-api/)
- [JENNi Retailers API](https://apis.io/apis/jennipro-com/jennipro-com-retailers-api/)
- [JENNi Runs API](https://apis.io/apis/jennipro-com/jennipro-com-runs-api/)
- [JENNi Service API](https://apis.io/apis/jennipro-com/jennipro-com-service-api/)
- [JENNi Stores API](https://apis.io/apis/jennipro-com/jennipro-com-stores-api/)
- [JENNi Webhooks API](https://apis.io/apis/jennipro-com/jennipro-com-webhooks-api/)

## Tags

Brand portal

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/jennipro-com/jennipro-com-brand-portal-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/jennipro-com/.