GMO サイン: 文書ファイルURL取得
GMO Sign: Retrieve Document File URL
この工程は GMO サイン から指定した管理番号の文書ファイルURLを取得します。
Configs for this Auto Step
- conf_OAuth2
- C1: シークレットキー *
- cusId
- C2: 顧客ID *#{EL}
- accessUrl
- C3: アクセス先URL(例 api.gmosign.com) *#{EL}
- controlNumber
- C4: 文書の管理番号を保存されている文字型データ項目 *
- documentsUrl
- C5: 文書ダウンロードURL を保存する文字型データ項目 *
Script (click to open)
/*
JSON例
・アクセストークン生成 AccessToken_Generate_Post
{
"secret_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"cus_id": "XXXXXXXXXX"
}
・文書取得 Document_GetAll_Post
{
"secret_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"cus_id": "XXXXXXXXXX",
"access_token": "(取得したトークン)",
"control_number": "(取得した管理番号)",
"download_type": 2,
"operation": 1
}
//※署名済文書取得 だとうまく取れなかったので上記を使った
*/
main();
function main() {
//// == 工程コンフィグの参照 / Config Retrieving ==
//シークレットキーはHTTP認証設定のトークン直接指定に入れてもらう
const key = configs.getObject("conf_OAuth2").getToken() + "";
const cusId = configs.get("cusId") + "";
const accessUrl = configs.get("accessUrl") + "";
const dataId_documentsUrl = configs.get("documentsUrl");
//// == ワークフローデータの参照 / Data Retrieving ==
const controlNumber = engine.findData(configs.getObject("controlNumber")) + "";
//// == 演算 / Calculating ==
//アクセストークン取得
let accessToken = getAccessToken(key, cusId, accessUrl);
//文書ファイルURL取得
let documentsUrl = retrieveFileURL(key, cusId, accessUrl, accessToken, controlNumber);
//// == ワークフローデータへの代入 / Data Updating ==
engine.setDataByNumber( dataId_documentsUrl, documentsUrl );
/* アクセスログがあれば
if ( dataId_log !== "" ) {
engine.setDataByNumber( dataId_log, accessLog );
}
*/
}
/**
* アクセストークン取得
* @param {String} key シークレットキー
* @param {String} cusId 顧客ID
* @param {String} accessUrl 接続先URL
* @returns {String} アクセストークン
*/
function getAccessToken(key, cusId, accessUrl) {
//JSON準備
let requestObj = {};
requestObj.secret_key = key;
requestObj.cus_id = cusId;
//HTTPリクエスト送付
const url = "https://" + accessUrl + "/agree-api/v0/api/accesstoken/generate";
const response = httpClient.begin()
.body( JSON.stringify(requestObj), "application/json" )
.post(url);
const status = response.getStatusCode();
const responseStr = response.getResponseAsString();
if (status !== 200) {
engine.log(responseStr);
throw `Failed to get access token. status: ${status}`;
}
engine.log("responseStr:" + responseStr);//検証用
const json = JSON.parse(responseStr);
return json['result']['access_token'];
}
/**
* 文書ダウンロードURL取得
* @param {String} key シークレットキー
* @param {String} cusId 顧客ID
* @param {String} accessUrl 接続先URL
* @param {String} accessToken アクセストークン
* @param {String} controlNumber 文書管理番号
* @returns {String} 文書ダウンロードURL
*/
function retrieveFileURL(key, cusId, accessUrl, accessToken, controlNumber) {
//JSON準備
let requestObj = {};
requestObj.secret_key = key;
requestObj.cus_id = cusId;
requestObj.access_token = accessToken;
requestObj.control_number = controlNumber;
requestObj.download_type = 2;
requestObj.operation = 1;
engine.log("requestObj:" + JSON.stringify(requestObj));//検証用
//HTTPリクエスト送付
const url = "https://" + accessUrl + "/agree-api/v0/api/document/getAll";
const response = httpClient.begin()
.body( JSON.stringify(requestObj), "application/json" )
.post(url);
const status = response.getStatusCode();
const responseStr = response.getResponseAsString();
if (status !== 200) {
engine.log(responseStr);
throw `Failed to regist file. status: ${status}`;
}
engine.log("responseStr:" + responseStr);//検証用
const json = JSON.parse(responseStr);
return json['result']['documents_url'];
}
Download
- gmo-sign-document-retrieve-file-url.xml
- 2024-07-05 (C) Questetra, Inc. (MIT License)
自由改変可能な JavaScript (ECMAScript) コードです。いかなる保証もありません。
(アドオン自動工程のインストールは Professional editionでのみ可能です)
(アドオン自動工程のインストールは Professional editionでのみ可能です)
Notes
- 「GMO サイン」はGMOグローバルサイン・ホールディングス株式会社のサービスです。
- GMO サインで電子署名させる場合には、「GMO Sign: 封筒用文書登録」・「GMO Sign: 封筒署名依頼」・「GMO Sign: 封筒署名ステータス確認」を組み合わせて使う必要があります。また「GMO サイン: 文書ファイルURL取得」を使うと署名済ファイル取得ができます。
- 「シークレットキー」・「顧客ID」・「アクセス先URL」はGMOグローバルサイン・ホールディングス株式会社より指定された値を指定してください。「シークレットキー」は「HTTP認証設定」の「トークン直接指定」で指定してください。
Capture

