-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'DDOC-833-templates' of github.com:box/developer.box.com…
… into staging
- Loading branch information
Showing
4 changed files
with
375 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
rank: 6 | ||
related_endpoints: [] | ||
related_guides: [] | ||
required_guides: [] | ||
related_resources: [] | ||
alias_paths: | ||
- guides/box-sign/create-sign-request/#embedded-sign-client | ||
--- | ||
|
||
# Embedded Sign client | ||
|
||
[Box Embed][embed] allows you to embed Box Sign | ||
features into your own website. This way, users | ||
don't have to leave the website, go to Box Sign | ||
to sign the document, and then come back to finish | ||
the process. | ||
Instead, Box Embed allows them | ||
to complete the signing process | ||
within the external website. | ||
|
||
To integrate Box Sign experience within your | ||
own website, you need the `iframable_embed_url` | ||
parameter that is specifically designed to allow | ||
signing documents within the HTML `iframe` tag. | ||
|
||
<!-- markdownlint-disable line-length --> | ||
|
||
A sample `iframable_embed_url` looks as follows: | ||
|
||
```sh | ||
https://app.box.com/embed/sign/document/f14d7098-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4 | ||
``` | ||
|
||
To get the `iframeable_embed_url` pass the [`embed_url_external_user_id`][externalid] parameter for each signer when calling the [create sign request][signrequest] endpoint. | ||
The returned response will contain a unique `iframeable_embed_url` for that signer. | ||
|
||
To embed Sign features and make them | ||
available to the users, | ||
use the URL within the `iframe` tag: | ||
|
||
```sh | ||
<iframe | ||
src="https://app.box.com/embed/sign/document/f14d7098-a331-494b-808b-79bc7f3992a3/f14d7098-a331-494b-808b-79bc7f3992a4" | ||
width="{pixels}" | ||
height="{pixels}" | ||
frameborder="0" | ||
allowfullscreen | ||
webkitallowfullscreen | ||
msallowfullscreen | ||
></iframe> | ||
``` | ||
|
||
<!-- markdownlint-enable line-length --> | ||
|
||
<Message> | ||
For details on working with Box Embed, see [this guide][embedguide]. | ||
</Message> | ||
|
||
Box Embed uses the [Cloud Game][cloudgame] widget to | ||
prevent clickjacking. | ||
In this case, when the user wants to sign | ||
a document, they will have to interact | ||
with the widget and drag a cloud to the correct | ||
location before proceeding to document signing. | ||
|
||
[embed]: g://embed/box-embed | ||
[embedguide]: g://embed/box-embed#programmatically | ||
[signrequest]: e://post-sign-requests | ||
[externalid]: e://post-sign-requests#param-signers-embed_url_external_user_id | ||
[cloudgame]: g://embed/box-embed#cloud-game |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
rank: 2 | ||
rank: 5 | ||
--- | ||
|
||
# List Box Sign Requests | ||
|
Oops, something went wrong.