developers.esigngenie.comAPI Documentation | Foxit eSign

Getting Started About Foxit eSign Creating a developer account General guidelines Authentication Generating access token Folders API Getting template info Getting all templates list for your accountCreating a new folder from templatesCreating a new folder from PDFs Creating embedded signing session Creating embedded sending session Sending Draft Folder by Folder Id Modify Shared Folder by Folder Id Update Envelope Fields Update Folder Recipients Regenerate embedded signing session Update Envelope Custom FieldsGet folder details Get FolderIds By Status and Date Send Signature Reminder Cancel Folder Get folder activity history Get deleted folder history Download folder files Download single document pdf Move folders(s) to recycle bin Delete folder(s) Templates API Creating a new template from PDF Creating a new folder from templates Get all templates list for your account Get multiple templates by template Id Get template details Parties API Get email group details Creating a new email group Webhooks Webhook Events Webhook Security Webhook Channels Create Webhook Channel Get Webhook Channel Details Get all Webhook Channel Details Update Webhook Channel Activate Webhook Channel Deactivate Webhook Channel Delete Webhook Channel Users API Create New User Update User Delete User List All Users Account API Create New Account Cancel Account Reactivate Account Change Licences Change Plan Channel Account API Account API Create Subscription Individual PDF & All eSign Plans Enterprise/Team Plans Update Subscription Get Subscription Details by Subscription ID Get Subscription Details by Email ID Get Subscription Details by External ID Get Subscription Modification History Cancel Automatic Renewal Enable Automatic Renewal Cancel Subscription Immediately Advance Subscription Renewal Resume Subscription User API Create New User Update User List All Users Get User Detail Delete User Report API Download Report Error Handling FAQChange History Getting Started About Foxit eSign Foxit eSign is the #1 easiest and most collaborative contract management and eSignature software with the most robust functionality amongst its peers. Key features include Collaborative contracts and agreement building; template contract creation; eSignature workflow to obtain eSignature(s) from single, or multiple users; advanced bulk eSignature solution with dashboard; notification receiving control; API for eSignature integration with other software or websites and a lot more... For more information on Foxit eSign Software, please contact us at info@esigngenie.com Create a Developer Account Activate the developer account with Foxit eSign under the API tab in the settings menu. (This menu will only be visible after you have purchased the API service from Foxit eSign). Fill in the form to obtain your API Key and API Secret under your API settings. This is how your API information will display: General Guidelines Foxit eSign is an oAuth2 provider. Security implementation is based on the final version of "The OAuth 2.0 Authorization Framework". All requests must be made via HTTPS. Parameter Description {{Host_Name}} for US Region na1.foxitesign.foxit.com {{Host_Name}} for EU Region eu1.foxitesign.foxit.com Pass the respective {{Host_Name}} as per the desired region. Old eSign Genie API customers can replace ’esigngenie.com/esign’ with ’na1.foxitesign.foxit.com’ Authentication Generating Access Token Client Credentials Access your Foxit eSign account from your application Your website/application can generate an access token of grant_type: client_credentials as follows: POST https://{{HOST_NAME}}/api/oauth2/access_token CONTENT TYPE application/x-www-form-URLencoded REQUEST Parameter Description grant_type This value should be client_credentials client_id Your API Key from the API menu under the Settings Tab client_secret Your API Secret from the API menu under the Settings Tab scope Please use read-write , in order to send documents. emailId (Optional) Email-id of one of the Super-Admin Users from your account, whom you want to make API Owner. Note: This is mandatory only when the account owner of the company is Setup Admin . RESPONSE { "access_token":"ACCESS_TOKEN", "token_type":"bearer", "expires_in":31536000 } Sample Code CURL PHP CURL C# Java curl https://{{HOST_NAME}}/api/oauth2/access_token \-d "grant_type=client_credentials" \-d "client_id=CLIENT_ID" \-d "client_secret=CLIENT_SECRET" \-d "scope=read-write" \-H "Content-Type: application/x-www-form-urlencoded" \-X POST ?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL = "https://{{HOST_NAME}}/api/oauth2/access_token", CURLOPT_RETURNTRANSFER = true, CURLOPT_ENCODING = "", CURLOPT_MAXREDIRS = 10, CURLOPT_TIMEOUT = 30, CURLOPT_HTTP_VERSION = CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST = "POST", CURLOPT_POSTFIELDS = "grant_type=client_credentials&client_id=CLIENT_ID&client_secret=CLIENT_SECRET&scope=read-write", CURLOPT_HTTPHEADER = array( "cache-control: no-cache", "content-type: application/x-www-form-urlencoded" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } var request = (HttpWebRequest)WebRequest.Create("https://{{HOST_NAME}}/api/oauth2/access_token"); var postData = "grant_type=client_credentials" + "&client_&client_secret=" + CLIENT_SECRET + "&scope=read-write"; var data = Encoding.ASCII.GetBytes(postData); request.Method = "POST"; request.ContentType = "application/x-www-form-urlencoded"; request.ContentLength = data.Length; using (var stream = request.GetRequestStream()) { stream.Write(data, 0, data.Length); } var response = (HttpWebResponse)request.GetResponse(); using (var streamReader = new StreamReader(response.GetResponseStream())) { var responseString = streamReader.ReadToEnd(); } URL url= new URL("https://{{HOST_NAME}}/api/oauth2/access_token"); HttpURLConnection con= (HttpURLConnection) url.openConnection(); con.setDoOutput(true); con.setUseCaches(false); con.setRequestProperty("Content-Type","application/x-www-form-urlencoded"); String urlParameters = "grant_type=client_credentials&client_id= CLIENT_ID &client_secret= CLIENT_SECRET &scope=read-write"; DataOutputStream wr = new DataOutputStream(con.getOutputStream()); wr.writeBytes(urlParameters); if (con.getResponseCode() != HttpURLConnection.HTTP_OK) { throw new RuntimeException("Failed : HTTP error code : "+ con.getResponseCode()); } BufferedReader br = new BufferedReader(new InputStreamReader((con.getInputStream()))); String output; System.out.println("Output from Server .... \n"); while ((output = br.readLine()) != null) { System.out.println(output); } con.disconnect(); Now you can make calls to the Foxit eSign API with this ACCESS_TOKEN. Please include ACCESS_TOKEN to request headers with every request as indicated. Authorization: Bearer ACCESS_TOKEN CURL curl https://{{HOST_NAME}}/api/folders/createfolder \-i \-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \-H "Content-Type: application/json" ... Document(s) Folder API All API requests start with https://{{HOST_NAME}}/api/ . Get Template Info You can get information about a template with the following endpointCreate folder of documents from PDF files With Foxit eSign API you can create a folder of documents and send them for signature right from your own application. To create a folder of documents from PDF files you can either provide publicly accessible URLs to PDF documents or pass PDF documents as multipart form data and other parameters about the recipient parties, etc. While creating the documents from PDF files you can define various fields like text field or signature field within the document using simple Text Tags . You can assign various properties for these fields like party responsible for filling the data etc. These Text Tags will then be converted to Foxit eSign document fields. Or, if you don’t want to use Text Fields within the document, then you can also...