Cloudsign

Cloudsign連携に関するアクション一覧です。
CloudsignCreateDoc
概要
CloudsignCreateDoc は、クラウドサイン上で登録されているテンプレートを元に新しい契約書を作成します。作成された契約書（初めは下書き状態）のJSON形式のオブジェクトを返却します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
template_id
文字列
利用するテンプレートのIDです。Provider IDが入力されている時は、ハンバーガーメニューのクラウドサインのアイコンボタンから選択できます。
e7502c3b8b814741e7502c3b8b814741
title
文字列
契約書のタイトル
"Robotic Crowd ご利用申込書"
note
文字列
契約相手など、メモ情報（相手に表示されません）
"株式会社チュートリアル"
message
文字列
宛先に表示するメッセージ
"必要事項をご記入の上、電子署名してください。"
can_transfer
真理値
宛先に署名者の転送を許可するかどうか。
true
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊使用例を参照
使用例
1
# クラウドサインで契約書を作成する
2
+cloudsign_create_doc_1:
3
  action>: CloudsignCreateDoc
4
  provider: cloudsign_8357f23661244793397f5
5
  template_id: 01fdsnwc931562354s42wkd7zr7bd7
6
  title: '業務委託契約書'
7
  note: '株式会社チュートリアル'
8
  message: '必要事項をご記入の上、電子署名してください。'
9
  can_transfer: true
10
​
11
# {
12
#   "id": "01f12312312mtrznq45bd2hgkq8c",
13
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
14
#   "title": "業務委託契約書",
15
#   "note": "株式会社チュートリアル",
16
#   "message": "必要事項をご記入の上、電子署名してください。",
17
#   "status": 0,
18
#   "can_transfer": true,
19
#   "sent_at": null,
20
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
21
#   "created_at": "2020-06-11T14:40:21Z",
22
#   "updated_at": "2020-06-11T14:40:21Z",
23
#   "participants": [
24
#     {
25
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
26
#       "email": "[email protected]",
27
#       "name": "John Doe",
28
#       "organization": "Acme Company",
29
#       "order": 0,
30
#       "status": 2,
31
#       "language_code": "ja",
32
#       "processed_at": null
33
#     },
34
#     {
35
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
36
#       "email": "_1",
37
#       "name": "",
38
#       "organization": "",
39
#       "order": 1,
40
#       "status": 0,
41
#       "language_code": "ja",
42
#       "processed_at": null
43
#     }
44
#   ],
45
#   "files": [
46
#     {
47
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
48
#       "name": "業務委託契約.pdf",
49
#       "order": 0,
50
#       "total_pages": 1,
51
#       "widgets": [
52
#         {
53
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
54
#           "widget_type": 1,
55
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
56
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
57
#           "page": 0,
58
#           "x": 288,
59
#           "y": 725,
60
#           "w": 206,
61
#           "h": 40,
62
#           "text": "",
63
#           "status": 0,
64
#           "label": "住所"
65
#         },
66
#         {
67
#           "id": "01fe4gjn123121z675y79r9k43a4y",
68
#           "widget_type": 0,
69
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
70
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
71
#           "page": 0,
72
#           "x": 461,
73
#           "y": 696,
74
#           "w": 80,
75
#           "h": 75,
76
#           "text": "",
77
#           "status": 0,
78
#           "label": "押印"
79
#         },
80
#         {
81
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
82
#           "widget_type": 1,
83
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
84
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
85
#           "page": 0,
86
#           "x": 279,
87
#           "y": 755,
88
#           "w": 206,
89
#           "h": 40,
90
#           "text": "",
91
#           "status": 0,
92
#           "label": "氏名"
93
#         }
94
#       ]
95
#     }
96
#   ]
97
# }
Copied!
CloudsignUpdateDocParticipant
概要
CloudsignUpdateDocParticipant は、契約書の宛先の情報を更新します。例えば、テンプレートにEmailや氏名の無い宛先を仮に登録しておいて、テンプレートから契約書を作成した後に仮に登録されていた宛先の情報を具体的に入力すると言うような使い方ができます。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
document_id*
文字列
更新するドキュメントのIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。
01f12312312mtrznq45bd2hgkq8c
participant_id*
文字列
更新する宛先のIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。
5a9444df-99e7-4693-87b8-cd65c397af1e
email*
文字列
宛先のEmail
"Robotic Crowd ご利用申込書"
name*
文字列
宛先の名前
"福田 志郎"
organization
文字列
宛先の所属先
"株式会社チュートリアル"
access_code
文字列
アクセスコード（書類を開く時に必要な暗号）を指定します。
7171
language_code
文字列
日本語（ja）、英語（en）、簡体字（zh-CHS）、繁体字（zh-CHT）から選択します。
ja
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊CloudsignCreateDoc と同じです
使用例
1
# 契約書の宛先を更新します
2
+cloudsign_update_doc_participant_1:
3
  action>: CloudsignUpdateDocParticipant
