> For the complete documentation index, see [llms.txt](https://docs.cloutly.com/reviews-sdk-for-marketplace-websites/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloutly.com/reviews-sdk-for-marketplace-websites/introduction/system-overview.md).

# System Overview

## Step 1: Sync businesses via REST API

Your platform syncs businesses and review operations with Cloutly through the REST API.

```mermaid
flowchart LR
  platform[Your Backend] -->|x-api-key| cloutly[Cloutly REST API]
  cloutly --> businesses[Businesses]
  cloutly --> reviews[Reviews]
  cloutly --> invites[Invites and Replies]
```

## Step 2: Provision user and business through JWT

Your backend creates a signed JWT and passes it to the embedded Cloutly iframe.\
On successful validation, Cloutly upserts user and business records automatically.

```mermaid
sequenceDiagram
  participant User as Your User
  participant App as Your App
  participant Api as Your Backend
  participant Embed as Cloutly Embed

  User->>App: Open embedded reputation page
  App->>Api: Request short-lived embed JWT
  Api->>Embed: Signed JWT (externalUserEmail, externalBusinessId, ...)
  Embed->>Embed: Validate token and upsert user/business
  Embed-->>App: Return embedded session in iframe
```

## Step 3: Run embedded Cloutly app inside your UI

The iframe renders the Cloutly app in your system while retaining your platform navigation and permissions.

## Step 4: Pull insights and automation outputs

Use REST endpoints for summaries, review lists, invites, and replies.\
Use widgets when you need lightweight read-only rendering outside the full embed experience.
