Cloudsign

Cloudsign連携に関するアクション一覧です。
CloudsignCreateDoc
概要
CloudsignCreateDoc は、クラウドサイン上で登録されているテンプレートを元に新しい契約書を作成します。作成された契約書（初めは下書き状態）のJSON形式のオブジェクトを返却します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
template_id
文字列
利用するテンプレートのIDです。Provider IDが入力されている時は、ハンバーガーメニューのクラウドサインのアイコンボタンから選択できます。
e7502c3b8b814741e7502c3b8b814741
title
文字列
契約書のタイトル
"AUTORO ご利用申込書"
note
文字列
契約相手など、メモ情報（相手に表示されません）
"オートロ株式会社"
message
文字列
宛先に表示するメッセージ
"必要事項をご記入の上、電子署名してください。"
can_transfer
真理値
宛先に署名者の転送を許可するかどうか。
true
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊使用例を参照
使用例
# クラウドサインで契約書を作成する
+cloudsign_create_doc_1:
  action>: CloudsignCreateDoc
  provider: cloudsign_8357f23661244793397f5
  template_id: 01fdsnwc931562354s42wkd7zr7bd7
  title: '業務委託契約書'
  note: 'オートロ株式会社'
  message: '必要事項をご記入の上、電子署名してください。'
  can_transfer: true
​
# {
#   "id": "01f12312312mtrznq45bd2hgkq8c",
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
#   "title": "業務委託契約書",
#   "note": "オートロ株式会社",
#   "message": "必要事項をご記入の上、電子署名してください。",
#   "status": 0,
#   "can_transfer": true,
#   "sent_at": null,
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
#   "created_at": "2020-06-11T14:40:21Z",
#   "updated_at": "2020-06-11T14:40:21Z",
#   "participants": [
#     {
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
#       "email": "[email protected]",
#       "name": "John Doe",
#       "organization": "Acme Company",
#       "order": 0,
#       "status": 2,
#       "language_code": "ja",
#       "processed_at": null
#     },
#     {
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
#       "email": "_1",
#       "name": "",
#       "organization": "",
#       "order": 1,
#       "status": 0,
#       "language_code": "ja",
#       "processed_at": null
#     }
#   ],
#   "files": [
#     {
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
#       "name": "業務委託契約.pdf",
#       "order": 0,
#       "total_pages": 1,
#       "widgets": [
#         {
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 288,
#           "y": 725,
#           "w": 206,
#           "h": 40,
#           "text": "",
#           "status": 0,
#           "label": "住所"
#         },
#         {
#           "id": "01fe4gjn123121z675y79r9k43a4y",
#           "widget_type": 0,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 461,
#           "y": 696,
#           "w": 80,
#           "h": 75,
#           "text": "",
#           "status": 0,
#           "label": "押印"
#         },
#         {
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 279,
#           "y": 755,
#           "w": 206,
#           "h": 40,
#           "text": "",
#           "status": 0,
#           "label": "氏名"
#         }
#       ]
#     }
#   ]
# }
CloudsignUpdateDocParticipant
概要
CloudsignUpdateDocParticipant は、契約書の宛先の情報を更新します。例えば、テンプレートにEmailや氏名の無い宛先を仮に登録しておいて、テンプレートから契約書を作成した後に仮に登録されていた宛先の情報を具体的に入力すると言うような使い方ができます。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
document_id*
文字列
更新するドキュメントのIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。
01f12312312mtrznq45bd2hgkq8c
participant_id*
文字列
更新する宛先のIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。
5a9444df-99e7-4693-87b8-cd65c397af1e
email*
文字列
宛先のEmail
[email protected]
name*
文字列
宛先の名前
"福田 志郎"
organization
文字列
宛先の所属先
"オートロ株式会社"
access_code
文字列
アクセスコード（書類を開く時に必要な暗号）を指定します。
7171
language_code
文字列
日本語（ja）、英語（en）、簡体字（zh-CHS）、繁体字（zh-CHT）から選択します。
ja
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊CloudsignCreateDoc と同じです
使用例
# 契約書の宛先を更新します
+cloudsign_update_doc_participant_1:
  action>: CloudsignUpdateDocParticipant
  provider: cloudsign_83513211238793397f5
  document_id: ${document.id}
  participant_id: ${document.participants[1].id}
  email: '[email protected]'
  name: 'Emma Aire'
  organization: 'Acme Inc.'
  access_code: 1234
  language_code: ja
