Documentation
Exponata Public Integration API
Integrate external systems with Exponata stores, expositions, expectations, protocols, photos, and fill-rate analytics.
Exponata Public Integration API
Use the public integration API to keep your external store catalogue in sync with Exponata and to read protocol, photo, and fill-rate results back into your own systems.
Authentication
Add one bearer token to every request and learn the shared error format.
Stores
Create, update, and list stores by your external store IDs.
Expositions
Define the displays and product categories that should be monitored in each store.
Expectations
Set expected fill-rate targets by weekday, protocol time, display type, and category.
Protocols and photos
Read protocol status, image counts, photo metadata, and evaluated image URLs.
Fill rates
Compare measured fill rates against expectations for one store or many stores.
Base URL
https://expo.wie.devAll public integration routes are versioned under /v1.
Recommended integration flow
Authenticate every request with Authorization: Bearer <token>.
Upsert stores with stable externalId values. Exponata uses those values as the public identifier in the API.
Attach contacts, expositions, and expected fill-rate targets to each store.
Read protocols, photos, and fill-rate analytics for reporting or downstream workflows.
Common conventions
| Convention | Meaning |
|---|---|
externalId | Your system's stable store identifier. Use it in public paths instead of Exponata internal IDs. |
from / to | Required date-time range filters on analytics and photo endpoints. The lower bound is inclusive; the upper bound is exclusive. |
limit / cursor | Cursor pagination for list endpoints. Reuse nextCursor until it returns null. |
| Fill-rate values | Percentages from 0 to 100, rounded to one decimal place where aggregation is required. |
| Expectations | Used to calculate deltas and belowExpectation flags. Missing or ambiguous expectation matches are reported explicitly. |
Tip
Use the subject tabs above the page, or the API Reference section in the sidebar, to jump directly to Stores, Contacts, Expectations, Expositions, Protocols, Photos, or Fill rates.