4
  provider: cloudsign_83513211238793397f5
5
  document_id: ${document.id}
6
  participant_id: ${document.participants[1].id}
7
  email: '[email protected]'
8
  name: 'Emma Aire'
9
  organization: 'Acme Inc.'
10
  access_code: 1234
11
  language_code: ja
12
​
13
# {
14
#   "id": "01f12312312mtrznq45bd2hgkq8c",
15
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
16
#   "title": "業務委託契約書",
17
#   "note": "株式会社チュートリアル",
18
#   "message": "必要事項をご記入の上、電子署名してください。",
19
#   "status": 0,
20
#   "can_transfer": true,
21
#   "sent_at": null,
22
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
23
#   "created_at": "2020-06-11T14:40:21Z",
24
#   "updated_at": "2020-06-11T14:40:21Z",
25
#   "participants": [
26
#     {
27
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
28
#       "email": "[email protected]",
29
#       "name": "John Doe",
30
#       "organization": "Acme Company",
31
#       "order": 0,
32
#       "status": 2,
33
#       "language_code": "ja",
34
#       "processed_at": null
35
#     },
36
#     {
37
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
38
#       "email": "[email protected]",
39
#       "name": "Emma Aire3",
40
#       "organization": "Acme Inc.",
41
#       "order": 1,
42
#       "status": 0,
43
#       "language_code": "ja",
44
#       "processed_at": null
45
#     }
46
#   ],
47
#   "files": [
48
#     {
49
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
50
#       "name": "業務委託契約.pdf",
51
#       "order": 0,
52
#       "total_pages": 1,
53
#       "widgets": [
54
#         {
55
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
56
#           "widget_type": 1,
57
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
58
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
59
#           "page": 0,
60
#           "x": 288,
61
#           "y": 725,
62
#           "w": 206,
63
#           "h": 40,
64
#           "text": "",
65
#           "status": 0,
66
#           "label": "住所"
67
#         },
68
#         {
69
#           "id": "01fe4gjn123121z675y79r9k43a4y",
70
#           "widget_type": 0,
71
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
72
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
73
#           "page": 0,
74
#           "x": 461,
75
#           "y": 696,
76
#           "w": 80,
77
#           "h": 75,
78
#           "text": "",
79
#           "status": 0,
80
#           "label": "押印"
81
#         },
82
#         {
83
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
84
#           "widget_type": 1,
85
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
86
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
87
#           "page": 0,
88
#           "x": 279,
89
#           "y": 755,
90
#           "w": 206,
91
#           "h": 40,
92
#           "text": "",
93
#           "status": 0,
94
#           "label": "氏名"
95
#         }
96
#       ]
97
#     }
98
#   ]
99
# }
Copied!
CloudsignSetWidgetText
概要
CloudsignSetWidgetText は、契約書のフリーテキスト欄の値を更新します。例えば、テンプレートに相手の住所や名前をフリーテキストで入力できるようにしておいた時、このアクションで値を具体的に入力すると言うような使い方ができます。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
document_id*
文字列
更新するドキュメントのIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。
01f12312312mtrznq45bd2hgkq8c
file_id*
文字列
更新するファイルのIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。
01fe4gjnmxmna9pkmvz62z8g22392938gy
widget_id*
文字列
更新するフリーテキストのWidget IDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。
01fe4gj1231231ftmw56fws45bhvfskaba
text
文字列
入力する値
"東京都千代田区神田神保町2-11-15"
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊CloudsignCreateDoc と同じです
使用例
1
# 契約書の宛先を更新します
2
+cloudsign_set_widget_text_1:
3
  action>: CloudsignSetWidgetText