​
# {
#   "id": "01f12312312mtrznq45bd2hgkq8c",
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
#   "title": "業務委託契約書",
#   "note": "オートロ株式会社",
#   "message": "必要事項をご記入の上、電子署名してください。",
#   "status": 0,
#   "can_transfer": true,
#   "sent_at": null,
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
#   "created_at": "2020-06-11T14:40:21Z",
#   "updated_at": "2020-06-11T14:40:21Z",
#   "participants": [
#     {
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
#       "email": "[email protected]",
#       "name": "John Doe",
#       "organization": "Acme Company",
#       "order": 0,
#       "status": 2,
#       "language_code": "ja",
#       "processed_at": null
#     },
#     {
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
#       "email": "[email protected]",
#       "name": "Emma Aire3",
#       "organization": "Acme Inc.",
#       "order": 1,
#       "status": 0,
#       "language_code": "ja",
#       "processed_at": null
#     }
#   ],
#   "files": [
#     {
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
#       "name": "業務委託契約.pdf",
#       "order": 0,
#       "total_pages": 1,
#       "widgets": [
#         {
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 288,
#           "y": 725,
#           "w": 206,
#           "h": 40,
#           "text": "",
#           "status": 0,
#           "label": "住所"
#         },
#         {
#           "id": "01fe4gjn123121z675y79r9k43a4y",
#           "widget_type": 0,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 461,
#           "y": 696,
#           "w": 80,
#           "h": 75,
#           "text": "",
#           "status": 0,
#           "label": "押印"
#         },
#         {
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 279,
#           "y": 755,
#           "w": 206,
#           "h": 40,
#           "text": "",
#           "status": 0,
#           "label": "氏名"
#         }
#       ]
#     }
#   ]
# }
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 と同じです
使用例
# 契約書の宛先を更新します
+cloudsign_set_widget_text_1:
  action>: CloudsignSetWidgetText
  provider: cloudsign_8357f213123123397f5
  document_id: ${document.id}
  file_id: ${document.files[0].id}
  widget_id: ${widget.id}
  text: '東京都千代田区神田神保町2-11-15'
​
# {
#   "id": "01f12312312mtrznq45bd2hgkq8c",
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
#   "title": "業務委託契約書",
#   "note": "オートロ株式会社",
#   "message": "必要事項をご記入の上、電子署名してください。",
#   "status": 0,
#   "can_transfer": true,
#   "sent_at": null,
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
#   "created_at": "2020-06-11T14:40:21Z",
#   "updated_at": "2020-06-11T14:40:21Z",
#   "participants": [
#     {
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
#       "email": "[email protected]",
#       "name": "John Doe",
#       "organization": "Acme Company",
#       "order": 0,
#       "status": 2,
#       "language_code": "ja",
#       "processed_at": null
#     },
#     {
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
#       "email": "[email protected]",
#       "name": "Emma Aire3",
#       "organization": "Acme Inc.",
#       "order": 1,
#       "status": 0,
#       "language_code": "ja",
#       "processed_at": null
#     }
#   ],
#   "files": [
#     {
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
#       "name": "業務委託契約.pdf",
#       "order": 0,
#       "total_pages": 1,
#       "widgets": [
#         {
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 288,
#           "y": 725,
#           "w": 206,
#           "h": 40,
#           "text": "東京都千代田区神田神保町2-11-15",
#           "status": 0,
#           "label": "住所"
#         },
#         {
#           "id": "01fe4gjn123121z675y79r9k43a4y",
#           "widget_type": 0,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 461,
#           "y": 696,
#           "w": 80,
#           "h": 75,
#           "text": "",
#           "status": 0,
#           "label": "押印"
#         },
#         {
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 279,
#           "y": 755,
#           "w": 206,
#           "h": 40,
#           "text": "",
#           "status": 0,
#           "label": "氏名"
#         }
#       ]
#     }
#   ]
# }
CloudsignSendDoc
概要
CloudsignSendDoc は、契約書を実際に送信します。実行すると、宛先にメールが送信され契約書のステータスは、0（下書き）から 1（送信済み）になります。また、JSONオブジェクトの sent_at 属性も null から日時が入ります。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
document_id*
文字列
送信する契約書のIDです。
01f12312312mtrznq45bd2hgkq8c
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊CloudsignCreateDoc と同じです
使用例
# 契約書を送信する
+cloudsign_send_doc_1:
  action>: CloudsignSendDoc
  provider: cloudsign_8357f2312313213397f5
  document_id: ${document.id}
