-
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.
- Loading branch information
Showing
23 changed files
with
3,672 additions
and
54 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 |
---|---|---|
|
@@ -131,7 +131,7 @@ Isaac,Newton,[email protected],INewton23 | |
|
||
#### JSONファイルを使用する | ||
|
||
`Folder_Structure.json`ファイルは、作成するフォルダ構造を含んでいます。たとえば、`Market Research`フォルダと`Sales Plays`フォルダを作成し、それぞれにサブフォルダ`Statistics`と`Big Pharma`を作成するとします。このスクリプトは、このフォルダ構造を、指定した親フォルダ内の当該ユーザーの`Personal Folder`フォルダの下に配置します。 | ||
`Folder_Structure.json`ファイルは、作成するフォルダ構造を含んでいます。たとえば、`Market Research`フォルダと`Sales Plays`フォルダを作成し、それぞれにサブフォルダ`Statistics`と`Big Pharma`を作成するとします。このスクリプトは、このフォルダ構造を、指定した親フォルダ内にある当該ユーザーの`Personal Folder`フォルダの下に配置します。 | ||
|
||
`FolderStructureJSONPath`パラメータを使用して、`Folder_Structure.json`ファイルの場所を指定します。 | ||
|
||
|
Large diffs are not rendered by default.
Oops, something went wrong.
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
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 @@ | ||
--- | ||
centered: true | ||
rank: 0 | ||
category_id: sign | ||
subcategory_id: null | ||
is_index: true | ||
id: sign | ||
type: page | ||
total_steps: 0 | ||
sibling_id: pages | ||
parent_id: pages | ||
next_page_id: '' | ||
previous_page_id: '' | ||
source_url: 'https://github.com/box/developer.box.com/blob/main/content/pages/sign/index.md' | ||
fullyTranslated: true | ||
--- | ||
# Working with Box Sign | ||
|
||
<ImageFrame center> | ||
|
||
![Working with box sign image](images/working-with-box-sign.png) | ||
|
||
</ImageFrame> | ||
|
||
This learning page provides developers with practical insights into working with [Box Sign][sign], aiming to facilitate the integration of the Box Platform Sign engine into their applications. | ||
|
||
## クイックスタート | ||
|
||
Use the [Quick start][quick-start] to go straight into the creation of a signature request. | ||
|
||
## Technical use cases | ||
|
||
In the [Technical use cases][technical-use-cases], you will learn how to handle the different types of documents that can be used in a signature request: from unstructured documents that require a preparation step, through templates, to generated ready to sign documents. | ||
|
||
## Request Options | ||
|
||
In the [Request options][request-options], you will find a detailed exploration of the available customization and configuration options when sending signing requests through the Box Sign API. Learn how to tailor the signing experience to match your application's user interface, workflow, and specific requirements. | ||
|
||
<!-- ## Business Use Cases The [Business use cases][[advanced-use-cases]] delves into a few of the business use cases, requirements, and workflows you may encounter. See how the Box Platform features come together to provide a seamless signing experience for your users. --> | ||
|
||
Let's get started! | ||
|
||
[sign]: https://www.box.com/esignature | ||
|
||
[quick-start]: page://sign/quick-start | ||
|
||
[request-options]: page://sign/request-options | ||
|
||
[technical-use-cases]: page://sign/technical-use-cases | ||
|
||
<!-- <Tabs> | ||
<Tab title='cURL'> | ||
```bash | ||
``` | ||
</Tab> | ||
<Tab title='Python Gen SDK'> | ||
```python | ||
``` | ||
</Tab> | ||
</Tabs> | ||
--> |
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,57 @@ | ||
--- | ||
centered: true | ||
rank: 1 | ||
category_id: sign | ||
subcategory_id: sign/10-quick-start | ||
is_index: false | ||
id: sign/quick-start/api-basics | ||
type: page | ||
total_steps: 2 | ||
sibling_id: sign/quick-start | ||
parent_id: sign/quick-start | ||
next_page_id: sign/quick-start/your-first-request | ||
previous_page_id: '' | ||
source_url: >- | ||
https://github.com/box/developer.box.com/blob/main/content/pages/sign/10-quick-start/10-api-basics.md | ||
fullyTranslated: true | ||
--- | ||
# API Basics | ||
|
||
## Sign API | ||
|
||
The Sign request endpoint is used to create and manage signature requests. You can create, resend, and cancel signature requests. You can also list all signature requests and get details of a specific signature request. | ||
|
||
The endpoint is `https://{api.box.com}/2.0/sign_requests`. The following table lists the operations that you can perform on this endpoint. | ||
|
||
| 操作 | エンドポイント | 説明 | | ||
| ---- | ------------------------- | -------------------------------------------- | | ||
| GET | /sign_requests | List all signature requests. | | ||
| GET | /sign_requests/:id | Get details of a specific signature request. | | ||
| POST | /sign_requests | Create a signature request. | | ||
| POST | /sign_requests/:id/resend | Resend a signature request. | | ||
| POST | /sign_requests/:id/cancel | Cancel a signature request. | | ||
|
||
For full details on the request and response parameters, see the [Sign request API reference][sign-api-reference]. | ||
|
||
## Sign templates API | ||
|
||
The Sign templates endpoint is used to list and get details of a template. | ||
|
||
<Message type="notice"> | ||
|
||
You can not create, edit, or delete templates using the API. These templates are exclusively managed in the Box web application. | ||
|
||
</Message> | ||
|
||
The endpoint is `https://{api.box.com}/2.0/sign_templates`. The following table lists the operations that you can perform on this endpoint. | ||
|
||
| 操作 | エンドポイント | 説明 | | ||
| --- | ------------------- | ----------------------------------- | | ||
| GET | /sign_templates | List all templates. | | ||
| GET | /sign_templates/:id | Get details of a specific template. | | ||
|
||
For a full details on the request and response parameters, see the [Sign template request API reference][sign-api-template-ref] | ||
|
||
[sign-api-reference]: https://developer.box.com/reference/resources/sign-request/ | ||
|
||
[sign-api-template-ref]: https://developer.box.com/reference/resources/sign-template/ |
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,30 @@ | ||
--- | ||
centered: true | ||
rank: 10 | ||
category_id: sign | ||
subcategory_id: sign/10-quick-start | ||
is_index: true | ||
id: sign/quick-start | ||
type: page | ||
total_steps: 2 | ||
sibling_id: sign | ||
parent_id: sign | ||
next_page_id: '' | ||
previous_page_id: sign/quick-start/your-first-request | ||
source_url: >- | ||
https://github.com/box/developer.box.com/blob/main/content/pages/sign/10-quick-start/index.md | ||
fullyTranslated: true | ||
--- | ||
# クイックスタート | ||
|
||
Get a sense of how the [Box Sign API][api-basics] is structured and how to create your first signature request. | ||
|
||
The Sign API does not follow the traditional CRUD model. You can create, resend, and cancel signature requests. You can also list all signature requests and get details of a specific signature request. | ||
|
||
Sign Templates API is read-only. You can list all templates and get details of a specific template. | ||
|
||
Once you get a sense of the API, you can create [your first signature request][quick-start]. | ||
|
||
[api-basics]: page://sign/quick-start/api-basics | ||
|
||
[quick-start]: page://sign/quick-start/your-first-request |
Oops, something went wrong.