4
  provider: cloudsign_8357f213123123397f5
5
  document_id: ${document.id}
6
  file_id: ${document.files[0].id}
7
  widget_id: ${widget.id}
8
  text: '東京都千代田区神田神保町2-11-15'
9
​
10
# {
11
#   "id": "01f12312312mtrznq45bd2hgkq8c",
12
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
13
#   "title": "業務委託契約書",
14
#   "note": "株式会社チュートリアル",
15
#   "message": "必要事項をご記入の上、電子署名してください。",
16
#   "status": 0,
17
#   "can_transfer": true,
18
#   "sent_at": null,
19
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
20
#   "created_at": "2020-06-11T14:40:21Z",
21
#   "updated_at": "2020-06-11T14:40:21Z",
22
#   "participants": [
23
#     {
24
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
25
#       "email": "[email protected]",
26
#       "name": "John Doe",
27
#       "organization": "Acme Company",
28
#       "order": 0,
29
#       "status": 2,
30
#       "language_code": "ja",
31
#       "processed_at": null
32
#     },
33
#     {
34
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
35
#       "email": "[email protected]",
36
#       "name": "Emma Aire3",
37
#       "organization": "Acme Inc.",
38
#       "order": 1,
39
#       "status": 0,
40
#       "language_code": "ja",
41
#       "processed_at": null
42
#     }
43
#   ],
44
#   "files": [
45
#     {
46
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
47
#       "name": "業務委託契約.pdf",
48
#       "order": 0,
49
#       "total_pages": 1,
50
#       "widgets": [
51
#         {
52
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
53
#           "widget_type": 1,
54
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
55
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
56
#           "page": 0,
57
#           "x": 288,
58
#           "y": 725,
59
#           "w": 206,
60
#           "h": 40,
61
#           "text": "東京都千代田区神田神保町2-11-15",
62
#           "status": 0,
63
#           "label": "住所"
64
#         },
65
#         {
66
#           "id": "01fe4gjn123121z675y79r9k43a4y",
67
#           "widget_type": 0,
68
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
69
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
70
#           "page": 0,
71
#           "x": 461,
72
#           "y": 696,
73
#           "w": 80,
74
#           "h": 75,
75
#           "text": "",
76
#           "status": 0,
77
#           "label": "押印"
78
#         },
79
#         {
80
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
81
#           "widget_type": 1,
82
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
83
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
84
#           "page": 0,
85
#           "x": 279,
86
#           "y": 755,
87
#           "w": 206,
88
#           "h": 40,
89
#           "text": "",
90
#           "status": 0,
91
#           "label": "氏名"
92
#         }
93
#       ]
94
#     }
95
#   ]
96
# }
Copied!
CloudsignSendDoc
概要
CloudsignSendDoc は、契約書を実際に送信します。実行すると、宛先にメールが送信され契約書のステータスは、0（下書き）から 1（送信済み）になります。また、JSONオブジェクトの sent_at 属性も null から日時が入ります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
document_id*
文字列
送信する契約書のIDです。
01f12312312mtrznq45bd2hgkq8c
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊CloudsignCreateDoc と同じです
使用例
1
# 契約書を送信する
2
+cloudsign_send_doc_1:
3
  action>: CloudsignSendDoc
4
  provider: cloudsign_8357f2312313213397f5
5
  document_id: ${document.id}
