---
title: "Framekit quick start"
url: "https://platformdocs.coinme.com/#/docs/web-quick-start"
markdown: "https://platformdocs.coinme.com/docs/web-quick-start.md"
summary: "A five-step integration of the Widget SDK for the web, `@coinme/coinme-bridge-framekit`. For a deeper walk-through see the integration guide."
surface: "ramp"
platform: "web"
package: "@coinme/coinme-bridge-framekit"
version: "1.1.2"
peerDependencies: {"react":">=18.0.0","react-dom":">=18.0.0"}
updated: "2026-10-20"
---

# Framekit quick start

A five-step integration of the Widget SDK for the web, `@coinme/coinme-bridge-framekit`. For a deeper walk-through see the [integration guide](https://platformdocs.coinme.com/docs/web-integration-guide.md).

## 1. Install

Configure an `.npmrc` in your project for the Coinme private npm registry (Coinme issues an entitlement token; ask your Coinme integration contact if you don't have one):

```
@coinme:registry=https://npm.coinme.com/coinme-sdk-frontend/
//npm.coinme.com/coinme-sdk-frontend/:_authToken=${COINME_REGISTRY_TOKEN}
always-auth=true
```

Then install the package:

```bash
yarn add @coinme/coinme-bridge-framekit
```

## 2. Reserve a container

```markup
<div id="coinme-mount" style="width: 100%; height: 720px;"></div>
```

The container's dimensions drive the iframe: framekit sets the iframe to `100% × 100%` of the container.

## 3. Construct the frame

```typescript
import { createCoinmeFrame } from '@coinme/coinme-bridge-framekit';

const frame = createCoinmeFrame({
  container: '#coinme-mount',
  orchestratorUrl: 'https://stage-widget.coinme.com',
  config: {
    rampId: 'your-ramp-id',
  },
  onEvent: (event) => {
    // Typed CoinmeEvent: see the integration guide.
  },
  onError: (err) => {
    // CoinmeError instance: see the integration guide.
  },
  onSessionReady: () => console.log('Bridge ready'),
});
```

`rampId` is the value Coinme issued you. `orchestratorUrl` picks the environment: `https://stage-widget.coinme.com` for testing, `https://widget.coinme.com` for production. Add `partnerKey` only if the same integration also ships inside native WebViews; on the web it is informational.

## 4. Update config or destroy as needed

```typescript
// Change config at runtime: sends an updateConfig over the bridge.
frame.updateConfig({ destinationCurrency: 'ETH' });

// Tear down when the user navigates away.
frame.destroy();
```

## 5. Test the embed

Open the page in your browser; you should see the Coinme widget load. If the handshake never completes you'll see `CoinmeError.handshakeTimeout` on your `onError` callback after 5 seconds. Common causes:

- The `orchestratorUrl` is unreachable.
- Your page's hostname is not on the Orchestrator embed allowlist. Give Coinme each hostname you embed from (hostnames only, no scheme or port).
- Your CSP is stripping the iframe `referrerpolicy` (the Orchestrator's embed guard needs `document.referrer`).
- The `orchestratorUrl` origin doesn't match the actual Orchestrator origin (trailing slash or a different subdomain).

For React, swap step 3 for `<CoinmeFrame />` from `@coinme/coinme-bridge-framekit/react`. See [React](https://platformdocs.coinme.com/docs/web-integration-guide.md#react) in the integration guide.
