SimplyDocs - Developer Docs

Form Builder - Get form data.

 

SimplyDocs allows users to collect the form submissions in their business application on a real-time basis. To collect the form submissions, users need to create an API endpoint in their business application. 

Prerequisite -

  1. Create a form in Form Builder module.
  2. The form should have a minimum one element. 

 

1. Visit Form Builder [https://app.simplydocs.cloud/form-studio/forms] and Edit the form.

2. Now from the 'Options' menu (top right), select 'Form API' option. This will show you a pop-up window with the following options,

Endpoint: Enter your business application endpoint (where the API is hosted).

Additional API Parameter: Use this option to include any extra attribute-value pair which you wish SimplyDocs to include while sending the request to your business application. This field has more relevance if you want to receive a key-value pair from SimplyDocs to identify or secure the request message. The parameters field is optional, and you can add any number of combinations (if required).

Form Variables: These are the attributes which SimplyDocs expects in the API hosted by you in your business application. For each attribute, the system has added the comments which tell help you map them with the form created by you. 

For additional help, you can reach out to us at [email protected]

 

DocTemplate - Generate filled documents using API integration.

 

SimplyDocs allows users to generate filled documents using API integration.

Prerequisite -

  1. Create a template in DocTemplates module.
  2. The template should have minimum one placeholder variable. 

 

1. Visit DocTemplates [https://app.simplydocs.cloud/template-studio/templates]

2. From the Options menu of the template, select 'API Integration'. This will show you a pop-up window with the following options,

Endpoint: This is an API endpoint where you need to send (POST) the API request. SimplyDocs uses JSON (JavaScript Object Notation) format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs.

Method: POST (requesting SimplyDocs server to accept the data)

API Request Structure: The API request structure has attribute-value pairs which pass various values to SimplyDocs server for request processing.

  1. user_id - This is your account identification which remains static for your account. User_ID is also mentioned in the Configuration [https://app.simplydocs.cloud/configuration] section.
  2. auth_token - Consider this as a password for your request. Visit Configuration [https://app.simplydocs.cloud/configuration] section, to create, update and delete auth_tokens. You can create any number of auth_tokens. SimplyDocs will process only those requests which are having a valid user_id-auth_token pair.
  3. template_id - This represents your template identification, and this remains fixed for each template.
  4. All other attributes which are part of your template. 

3. Post successful processing of the request, SimplyDocs will send back the filled document (PDF) in BASE64 format. You need to convert the data string (BASE64) to PDF in your business application.

Refer API error codes in 'API - Error Codes' section.

For additional help, you can reach out to us at [email protected]

 

Use your AWS S3 Storage

 

SimplyDocs allows the user's to connect their AWS S3 storage for storing the generated documents (DocTemplate & DocPublisher) and uploads (Form Builder). This will provide them with more control and a higher sense of data security.

Steps to connect your AWS S3 storage,

1. To configure AWS storage, visit the 'Configuration' [https://app.simplydocs.cloud/configuration] option in the left menu.

2. Scroll down to 'AWS Storage Configuration' section.

3. Select 'Custom AWS S3 Storage' radio option.

4. You will be asked to enter below details,

In your AWS account (https://aws.amazon.com),

  1. Visit IAM (Identity and Access Management) to generate the Access Key & Secret Key combination. Save these values in AWS Access Key & AWS Secret Access Key fields.
  2. Copy the AWS Bucket name and save it in the AWS Bucket field.
  3. Copy the Bucket region and update it in the AWS Default Region field.

5. Once done, click on 'Test Connection'. If the connectivity is established, the 'Submit' button will get enabled. Click on the 'Submit' button. 

Important Points -

  1. Configure AWS Bucket as per your business policies.
  2. In SimplyDocs, your custom AWS S3 storage details are stored in an encrypted manner.
  3. In case you choose to use your own AWS S3 storage or decide to change the configuration of your existing custom storage, you will no longer be able to access your current data (templates, generated documents and form uploads). Thus we strongly recommend you to download the details before making the change

 

For additional help, you can reach out to us at [email protected]

 

Error Codes

 

SimplyDocs uses HTTP response status codes to indicate the success or failure of your API requests. If your request fails, SimplyDocs returns an error using the appropriate status code. In general, there are three status code ranges you can expect:

  1. 2xx success status codes confirm that your request worked as expected
  2. 4xx error status codes indicate an error because of the information provided (e.g., a required parameter was omitted)
  3. 5xx error status codes are rare and indicate an error with SimplyDocs servers.
Code Message
200

OK - Everything worked as expected.

400

Bad Request - The request was unacceptable, often due to missing a required parameter.

401

Unauthorized - No valid API key provided.

402

Request Failed - The parameters were valid but the request failed.

403

Forbidden - The API key doesn't have permissions to perform the request.

404

Not Found - The requested resource doesn't exist.

409

Conflict - The request conflicts with another request (perhaps due to using the same idempotent key).

429

Too Many Requests - Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

500/2/3/4

Server Errors - Something went wrong on SimplyDocs's end.

 

In case you encounter an unexpected error, you can reach out to us at [email protected]