Skip to content

Commit

Permalink
Merge pull request #52 from smplrspace/feat/pt-1903/white-label
Browse files Browse the repository at this point in the history
[PT-1903] docs for white label
  • Loading branch information
tibotiber committed Feb 23, 2024
2 parents 423540f + f975280 commit 5207a7a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api-reference/space/space.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ const space = new smplr.Space({
clientToken: string,
containerId: string,
disableErrorReporting?: boolean,
whiteLabel?: boolean,
}) => Space
```

- `spaceId` is the unique identifier of the space in Smplrspace, something like "fbc5617e-5a27-4138-851e-839446121b2e".
- ⚠️ **BREAKING CHANGE** ⚠️ — `clientToken` is an API token that is used to authenticate client-side requests. It is safe to have it exposed in your client code. You can manage your organisation's tokens in the Smplrspace app, by heading to the Developers page from the main menu. Client tokens are being rolled out and currently not enforced, starting October 1st 2022, request with no token or an invalid token will be rejected. [More info](/guides/embedding#client-tokens).
- `containerId` is the "id" of the html "div" container where smplr.js should render the viewer, something like "smplr-container" that can be found in your html. Only ids are supported, not classes.
- `disableErrorReporting` - _optional_ - can be set to "true" to disable the automated reporting of errors to our 3rd party error tracking tool, [Sentry](https://sentry.io/). We have discovered that Sentry's instrumentation could make it seem as if all network requests originated from smplr.js. Unfortunately, there is nothing simple we can do on our side to avoid that. If this is an issue for you, you can disable Sentry altogether. The tradeoff is that we will not automatically detect errors hapenning in your integration, and you may need to be more proactive to report them for us to roll out fixes.
- `whiteLabel` - _optional_ - can be set to "true" to remove the "Powered by Smplrspace" attribution from the viewer. This is a paid add-on. You can check if it is enabled from the Organization settings page. [Get in touch](mailto:[email protected]) to learn more.

## Interactive viewer session

Expand Down

0 comments on commit 5207a7a

Please sign in to comment.