​
# {
#   "id": "01f12312312mtrznq45bd2hgkq8c",
#   "user_id": "11f930-6411-4f8c-bdf9-236c30b45752",
#   "title": "業務委託契約書",
#   "note": "オートロ株式会社",
#   "message": "必要事項をご記入の上、電子署名してください。",
#   "status": 1,
#   "can_transfer": true,
#   "sent_at": "2020-06-11T14:40:59Z",
#   "last_processed_at": "2020-06-11T23:40:21.545969892+09:00",
#   "created_at": "2020-06-11T14:40:21Z",
#   "updated_at": "2020-06-11T14:40:21Z",
#   "participants": [
#     {
#       "id": "7e344230-5e7e-4ebd-80ac-a0e0cf054439",
#       "email": "[email protected]",
#       "name": "John Doe",
#       "organization": "Acme Company",
#       "order": 0,
#       "status": 2,
#       "language_code": "ja",
#       "processed_at": null
#     },
#     {
#       "id": "5a9444df-99e7-4693-87b8-cd65c3ef212332",
#       "email": "[email protected]",
#       "name": "Emma Aire3",
#       "organization": "Acme Inc.",
#       "order": 1,
#       "status": 0,
#       "language_code": "ja",
#       "processed_at": null
#     }
#   ],
#   "files": [
#     {
#       "id": "01fe4gjnmxmna9pkmvz62z8g22392938gy",
#       "name": "業務委託契約.pdf",
#       "order": 0,
#       "total_pages": 1,
#       "widgets": [
#         {
#           "id": "01fe4gj1231231ftmw56fws45bhvfskaba",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 288,
#           "y": 725,
#           "w": 206,
#           "h": 40,
#           "text": "東京都千代田区神田神保町2-11-15",
#           "status": 0,
#           "label": "住所"
#         },
#         {
#           "id": "01fe4gjn123121z675y79r9k43a4y",
#           "widget_type": 0,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 461,
#           "y": 696,
#           "w": 80,
#           "h": 75,
#           "text": "",
#           "status": 0,
#           "label": "押印"
#         },
#         {
#           "id": "01fe4gjnmjsjzq5qema77qhda7rbj4q0",
#           "widget_type": 1,
#           "participant_id": "5a9444df-99e7-4693-87b8-cd65c397af1e",
#           "file_id": "01fe4gjnmxmna9pkmvz62z8gxfsz813j",
#           "page": 0,
#           "x": 279,
#           "y": 755,
#           "w": 206,
#           "h": 40,
#           "text": "",
#           "status": 0,
#           "label": "氏名"
#         }
#       ]
#     }
#   ]
# }
CloudsignAttachFile
概要
CloudsignAttachFile は、クラウドサイン上で登録されている契約書にファイルを追加します（PDFファイル）。作成された契約書（初めは下書き状態）のJSON形式のオブジェクトを返却します。
パラメーター
*は、必須パラメーター
名前
型
概要
例
provider*
文字列
Cloudsign連携に必要なプロバイダーID
cloudsign_e7502c3b8b8147410ce2
document_id*
文字列
ファイルを添付する契約書IDです。
01f12312312mtrznq45bd2hgkq8c
file*
文字列
添付するファイルのパス
/tmp/file.pdf
name
文字列
添付するファイルの名前（変更する場合）
〇〇様_ご契約書
アウトプット
タイプ
型
概要
例
JSON
オブジェクト
JSONレスポンス
＊使用例を参照
使用例
PDFファイルを元にして新しい契約書を作成します。
# 契約書を作成する
+cloudsign_create_doc_1:
  action>: CloudsignCreateDoc
  provider: cloudsign_xxxxxxxx
  template_id: '' # 空のまま送信するとファイル無しの契約書が作成されます
  title: '〇〇様ご契約書'
  can_transfer: true
