Skip to content

Commit

Permalink
Remove all supademos because they keep breaking (#436)
Browse files Browse the repository at this point in the history
  • Loading branch information
DebbieAtSeam authored Nov 20, 2024
1 parent 6564f80 commit 3b75e2f
Show file tree
Hide file tree
Showing 10 changed files with 0 additions and 33 deletions.
2 changes: 0 additions & 2 deletions docs/core-concepts/authentication/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ If you need to access multiple workspaces, create a [Personal Access Token](pers
Production API keys do not include `test`, while API keys for sandbox workspaces do include `test`. In addition, if you accidentally commit your API key to a GitHub repo, the `seam_` prefix is detected, and you are notified.
{% endhint %}

{% @supademo/embed demoId="vLRzYM2Nwoi4j_cH9WCNQ" url="https://app.supademo.com/demo/vLRzYM2Nwoi4j_cH9WCNQ" %}

## Export an API Key

Once you have created an API key, it is useful to export this key as an environment variable. Then, all installed Seam SDKs automatically use this exported API key.
Expand Down
2 changes: 0 additions & 2 deletions docs/core-concepts/authentication/personal-access-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ Never use a PAT in a web browser or expose it to your users.
4. In the **Add Personal Access Token** dialog, type a name for your new PAT and then click **Create Personal Access Token**.
5. Copy the newly-created PAT and store it for future use.

{% @supademo/embed demoId="ZY2oBrHFSx2Tmuwq8vzd_" url="https://app.supademo.com/demo/ZY2oBrHFSx2Tmuwq8vzd_" %}

## Using the PAT to issue a Seam API request

To use a PAT for authorization in the Seam API, you must specify the PAT in the `Authorization` header for the Seam HTTP API or in the `seam` constructor for the Seam SDK that you are using. You must also specify the ID of the workspace that you want to access. If you are using the Seam HTTP API, include the `seam-workspace` header with the desired workspace ID. If you are using a Seam SDK, specify the desired workspace ID in the `Seam` constructor.
Expand Down
2 changes: 0 additions & 2 deletions docs/core-concepts/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ To configure webhook endpoints:
4. Click **Create**.
5. Copy your webhook secret and store it somewhere secure. You use this webhook secret to validate the payloads that you receive on your webhook.

{% @supademo/embed demoId="o9OPTdLxdQi_jt2d5htNw" url="https://app.supademo.com/demo/o9OPTdLxdQi_jt2d5htNw" %}

You can add webhooks through the Seam Console or programmatically. Let's start by looking at how to add and test a webhook using the Seam Console.

![Click + Add Webhook to create a webhook for your device events.](<../.gitbook/assets/image (22).png>)
Expand Down
8 changes: 0 additions & 8 deletions docs/core-concepts/workspaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ Production workspaces enable you to connect and control real devices from brands
4. Disable **Sandbox mode**.
5. Click **Create Workspace**.

{% @supademo/embed demoId="nXyjx_lwg6VxyiIU4DJkE" url="https://app.supademo.com/demo/nXyjx_lwg6VxyiIU4DJkE" %}

### Connecting Devices

You can use either of the following two ways to connect devices to a production workspace:
Expand All @@ -63,8 +61,6 @@ You can use either of the following two ways to connect devices to a production

Once authorized, the devices associated with this test account appear in the **Devices** table in your production workspace.

{% @supademo/embed demoId="h1y5QMki-7vzlghMzobuf" url="https://app.supademo.com/demo/h1y5QMki-7vzlghMzobuf" %}

#### Connect Devices Using Connect Webviews

If you are creating an application (app) to control your users' devices, use [Connect Webviews](../connect-webviews/). Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their device accounts to Seam through your app. Seam handles all the authentication steps. Once your user has completed the authorization through your app, your users' devices are linked with your production workspace, and you can access and control their devices using the Seam API.
Expand Down Expand Up @@ -131,8 +127,6 @@ You can trigger test events for some virtual devices. This capability is useful
5. Click the **Events** tab for the device.\
The **Events** tab displays the event.

{% @supademo/embed demoId="NuhwAWiC1CaeGPRZzDENn" url="https://app.supademo.com/demo/NuhwAWiC1CaeGPRZzDENn" %}

### Testing Your App

To help you test your app against events—like device disconnection or removal—that are difficult to orchestrate in a QA environment using real devices, Seam provides a suite of `simulate` endpoints that you can use in a [sandbox workspace](./#sandbox-workspaces). See [Testing Your App Against Device Disconnection and Removal](../devices/testing-your-app-against-device-disconnection-and-removal.md).
Expand Down Expand Up @@ -197,5 +191,3 @@ You can add teammates to your workspace.
6. Click **Add to Team**.

The Seam Console sends an email invitation to the specified teammate.

{% @supademo/embed demoId="YLZEbSgX5shkgOyFb4LE9" url="https://app.supademo.com/demo/YLZEbSgX5shkgOyFb4LE9" %}
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ go get github.com/seamapi/go

Next, go to [https://console.seam.co/](https://console.seam.co/) and [sign up for Seam](../../core-concepts/seam-console/#create-a-seam-account) to get your [API key](../../core-concepts/authentication/api-keys.md).

{% @supademo/embed demoId="vLRzYM2Nwoi4j_cH9WCNQ" url="https://app.supademo.com/demo/vLRzYM2Nwoi4j_cH9WCNQ" %}

Then, export your API key as an environment variable.

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ go get github.com/seamapi/go

Next, go to [https://console.seam.co/](https://console.seam.co/) and [sign up for Seam](../../core-concepts/seam-console/#create-a-seam-account) to get your [API key](../../core-concepts/authentication/api-keys.md).

{% @supademo/embed demoId="vLRzYM2Nwoi4j_cH9WCNQ" url="https://app.supademo.com/demo/vLRzYM2Nwoi4j_cH9WCNQ" %}

Then, export your API key as an environment variable.

```bash
Expand Down
2 changes: 0 additions & 2 deletions docs/device-guides/get-started-with-august-locks.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ go get github.com/seamapi/go

Next, go to [https://console.seam.co/](https://console.seam.co/) and [sign up for Seam](../core-concepts/seam-console/#create-a-seam-account) to get your [API key](../core-concepts/authentication/api-keys.md).

{% @supademo/embed demoId="vLRzYM2Nwoi4j_cH9WCNQ" url="https://app.supademo.com/demo/vLRzYM2Nwoi4j_cH9WCNQ" %}

Then, export your API key as an environment variable.

```bash
Expand Down
2 changes: 0 additions & 2 deletions docs/device-guides/get-started-with-ttlock-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ go get github.com/seamapi/go

Next, go to [https://console.seam.co/](https://console.seam.co/) and [sign up for Seam](../core-concepts/seam-console/#create-a-seam-account) to get your [API key](../core-concepts/authentication/api-keys.md).

{% @supademo/embed demoId="vLRzYM2Nwoi4j_cH9WCNQ" url="https://app.supademo.com/demo/vLRzYM2Nwoi4j_cH9WCNQ" %}

Then, export your API key as an environment variable.

```bash
Expand Down
7 changes: 0 additions & 7 deletions docs/go-live.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ When you first sign up for Seam, the [Seam Console](core-concepts/seam-console/)
4. Disable **Sandbox mode**.
5. Click **Create Workspace**.

{% @supademo/embed demoId="nXyjx_lwg6VxyiIU4DJkE" url="https://app.supademo.com/demo/nXyjx_lwg6VxyiIU4DJkE" %}

## Create a Production API Key

Once you have switched to your production (non-sandbox) workspace (for example, "My Production Workspace"), you must create a production API key.
Expand All @@ -31,14 +29,9 @@ Once you have switched to your production (non-sandbox) workspace (for example,
Production API keys do not include the `test` token, while API keys for sandbox workspaces do include this `test` token. In addition, if you accidentally commit your API key to a GitHub repo, the `seam_` prefix is detected, and you are notified.
{% endhint %}

{% @supademo/embed demoId="DChwTLKoiqFNyJ3PezXaW" url="https://app.supademo.com/demo/DChwTLKoiqFNyJ3PezXaW" %}

## Customize Your Connect Webviews

You can customize your [Connect Webviews](core-concepts/connect-webviews/). Seam Connect Webviews are fully-embedded client-side components that you add to your app if you want to enable your users to import their own devices using your app. Your users interact with your Connect Webviews to link their device accounts with your app. That is, Connect Webviews walk your users through the process of logging in to their device accounts.

1. In the left navigation pane of the [Seam Console](https://console.seam.co/), click **Webviews**.
2. Add a logo, choose a logo shape, update the base button color, or change the inviter name that your Connect Webviews display to your users.

{% @supademo/embed demoId="1yFG_z1w2nhjXw074goGF" url="https://app.supademo.com/demo/1yFG_z1w2nhjXw074goGF" %}

4 changes: 0 additions & 4 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ To get started with Seam, first connect a set of devices.

Once authorized, the devices associated with this test account appear in your workspace.

{% @supademo/embed demoId="h1y5QMki-7vzlghMzobuf" url="https://app.supademo.com/demo/h1y5QMki-7vzlghMzobuf" %}

## Step 2 — Get an API Key and SDK

To control the devices that you connected in [Step 1](quickstart.md#step-1-connect-devices), you must create an API key and install the Seam SDK in the programming language of your choice.
Expand All @@ -40,8 +38,6 @@ To control the devices that you connected in [Step 1](quickstart.md#step-1-conne
3. In the **Add API Key** dialog, type a name for your new API key and then click **Create API Key**.
4. Copy the newly-created API key and store it for future use.

{% @supademo/embed demoId="vLRzYM2Nwoi4j_cH9WCNQ" url="https://app.supademo.com/demo/vLRzYM2Nwoi4j_cH9WCNQ" %}

### Install the Seam SDK

Install one of the Seam SDKs in the programming language of your choice.
Expand Down

0 comments on commit 3b75e2f

Please sign in to comment.