mirror of
https://git.meshkee.com/Meshkee/backend.git
synced 2026-08-11 22:30:59 +04:30
Alireza HassaniandCursor
953b87b616
Expose published customer listings under /tenants/:host/user-products (list, search, details, technical-info) and document them in the website API pack. Co-authored-by: Cursor <cursoragent@cursor.com>
52 lines
2.9 KiB
Markdown
52 lines
2.9 KiB
Markdown
# Meshkee Website API — AI / designer brief
|
||
|
||
Copy everything below into a new AI chat when building a Meshkee storefront.
|
||
|
||
---
|
||
|
||
## System context (paste this)
|
||
|
||
You are building a **Meshkee business website (storefront)**. You must use the Meshkee Website API only — never invent admin/CMS endpoints.
|
||
|
||
**Canonical docs (always prefer these):**
|
||
- Hub: https://api.meshkee.com/docs/website
|
||
- OpenAPI: https://api.meshkee.com/docs/website/openapi.json
|
||
- Postman: https://api.meshkee.com/docs/website/Meshkee-Website-API.postman_collection.json
|
||
|
||
**API base URL:** `https://api.meshkee.com/api/v1`
|
||
(Optional alias if configured: `https://api.<WEBSITE_DOMAIN>/api/v1` — same backend.)
|
||
|
||
**This website’s apex domain:** `<WEBSITE_DOMAIN>`
|
||
(example: `sanihome.ir` — no `www.`, no `api.`, no `customer.`, no `business.`)
|
||
|
||
### Hard rules
|
||
1. Resolve tenant first: `GET /tenants/<WEBSITE_DOMAIN>` → save `businessId` from `id`.
|
||
2. All public content uses `/tenants/<WEBSITE_DOMAIN>/...` (no auth).
|
||
3. Cart, orders, favorites use `/businesses/<businessId>/...` with `Authorization: Bearer <accessToken>`.
|
||
4. Customer register body must include `"domain": "<WEBSITE_DOMAIN>"`.
|
||
5. Cell numbers are E.164 (`+98912...`).
|
||
6. Do not call dashboard/CMS routes (`/businesses/.../products` write APIs, media upload, domain-admin, etc.).
|
||
7. **Partner SMS** (`POST /public/sms/send`) is for external partner backends with an issued `X-Api-Key` only — not for normal storefront UI. See https://api.meshkee.com/docs/website/SMS.md
|
||
|
||
### Typical bootstrap sequence
|
||
1. `GET /tenants/{domain}` → branding + `businessId`
|
||
2. Homepage: business-info, sliders, category-groups, brand-groups, store-specials
|
||
3. Catalog: categories, products, store-items, **user-products** (customer stock listings)
|
||
4. Auth: register/login → store tokens. Optional: `POST /auth/send-otp` then `POST /auth/login-otp` (passwordless) or `POST /auth/reset-password` (forgot password). `POST /auth/verify-otp` only marks the cell verified (no tokens).
|
||
5. Cart checkout with `addressId` or inline `shippingAddress` + `payment`
|
||
|
||
### User products (customer listings)
|
||
Public marketplace listings owned by customers — not catalog `products`.
|
||
- `GET /tenants/{domain}/user-products` — list published (`name`/`q`, `categoryId`, `cityId`, `countryId`, `condition`, `promoted`, pagination)
|
||
- `GET /tenants/{domain}/user-products/{slug}` — details + gallery
|
||
- `GET /tenants/{domain}/user-products/{slug}/technical-info` — category form + values
|
||
Use product categories from `GET /tenants/{domain}/categories?entityType=product` for filters. Creating/editing listings is customer-dashboard only (`/businesses/.../my-user-products`), not website-facing.
|
||
|
||
If OpenAPI and this brief conflict, **OpenAPI wins**.
|
||
|
||
---
|
||
|
||
## What to tell each website team
|
||
|
||
Replace `<WEBSITE_DOMAIN>` once per project. Everything else is global — same Postman, same OpenAPI, same base URL.
|