​
# ドキュメントIDを取得
+get_value_with_key_1:
  action>: GetValueWithKey
  object: +cloudsign_create_doc_1
  key: id
​
# ドキュメントにファイルを添付する
+cloudsign_attach_file_1:
  action>: CloudsignAttachFile
  provider: cloudsign_xxxxxxxx
  document_id: +get_value_with_key_1
  file: '/tmp/contract.pdf'
  name: '〇〇様_ご契約書'
​
# {
#   "id": "xxxxxxxx",
#   "user_id": "xxxxxxxx",
#   "title": "〇〇様ご契約書",
#   "note": "",
#   "message": "",
#   "status": 0,
#   "can_transfer": true,
#   "sent_at": null,
#   "last_processed_at": "2021-01-04T06:18:10.460507Z",
#   "created_at": "2021-01-04T06:18:10Z",
#   "updated_at": "2021-01-04T06:18:10Z",
#   "participants": [
#     {
#       "id": "xxxxxxxx",
#       "email": "[email protected]",
#       "name": "福田 志郎",
#       "organization": "オートロ株式会社",
#       "order": 0,
#       "status": 2,
#       "language_code": "ja",
#       "processed_at": null
#     }
#   ],
#   "files": [
#     {
#       "id": "xxxxxxxx",
#       "name": "〇〇様_ご契約書.pdf",
#       "order": 0,
#       "total_pages": 1
#     }
#   ]
# }

名前	型	概要	例
provider*	文字列	Cloudsign連携に必要なプロバイダーID	cloudsign_e7502c3b8b8147410ce2
template_id	文字列	利用するテンプレートのIDです。Provider IDが入力されている時は、ハンバーガーメニューのクラウドサインのアイコンボタンから選択できます。	e7502c3b8b814741e7502c3b8b814741
title	文字列	契約書のタイトル	"AUTORO ご利用申込書"
note	文字列	契約相手など、メモ情報（相手に表示されません）	"オートロ株式会社"
message	文字列	宛先に表示するメッセージ	"必要事項をご記入の上、電子署名してください。"
can_transfer	真理値	宛先に署名者の転送を許可するかどうか。	true

タイプ	型	概要	例
JSON	オブジェクト	JSONレスポンス	＊使用例を参照

名前	型	概要	例
provider*	文字列	Cloudsign連携に必要なプロバイダーID	cloudsign_e7502c3b8b8147410ce2
document_id*	文字列	更新するドキュメントのIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。	01f12312312mtrznq45bd2hgkq8c
participant_id*	文字列	更新する宛先のIDです。新規に作成した場合は、IDがわかりませんので、アウトプットから取得し設定する必要があります。	5a9444df-99e7-4693-87b8-cd65c397af1e
email*	文字列	宛先のEmail	[email protected]
name*	文字列	宛先の名前	"福田志郎"
organization	文字列	宛先の所属先	"オートロ株式会社"
access_code	文字列	アクセスコード（書類を開く時に必要な暗号）を指定します。	7171
language_code	文字列	日本語（ja）、英語（en）、簡体字（zh-CHS）、繁体字（zh-CHT）から選択します。	ja

タイプ	型	概要	例
JSON	オブジェクト	JSONレスポンス	＊CloudsignCreateDoc と同じです

名前	型	概要	例
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 と同じです

名前	型	概要	例
provider*	文字列	Cloudsign連携に必要なプロバイダーID	cloudsign_e7502c3b8b8147410ce2
document_id*	文字列	送信する契約書のIDです。	01f12312312mtrznq45bd2hgkq8c

タイプ	型	概要	例
JSON	オブジェクト	JSONレスポンス	＊CloudsignCreateDoc と同じです

名前	型	概要	例
provider*	文字列	Cloudsign連携に必要なプロバイダーID	cloudsign_e7502c3b8b8147410ce2
document_id*	文字列	ファイルを添付する契約書IDです。	01f12312312mtrznq45bd2hgkq8c
file*	文字列	添付するファイルのパス	/tmp/file.pdf
name	文字列	添付するファイルの名前（変更する場合）	〇〇様_ご契約書

タイプ	型	概要	例
JSON	オブジェクト	JSONレスポンス	＊使用例を参照

Last modified 7mo ago