{"id":162824,"date":"2024-07-09T14:50:38","date_gmt":"2024-07-09T05:50:38","guid":{"rendered":"https:\/\/support.questetra.com\/?p=162824"},"modified":"2024-07-09T14:50:40","modified_gmt":"2024-07-09T05:50:40","slug":"gmo-sign-envelope-send-request","status":"publish","type":"post","link":"https:\/\/support.questetra.com\/en\/addons\/gmo-sign-envelope-send-request\/","title":{"rendered":"GMO Sign: Send Sign Request"},"content":{"rendered":"\n

GMO Sign: Send Sign Request<\/strong><\/h4>\n\n\n\n

GMO \u30b5\u30a4\u30f3: \u5c01\u7b52\u7f72\u540d\u4f9d\u983c<\/a><\/p>\n\n\n\n

This item sends an envelope signature request to GMO Sign.<\/p>\n\n\n\n

\"Auto<\/figure>\n\n\n\n
\n
Configs for this Auto Step<\/summary>
\n
\n
conf_OAuth2<\/dt>
C1: Secret Key *<\/span><\/dd>\n
cusId<\/dt>
C2: Customer id *<\/span>#{EL}<\/sup><\/span><\/dd>\n
accessUrl<\/dt>
C3: Access url *<\/span>#{EL}<\/sup><\/span><\/dd>\n
documentCode<\/dt>
C4: Document code *<\/span><\/dd>\n
envelopeName<\/dt>
C5: Emvelope name *<\/span><\/dd>\n
documentName<\/dt>
C6: Document name *<\/span><\/dd>\n
signerName<\/dt>
C7: Signer namet (Write one per line) *<\/span><\/dd>\n
signerEmail<\/dt>
C8: Signer email addresst (Write one per line) *<\/span><\/dd>\n
signingPoint<\/dt>
C9: Signing point left,bottom,right,top,page(Write one per line)#{EL}<\/sup><\/span><\/dd>\n
envelopeXid<\/dt>
C10: Envelope transaction Id *<\/span><\/dd>\n\n<\/dl>\n<\/div><\/details><\/div>\n<\/div>\n\n\n\n
\n
Script (click to open)<\/summary>
\n
\n\n\/*\nJSON\u4f8b\n\n\u30fb\u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u751f\u6210 AccessToken_Generate_Post\n{\n  "secret_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",\n  "cus_id": "XXXXXXXXXX"\n}\n\n\u30fb\u5c01\u7b52\u7f72\u540d\u4f9d\u983c Envelope_SendRequest_Post\n{\n  "secret_key": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",\n  "cus_id": "XXXXXXXXXX",\n  "access_token": "\uff08\u53d6\u5f97\u3057\u305f\u30c8\u30fc\u30af\u30f3\uff09",\n  "envelope_name": "\uff08config\u304b\u3089\u3001\u8868\u793a\u3042\u308a\uff09",\n\n"document_list": [\n  {\n  "document_code": "\uff08\u6587\u66f8\u767b\u9332\u3067\u53d6\u5f97\u3057\u305f\u5024\uff09",\n  "document_name": "\uff08config\u304b\u3089\u3001\u8868\u793a\u3042\u308a\uff09"\n  }\n],\n\n"partner_signer_list": [\n  {\n  "order_no": "\uff08config\u306e\u6307\u5b9a\u6570\u304b\u3089\uff09",\n  "sign_type": "1",\uff08\u7acb\u4f1a\u4eba\u3067\u56fa\u5b9a\uff09\n  "name": "\uff08config\u304b\u3089\u3001\u8868\u793a\u3042\u308a\uff09",\n  "email": "\uff08config\u304b\u3089\uff09",\n  "is_send_mail": "1",\uff08\u30e1\u30fc\u30eb\u3042\u308a\u3067\u56fa\u5b9a\uff09\n\n  "document_list": [\n    {\n    "document_code": "\uff08\u6587\u66f8\u767b\u9332\u3067\u53d6\u5f97\u3057\u305f\u5024\uff09",\n    "request_type": "1",\uff08\u7f72\u540d\u3067\u56fa\u5b9a\uff09\n\n    "signing_points": [\n      {\n      "signing_point_start_x": "\uff08config\u304b\u3089\uff09",\n      "signing_point_start_y": "\uff08config\u304b\u3089\uff09",\n      "signing_point_end_x": "\uff08config\u304b\u3089\uff09",\n      "signing_point_end_y": "\uff08config\u304b\u3089\uff09",\n      "page_no": "\uff08config\u304b\u3089\uff09"\n      }\n    ]\n\n    }\n  ]\n\n  }\n]\n\n}\n*\/\n\n\nmain();\n\nfunction main() {\n\n    \/\/\/\/ == \u5de5\u7a0b\u30b3\u30f3\u30d5\u30a3\u30b0\u306e\u53c2\u7167 \/ Config Retrieving ==\n    \/\/\u30b7\u30fc\u30af\u30ec\u30c3\u30c8\u30ad\u30fc\u306fHTTP\u8a8d\u8a3c\u8a2d\u5b9a\u306e\u30c8\u30fc\u30af\u30f3\u76f4\u63a5\u6307\u5b9a\u306b\u5165\u308c\u3066\u3082\u3089\u3046\n    const key = configs.getObject("conf_OAuth2").getToken();\n    const cusId = configs.get("cusId");\n    const accessUrl = configs.get("accessUrl") + "";\n\n    const dataId_envelopeXid = configs.get("envelopeXid");\n\n    \/\/\/\/ == \u30ef\u30fc\u30af\u30d5\u30ed\u30fc\u30c7\u30fc\u30bf\u306e\u53c2\u7167 \/ Data Retrieving ==\n    const documentCode = engine.findData(configs.getObject("documentCode")) + "";\n    const envelopeName = engine.findData(configs.getObject("envelopeName")) + "";\n    const documentName = engine.findData(configs.getObject("documentName")) + "";\n    const signerNamesArray = retrieveFilledArray('signerName', 'Signer Name');\n    const signerEmailsArray = retrieveFilledArray('signerEmail', 'Signer Email');\n    const signingPointsArray = retrieveFilledArray2('signingPoint', 'Signing Point');\n\n    \/\/ \u4ef6\u6570\u30c1\u30a7\u30c3\u30af\n    if (signerNamesArray === null || signerNamesArray.length === 0) {\n        throw `No Signer Name.`;\n    }\n    if (signerEmailsArray === null || signerEmailsArray.length === 0) {\n        throw `No Signer Email.`;\n    }\n    \/\/\u30b5\u30a4\u30f3\u4f4d\u7f6e\u6307\u5b9a\u306a\u3057\uff08\u4e0d\u53ef\u8996\u7f72\u540d\u3092\u8003\u616e\u3057\u3066\uff09\u30b5\u30a4\u30f3\u4f4d\u7f6e\u306e\u6570\u306f\u30c1\u30a7\u30c3\u30af\u3057\u306a\u3044\n\n\/* \u7f72\u540d\u8005\u306e\u6700\u5927\u6570\u306e\u60c5\u5831\u306f\u306a\u304b\u3063\u305f\u306e\u3067\u30c1\u30a7\u30c3\u30af\u3057\u306a\u3044\u3001\u3061\u306a\u307f\u306b\u7f72\u540d\u9806\u306f999\u307e\u3067\u3044\u3051\u308b\n    if (signerNamesArray.length > MAX_SIGNER_NUM) {\n        throw `Number of Email Addresses exceeds the limit. The maximum number is ${MAX_SIGNER_NUM}.`;\n    }\n*\/\n\n    \/\/ \u4ef6\u6570\u4e00\u81f4\u30c1\u30a7\u30c3\u30af\n    if (signerNamesArray.length !== signerEmailsArray.length) {\n        throw `Number of Signer Emails does not match the number of Signer Names.`;\n    }\n    \/\/\u30b5\u30a4\u30f3\u4f4d\u7f6e\u6307\u5b9a\u306a\u3057\uff08\u4e0d\u53ef\u8996\u7f72\u540d\u3092\u8003\u616e\u3057\u3066\uff09\u30b5\u30a4\u30f3\u4f4d\u7f6e\u306e\u6570\u306f\u30c1\u30a7\u30c3\u30af\u3057\u306a\u3044\n\n    \/\/\/\/ == \u6f14\u7b97 \/ Calculating ==\n\n    \/\/\u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u53d6\u5f97\n    let accessToken = getAccessToken(key, cusId, accessUrl);\n\n    \/\/\u7f72\u540d\u4f9d\u983c\n    let envelopeXid = sendRequest(key, cusId, accessUrl, accessToken, documentCode, envelopeName, documentName, signerNamesArray, signerEmailsArray, signingPointsArray);\n\n\n    \/\/\/\/ == \u30ef\u30fc\u30af\u30d5\u30ed\u30fc\u30c7\u30fc\u30bf\u3078\u306e\u4ee3\u5165 \/ Data Updating ==\n    engine.setDataByNumber( dataId_envelopeXid, envelopeXid );\n\n\n\/* \u30a2\u30af\u30bb\u30b9\u30ed\u30b0\u304c\u3042\u308c\u3070\n    if ( dataId_log !== "" ) {\n        engine.setDataByNumber( dataId_log, accessLog );\n    }\n*\/\n\n}\n\n\n\/**\n  * config \u304b\u3089\u8907\u6570\u884c\u306e\u30c7\u30fc\u30bf\u3092\u8aad\u307f\u51fa\u3057\u3001\u914d\u5217\u3092\u751f\u6210\u3059\u308b\uff08config\u3067\u6587\u5b57\u578b\u3092\u6307\u5b9a\u3059\u308b\u30b1\u30fc\u30b9\uff09\n  * \u30c7\u30fc\u30bf\u9805\u76ee\u304c\u8a2d\u5b9a\u3055\u308c\u3066\u3044\u306a\u3044\u5834\u5408\u306f null \u3092\u8fd4\u3059\n  * \u30c7\u30fc\u30bf\u9805\u76ee\u304c\u8a2d\u5b9a\u3055\u308c\u3066\u3044\u3066\u3001\u4e2d\u8eab\u304c\u7a7a\u306e\u5834\u5408\u306f\u30a8\u30e9\u30fc\n  * \u7a7a\u884c\u3092\u542b\u3080\u5834\u5408\u306f\u30a8\u30e9\u30fc (\u6700\u5f8c\u306b\u7a7a\u884c\u304c\u3072\u3068\u3064\u3060\u3051\u3042\u308b\u5834\u5408\u306f\u7121\u8996)\n  * @param {String} confName config \u540d\n  * @param {String} label \u30a8\u30e9\u30fc\u51fa\u529b\u306b\u4f7f\u7528\u3059\u308b\u30e9\u30d9\u30eb\n  * @return {Array<String>} array \u7a7a\u6587\u5b57\u5217\u3092\u542b\u307e\u306a\u3044\u914d\u5217\n  *\/\nfunction retrieveFilledArray(confName, label) {\n    const dataDef = configs.getObject(confName);\n    if (dataDef === null) { \/\/ \u30c7\u30fc\u30bf\u9805\u76ee\u304c\u8a2d\u5b9a\u3055\u308c\u3066\u3044\u306a\u3044\n        return null;\n    }\n    const string = engine.findData(dataDef);\n    if (string === null || string === '') { \/\/ \u30c7\u30fc\u30bf\u9805\u76ee\u306e\u4e2d\u8eab\u304c\u7a7a\n        throw `Data item for ${label} is set but its content is empty.`;\n    }\n\n    const array = string.split('\\n');\n    if (array[array.length - 1] === '') { \/\/ \u6700\u5f8c\u306b\u7a7a\u884c\u304c\u3042\u308c\u3070\u524a\u9664\n        array.pop();\n    }\n    \/\/ \u7a7a\u884c\u304c\u6b8b\u3063\u3066\u3044\u308b\u5834\u5408\u306f\u30a8\u30e9\u30fc\n    const i = array.indexOf('');\n    if (i !== -1) {\n        throw `${label} at line ${i+1} is blank.`;\n    }\n    return array;\n}\n\n\/**\n  * config \u304b\u3089\u8907\u6570\u884c\u306e\u30c7\u30fc\u30bf\u3092\u8aad\u307f\u51fa\u3057\u3001\u914d\u5217\u3092\u751f\u6210\u3059\u308b\uff08config\u3067\u76f4\u63a5\u5165\u529b\u306e\u30b1\u30fc\u30b9\u3001\u7a7a\u884c\u3092\u542b\u3080\u5834\u5408\u3042\u308a\uff09\n  * @param {String} confName config \u540d\n  * @param {String} label \u30a8\u30e9\u30fc\u51fa\u529b\u306b\u4f7f\u7528\u3059\u308b\u30e9\u30d9\u30eb\n  * @return {Array<String>} array \u914d\u5217\n  *\/\nfunction retrieveFilledArray2(confName, label) {\n    const string = configs.get(confName);\n    if (string === null || string === '') { \/\/ \u30c7\u30fc\u30bf\u9805\u76ee\u306e\u4e2d\u8eab\u304c\u7a7a\n        throw `Data item for ${label} is set but its content is empty.`;\n    }\n\n    const array = string.split('\\n');\n\n\/* \uff08\u4e0d\u53ef\u8996\u7f72\u540d\u3092\u8003\u616e\u3057\u3066\uff09\u30b5\u30a4\u30f3\u4f4d\u7f6e\u306a\u3057\u3092\u8a31\u5bb9\u3001\u7a7a\u884c\u3092\u305d\u306e\u307e\u307e\u306b\u3059\u308b\n    if (array[array.length - 1] === '') { \/\/ \u6700\u5f8c\u306b\u7a7a\u884c\u304c\u3042\u308c\u3070\u524a\u9664\n        array.pop();\n    }\n\n    \/\/ \u7a7a\u884c\u304c\u6b8b\u3063\u3066\u3044\u308b\u5834\u5408\u306f\u30a8\u30e9\u30fc\n    const i = array.indexOf('');\n    if (i !== -1) {\n        throw `${label} at line ${i+1} is blank.`;\n    }\n*\/\n    return array;\n}\n\n\n\/**\n  * \u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\u53d6\u5f97\n  * @param {String} key  \u30b7\u30fc\u30af\u30ec\u30c3\u30c8\u30ad\u30fc\n  * @param {String} cusId  \u9867\u5ba2ID\n  * @param {String} accessUrl  \u63a5\u7d9a\u5148URL\n  * @returns {String} \u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\n  *\/\nfunction getAccessToken(key, cusId, accessUrl) {\n\n    \/\/JSON\u6e96\u5099\n    let requestObj = {};\n    requestObj.secret_key = key;\n    requestObj.cus_id = cusId;\n\n\n    \/\/HTTP\u30ea\u30af\u30a8\u30b9\u30c8\u9001\u4ed8\n    const url = "https:\/\/" + accessUrl + "\/agree-api\/v0\/api\/accesstoken\/generate";\n    const response = httpClient.begin()\n        .body( JSON.stringify(requestObj), "application\/json" )\n        .post(url);\n    const status = response.getStatusCode();\n    const responseStr = response.getResponseAsString();\n    if (status !== 200) {\n        engine.log(responseStr);\n        throw `Failed to get access token. status: ${status}`;\n    }\n\n    engine.log("responseStr:" + responseStr);\/\/\u691c\u8a3c\u7528\n    const json = JSON.parse(responseStr);\n    if ( json['status'] !== "0") {\n        throw `Failed to get acess token. status: ${json['status']}. message: ${json['message']}`;\n    }\n    return json['result']['access_token'];\n}\n\n\n\/**\n  * \u7f72\u540d\u4f9d\u983c\n  * @param {String} key  \u30b7\u30fc\u30af\u30ec\u30c3\u30c8\u30ad\u30fc\n  * @param {String} cusId  \u9867\u5ba2ID\n  * @param {String} accessUrl  \u63a5\u7d9a\u5148URL\n  * @param {String} accessToken  \u30a2\u30af\u30bb\u30b9\u30c8\u30fc\u30af\u30f3\n  * @param {String} documentCode  \u6587\u66f8\u30b3\u30fc\u30c9\n  * @param {String} envelopeName  \u5c01\u7b52\u540d\n  * @param {String} documentName  \u6587\u66f8\u540d\n  * @param {String} signerNamesArray  \u7f72\u540d\u8005\u540d\n  * @param {String} signerEmailsArray  \u7f72\u540d\u8005\u30e1\u30fc\u30eb\u30a2\u30c9\u30ec\u30b9\n  * @param {String} signingPointsArray  \u7f72\u540d\u4f4d\u7f6e\n  * @returns {String} \u5c01\u7b52\u30c8\u30e9\u30f3\u30b6\u30af\u30b7\u30e7\u30f3ID\n  *\/\nfunction sendRequest(key, cusId, accessUrl, accessToken, documentCode, envelopeName, documentName, signerNamesArray, signerEmailsArray, signingPointsArray) {\n\n    \/\/JSON\u6e96\u5099\n    let requestObj = {};\n    requestObj.secret_key = key;\n    requestObj.cus_id = cusId;\n    requestObj.access_token = accessToken;\n    requestObj.envelope_name = envelopeName;\n\n    let documentListArray = [];\n    let documentListObj = {};\n    documentListObj.document_code = documentCode;\n    documentListObj.document_name = documentName;\n    documentListArray[0] = documentListObj;\n    requestObj.document_list = documentListArray;\n\n    let partnerSignerListArray = [];\n\n    for (let i = 0; i < signerNamesArray.length; i++) {\n        let partnerSignerListObj = {};\n        partnerSignerListObj.order_no = i+1;\/\/\u6587\u5b57\u3067\u306a\u304f\u6570\u5024\u3067\u554f\u984c\u306a\u3057\n        partnerSignerListObj.sign_type = "1";\n        partnerSignerListObj.name = signerNamesArray[i];\n        partnerSignerListObj.email = signerEmailsArray[i];\n        partnerSignerListObj.is_send_mail = "1";\n\n        let pslDocumentListArray = [];\n        let pslDocumentListObj = {};\n        pslDocumentListObj.document_code = documentCode;\n        pslDocumentListObj.request_type = "1";\n\n        \/\/\u30b5\u30a4\u30f3\u4f4d\u7f6e\u6307\u5b9a\nif (signingPointsArray[i]) {\n\/\/if (signingPointsArray[i].indexOf(",") > -1) {\n        let signingPointArray = signingPointsArray[i].split(",");\n        \/\/\u4f4d\u7f6e\u6307\u5b9a\u306e\u30d1\u30e9\u30e1\u30fc\u30bf\u6570\u304c\u6b63\u3057\u3044\u304b\n        if (signingPointArray.length == 5) {\n            let pslSigningPointsListArray = [];\n            let pslSigningPointsListObj = {};\n            pslSigningPointsListObj.signing_point_start_x = signingPointArray[0];\n            pslSigningPointsListObj.signing_point_start_y = signingPointArray[1];\n            pslSigningPointsListObj.signing_point_end_x = signingPointArray[2];\n            pslSigningPointsListObj.signing_point_end_y = signingPointArray[3];\n            pslSigningPointsListObj.page_no = signingPointArray[4];\n\n            pslSigningPointsListArray[0] = pslSigningPointsListObj;\n            pslDocumentListObj.signing_points = pslSigningPointsListArray;\n        } else {\n            throw `Signing Point ${i+1} Num invalid.`;\n        }\n\/\/}\n}\n\n        pslDocumentListArray[0] = pslDocumentListObj;\n        partnerSignerListObj.document_list = pslDocumentListArray;\n        partnerSignerListArray[i] = partnerSignerListObj;\n    }\n\n    requestObj.partner_signer_list = partnerSignerListArray;\n\n    engine.log("requestObj:" + JSON.stringify(requestObj));\/\/\u691c\u8a3c\u7528\n\n\n    \/\/HTTP\u30ea\u30af\u30a8\u30b9\u30c8\u9001\u4ed8\n    const url = "https:\/\/" + accessUrl + "\/agree-api\/v0\/api\/envelope\/sendRequest";\n    const response = httpClient.begin()\n        .body( JSON.stringify(requestObj), "application\/json" )\n        .post(url);\n    const status = response.getStatusCode();\n    const responseStr = response.getResponseAsString();\n    if (status !== 200) {\n        engine.log(responseStr);\n        throw `Failed to regist file. status: ${status}`;\n    }\n\n    engine.log("responseStr:" + responseStr);\/\/\u691c\u8a3c\u7528\n    const json = JSON.parse(responseStr);\n    if ( json['status'] !== "0") {\n        throw `Failed to send request. status: ${json['status']}. message: ${json['message']}`;\n    }\n    return json['result']['envelope_xid'];\n}\n\n  \n    <\/code><\/pre><\/div>\n<\/div><\/details><\/div>\n<\/div>\n\n\n\n
Download<\/span><\/h3>\n\n\n\n