6
​
7
# {
8
#   "id": "01f12312312mtrznq45bd2hgkq8c",
9
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
10
#   "title": "業務委託契約書",
11
#   "note": "株式会社チュートリアル",
12
#   "message": "必要事項をご記入の上、電子署名してください。",
13
#   "status": 1,
14
#   "can_transfer": true,
15
#   "sent_at": "2020-06-11T14:40:59Z",
16
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
17
#   "created_at": "2020-06-11T14:40:21Z",
18
#   "updated_at": "2020-06-11T14:40:21Z",
19
#   "participants": [
20
#     {
21
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
22
#       "email": "[email protected]",
23
#       "name": "John Doe",
24
#       "organization": "Acme Company",
25
#       "order": 0,
26
#       "status": 2,
27
#       "language_code": "ja",
28
#       "processed_at": null
29
#     },
30
#     {
31
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
32
#       "email": "[email protected]",
33
#       "name": "Emma Aire3",
34
#       "organization": "Acme Inc.",
35
#       "order": 1,
36
#       "status": 0,
37
#       "language_code": "ja",
38
#       "processed_at": null
39
#     }
40
#   ],
41
#   "files": [
42
#     {
43
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
44
#       "name": "業務委託契約.pdf",
45
#       "order": 0,
46
#       "total_pages": 1,
47
#       "widgets": [
48
#         {
49
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
50
#           "widget_type": 1,
51
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
52
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
53
#           "page": 0,
54
#           "x": 288,
55
#           "y": 725,
56
#           "w": 206,
57
#           "h": 40,
58
#           "text": "東京都千代田区神田神保町2-11-15",
59
#           "status": 0,
60
#           "label": "住所"
61
#         },
62
#         {
63
#           "id": "01fe4gjn123121z675y79r9k43a4y",
64
#           "widget_type": 0,
65
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
66
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
67
#           "page": 0,
68
#           "x": 461,
69
#           "y": 696,
70
#           "w": 80,
71
#           "h": 75,
72
#           "text": "",
73
#           "status": 0,
74
#           "label": "押印"
75
#         },
76
#         {
77
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
78
#           "widget_type": 1,
79
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
80
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
81
#           "page": 0,
82
#           "x": 279,
83
#           "y": 755,
84
#           "w": 206,
85
#           "h": 40,
86
#           "text": "",
87
#           "status": 0,
88
#           "label": "氏名"
89
#         }
90
#       ]
91
#     }
92
#   ]
93
# }
Copied!
CloudsignAttachFile
概要
CloudsignAttachFile は、クラウドサイン上で登録されている契約書にファイルを追加します（PDFファイル）。作成された契約書（初めは下書き状態）のJSON形式のオブジェクトを返却します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
document_id*
文字列
ファイルを添付する契約書IDです。
01f12312312mtrznq45bd2hgkq8c
file*
文字列
添付するファイルのパス
/tmp/file.pdf
name
文字列
添付するファイルの名前（変更する場合）
〇〇様_ご契約書
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊使用例を参照
使用例
PDFファイルを元にして新しい契約書を作成します。
1
# 契約書を作成する
2
+cloudsign_create_doc_1:
3
  action>: CloudsignCreateDoc
4
  provider: cloudsign_xxxxxxxx
5
  template_id: '' # 空のまま送信するとファイル無しの契約書が作成されます
6
  title: '〇〇様ご契約書'
7
  can_transfer: true
8
​
9
# ドキュメントIDを取得
10
+get_value_with_key_1:
11
  action>: GetValueWithKey
12
  object: +cloudsign_create_doc_1
13
  key: id
14
​
15
# ドキュメントにファイルを添付する
16
+cloudsign_attach_file_1:
17
  action>: CloudsignAttachFile
18
  provider: cloudsign_xxxxxxxx
19
  document_id: +get_value_with_key_1
20
  file: '/tmp/contract.pdf'
21
  name: '〇〇様_ご契約書'
22
​
23
# {
24
#   "id": "xxxxxxxx",
25
#   "user_id": "xxxxxxxx",
26
#   "title": "〇〇様ご契約書",
27
#   "note": "",
28
#   "message": "",
29
#   "status": 0,
30
#   "can_transfer": true,
31
#   "sent_at": null,
32
#   "last_processed_at": "2021-01-04T06:18:10.460507Z",
33
#   "created_at": "2021-01-04T06:18:10Z",
34
#   "updated_at": "2021-01-04T06:18:10Z",
35
#   "participants": [
36
#     {
37
#       "id": "xxxxxxxx",
38
#       "email": "[email protected]",
39
#       "name": "福田 志郎",
40
#       "organization": "株式会社チュートリアル",
41
#       "order": 0,
42
#       "status": 2,
43
#       "language_code": "ja",
44
#       "processed_at": null
45
#     }
46
#   ],
47
#   "files": [
48
#     {
49
#       "id": "xxxxxxxx",
50
#       "name": "〇〇様_ご契約書.pdf",
51
#       "order": 0,
52
#       "total_pages": 1
53
#     }
54
#   ]
55
# }
Copied!
Actions - Previous
Trello
Next - Actions
Salesforce
Last modified 1yr ago