{"id":11974,"date":"2019-10-22T16:03:25","date_gmt":"2019-10-22T07:03:25","guid":{"rendered":"https:\/\/www.eformsign.com\/kr\/support\/?post_type=manual_documentation&p=11974"},"modified":"2020-09-15T10:31:58","modified_gmt":"2020-09-15T01:31:58","slug":"doc-creation","status":"publish","type":"manual_documentation","link":"https:\/\/www.eformsign.com\/kr\/support\/documentation\/open-api\/doc-creation\/","title":{"rendered":"2.3.7 OPA_007 \ubb38\uc11c \uc791\uc131"},"content":{"rendered":"\n

API key\ub97c \uc774\uc6a9\ud558\uc5ec \ubb38\uc11c\ub97c \uc791\uc131\ud558\ub294 API<\/p>\n\n\n\n

Rest API<\/h2>\n\n\n\n
\ub3c4\uba54\uc778\/v1.0\/api\/forms\/{FORM_ID}\/documents<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
  • \ub3c4\uba54\uc778\uc740 Access Token \ubc1c\uae09 \ub41c company.api_url \uac12\uc744 \uc0ac\uc6a9\ud574\uc57c \ud569\ub2c8\ub2e4. <\/em><\/li><\/ul>\n\n\n\n

    Example<\/p>\n\n\n\n

    https:\/\/kr-api.eformsign.com\/v1.0\/api\/forms\/61b05d369b2a4a10b5c4c8a1373abc0d\/documents<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Method<\/h2>\n\n\n\n

    – POST<\/p>\n\n\n\n

    Request Header<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>\ube44\uace0<\/td>\ud544\uc218\uc785\ub825<\/td><\/tr>
    Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td>O<\/td><\/tr>
    access_token<\/td>String<\/td>Access token<\/td>Member access token<\/td>O<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    QueryString<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Request Body<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>\ube44\uace0<\/td>\ud544\uc218\uc785\ub825<\/td><\/tr>
    title<\/td>String<\/td>\ubb38\uc11c \uc81c\ubaa9<\/td>\uac12\uc774 \uc5c6\uc73c\uba74 template\uc5d0\uc11c \uc124\uc815\ub41c \uc774\ub984\uc73c\ub85c \uc124\uc815 <\/td>X<\/td><\/tr>
    next_steps<\/td>Array<\/td>\ub2e4\uc74c \ub2e8\uacc4 \ub9ac\uc2a4\ud2b8<\/td>step \uac1d\uccb4 \ud3ec\ud568 (step_type, comment, approvers)
    \uac12\uc774 \uc5c6\uc73c\uba74 \ubb38\uc11c \uc784\uc2dc \uc800\uc7a5<\/td>    		X<\/td><\/tr>
    next_steps[].step_type<\/td>String<\/td>\ub2e4\uc74c \ub2e8\uacc4\uc758 \ud0c0\uc785<\/td>approval, outsider, accept, complete<\/td>X<\/td><\/tr>
    next_steps[].comment<\/td>String<\/td>\ub2e4\uc74c \ub2e8\uacc4 \uc694\uccad comment<\/td> <\/td>X<\/td><\/tr>
    next_steps[].approvers<\/td>Array<\/td>\uc694\uccad\uc790 \ub9ac\uc2a4\ud2b8(\uacb0\uc7ac, \ub0b4\ubd80\uc790, \uc678\ubd80\uc790 \ub2e8\uacc4\uc5d0 \ud3ec\ud568)<\/td>approver \uac1d\uccb4 \ud3ec\ud568 (user_id)<\/td>X<\/td><\/tr>
    next_steps[].approvers[].user_id<\/td>String<\/td>\ub2e4\uc74c \ub2e8\uacc4 \uc694\uccad\uc790\uc758 ID
    (\ub610\ub294 \ub0b4\ubd80\uc790 \uc694\uccad \uadf8\ub8f9\uc758 \uc774\ub984)
    \ub0b4\ubd80\uc790 \uc694\uccad\uc774\uace0 \ub0b4\ubd80 \ucc98\ub9ac\uc790 \uc804\uccb4\uc5d0\uac8c \uc694\uccad\ud560 \uacbd\uc6b0 “all”<\/td>    		 <\/td>X<\/td><\/tr>
    next_steps[].approvers[].user_name<\/td>String<\/td>\uc678\ubd80\uc790 \uc694\uccad\uc77c \uacbd\uc6b0, \uc694\uccad\uc790 \uc774\ub984<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].code<\/td>String<\/td>\uc678\ubd80\uc790 \uc694\uccad\uc77c \uacbd\uc6b0, sms \uc694\uccad\ud560 \ub54c \uad6d\uac00 \ucf54\ub4dc<\/td>ex. “+82”<\/td>X<\/td><\/tr>
    next_steps[].approvers[].number<\/td>String<\/td>\uc678\ubd80\uc790 \uc694\uccad\uc77c \uacbd\uc6b0, sms \uc694\uccad\ud560 \ub54c \ud734\ub300\ud3f0 \ubc88\ud638<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].auth_password<\/td>String<\/td>\uc678\ubd80\uc790 \uc694\uccad\uc77c \uacbd\uc6b0, \uc778\uc99d \ube44\ubc00\ubc88\ud638<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].auth_valid_time<\/td>number<\/td>\uc678\ubd80\uc790 \uc694\uccad\uc77c \uacbd\uc6b0, \uc678\ubd80\uc790 \ucc98\ub9ac \uc720\ud6a8\uc2dc\uac04<\/td><\/td>X<\/td><\/tr>
    next_steps[].approvers[].auth_hint<\/td>String<\/td>\uc678\ubd80\uc790 \uc694\uccad\uc77c \uacbd\uc6b0, \uc778\uc99d \ube44\ubc00\ubc88\ud638 \uc548\ub0b4 \ubb38\uad6c<\/td><\/td>X <\/td><\/tr>
    next_steps[].approvers[].type<\/td>String<\/td>\ub0b4\ubd80\uc790 \uc694\uccad\uc77c \uacbd\uc6b0, \uc694\uccad\uc790\uc758 type<\/td>member, group<\/td>X <\/td><\/tr>
    form_fields<\/td>Array<\/td>\ubb38\uc11c \ub0b4 \ucef4\ud3ec\ub10c\ud2b8\uc5d0 \uc791\uc131\ud560 \ub370\uc774\ud130 \ub9ac\uc2a4\ud2b8<\/td>form_field \uac1d\uccb4 \ud3ec\ud568 (input_form_id, input_form_type, input_form_value)<\/td>X <\/td><\/tr>
    form_fields[].input_form_id<\/td>String<\/td>\ubb38\uc11c \ub0b4 \ucef4\ud3ec\ub10c\ud2b8\uc758 form ID<\/td> <\/td>X <\/td><\/tr>
    form_fields[].input_form_value<\/td>String<\/td>\ubb38\uc11c \ub0b4 \ucef4\ud3ec\ub10c\ud2b8\uc5d0 \uc791\uc131\ud560 \ub370\uc774\ud130<\/td> <\/td>X <\/td><\/tr>
    group<\/td>String<\/td>\uadf8\ub8f9 \uc774\ub984<\/td>\ud15c\ud50c\ub9bf\uc758 \ud544\ub4dc \uc124\uc815\uc5d0\uc11c \uc785\ub825\ud544\ub4dc \uae30\ubcf8\uac12\uc5d0 \uadf8\ub8f9 \uc815\ubcf4\uac00 \uc124\uc815\ub418\uace0, \ubb38\uc11c \uc791\uc131\uc790\uac00 2\uac1c \uc774\uc0c1\uc758 \uadf8\ub8f9\uc5d0 \uc18d\ud55c \uacbd\uc6b0 \ud544\uc218 \uc9c0\uc815, \uc18c\uc18d \uadf8\ub8f9\uc774 \uc5c6\uac70\ub098 1\uac1c\uc778 \uacbd\uc6b0 \ubb34\uc2dc<\/td>X <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Response Header<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>\ube44\uace0<\/td><\/tr>
    Content-Type<\/td>String<\/td>Content-Type<\/td>application\/json<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Success Response Body<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>\ube44\uace0<\/td><\/tr>
    document_title<\/td>String<\/td>\ubb38\uc11c \uc81c\ubaa9<\/td>\uc0dd\uc131\ub41c \ubb38\uc11c\uc758 \uc81c\ubaa9\uba85<\/td><\/tr>
    document_id<\/td>String<\/td>\ubb38\uc11c ID<\/td>\uc0dd\uc131\ub41c \ubb38\uc11c\uc758 \uace0\uc720ID<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Fail Response Body<\/h3>\n\n\n\n
    Name<\/td>Type<\/td>Description<\/td>\ube44\uace0<\/td><\/tr>
    error<\/td>Object<\/td>\uc5d0\ub7ec \uc0c1\uc138 \uc815\ubcf4<\/td>error \uc758 \uacbd\uc6b0\uc5d0\ub9cc \ud45c\uc2dc error \uac1d\uccb4 (code, message \ud3ec\ud568)<\/td><\/tr>
    error.code<\/td>String<\/td>\uc5d0\ub7ec \ucf54\ub4dc<\/td> <\/td><\/tr>
    error.message<\/td>String<\/td>\uc5d0\ub7ec \uba54\uc2dc\uc9c0<\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

    Example<\/h4>\n\n\n\n

    Request<\/strong><\/p>\n\n\n\n

    POST \/v1.0\/api\/forms\/61b05d369b2a4a10b5c4c8a1373abc0d\/documents HTTP\/1.1\n\nContent-Type : application\/json\n\naccess_token : eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJvY2UuaWFtIiwiY29udGV4dCI6eyJjbGllbnRJ....\n\nHOST : https:\/\/kr-api.eformsign.com\n\n{\n\n\"form_version\" : \"1\",\n\"title\" : \"\ud734\uac00 \uc2e0\uccad\uc11c\",\n\"next_steps\" : [ \/\/ next_step\uc774 \uc5c6\ub294 \uacbd\uc6b0\ub294 \uc784\uc2dc \uc800\uc7a5\uc774\ub2e4.\n{\n\"step_type\" : \"approval\",\n\"comment\" : \"\",\n\"approvers\" : [\n{\n\"user_id\" : \"test1@forcs.com\"\n}\n]\n}\n],\n\"form_fields\" : [\n{\n\"input_form_id\" : \"TextBox1\",\n\"input_form_value\" : \"\ud14c\uc2a4\ud2b8\uc785\ub2c8\ub2e41\"\n},\n{\n\"input_form_id\" : \"TextBox2\",\n\"input_form_value\" : \"\ud14c\uc2a4\ud2b8\uc785\ub2c8\ub2e42\"\n}\n]\n}<\/code><\/pre>\n\n\n\n
    Response<\/strong><\/p>\n\n\n\n
    – \uc131\uacf5 \uc2dc<\/p>\n\n\n\n
    HTTPS\/1.1 200 OK\nContent-Type: application\/json\n{\n\"document_title\": \"openAPI\ud14c\uc2a4\ud2b8\",\n\"document_id\": \"e433c854ca034a88bd2e1a0e380afe9b\"\n}<\/code><\/pre>\n\n\n\n
    – \uc2e4\ud328 \uc2dc<\/p>\n\n\n\n
    HTTPS \/ 1.1 403 forbidden\nContent-Type: application\/json\n{\n\"error\": {\n\"code\": \"4030001\",\n\"message\": \"invalid api key\"\n}\n}<\/code><\/pre>\n","protected":false},"author":1,"featured_media":0,"parent":11930,"menu_order":0,"template":"","manualdocumentationcategory":[44],"_links":{"self":[{"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/manual_documentation\/11974"}],"collection":[{"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/users\/1"}],"version-history":[{"count":5,"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/manual_documentation\/11974\/revisions"}],"predecessor-version":[{"id":15431,"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/manual_documentation\/11974\/revisions\/15431"}],"up":[{"embeddable":true,"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/manual_documentation\/11930"}],"wp:attachment":[{"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/media?parent=11974"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/www.eformsign.com\/kr\/support\/wp-json\/wp\/v2\/manualdocumentationcategory?post=11974"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}