Skip to main content
Skip table of contents

URL based Integrations

1. Prepare document from template

Prepare empty document

CODE 
<frontend_url>/compose/create/general?mode=create&definition=<document_type>

You must specify document type (template name)

Example:

For document type c_time_off_request use:

CODE 
<frontend_url>/compose/create/general?mode=create&definition=c_time_off_request
image-20240419-104518.png

Prepared empty document

Prepare document with prefilled fields

CODE 
<frontend_url>/compose/create/general?mode=create&definition=<document_type>&defaults=<prefilled_fields>

You must specify document type (template name) and prefilled fields.

  • Prefilled fields must be specified in JSON format

  • Field names can be found using template editor or in HTML code

  • You can use encodeURIComponent() or similar function to escape characters

Example:

For document type c_time_off_request and field values

CODE 
{
  "C_TIME_OFF_REQUEST_LEAVE_FROM":          "2020-11-15T00:00:00.000Z",
  "C_TIME_OFF_REQUEST_LEAVE_TO":            "2020-11-26T00:00:00.000Z",
  "C_TIME_OFF_REQUEST_AVAILABLE_ON_PHONE":  "Yes",
  "C_TIME_OFF_REQUEST_ALT_PHONE":           "123456789",
  "C_TIME_OFF_REQUEST_INTERNET_ACCESS":     "Mobile Internet"
}

use:

CODE 
<frontend_url>/compose/create/general?mode=create&definition=c_time_off_request&defaults=%7B%22C_TIME_OFF_REQUEST_LEAVE_FROM%22%3A%222020-11-15T00%3A00%3A00.000Z%22%2C%22C_TIME_OFF_REQUEST_LEAVE_TO%22%3A%222020-11-26T00%3A00%3A00.000Z%22%2C%22C_TIME_OFF_REQUEST_AVAILABLE_ON_PHONE%22%3A%22Yes%22%2C%22C_TIME_OFF_REQUEST_ALT_PHONE%22%3A%22123456789%22%2C%22C_TIME_OFF_REQUEST_INTERNET_ACCESS%22%3A%22Mobile%20Internet%22%7D
image-20240419-104728.png

Prefilled document

Edit existing document

CODE 
<frontend_url>/compose/create/general?mode=edit&definition=<document_type>&documentId=<document_ID>

You must specify document type (template name) and document ID of the document

Example:

For existing document with type c_time_off_request and ID 51ebfacf-6c5a-4261-b2c4-5c2401e98d80 use:

CODE 
<frontend_url>/compose/create/general?mode=edit&definition=c_time_off_request&documentId=51ebfacf-6c5a-4261-b2c4-5c2401e98d80

2. Prepare Microsoft Office document

CODE 
<frontend_url>/compose/create/office?mode=create&definition=<document_type>&extension=<extension>&type=oos

You must specify document type and document extension

Possible extensions are:

  • docx - for Microsoft Word document

  • xlsx - for Microsoft Excel document

  • pptx - for Microsoft PowerPoint document

Example:

For document type d_default and docx extension (Microsoft Word) use:

CODE 
<frontend_url>/compose/create/office?mode=create&definition=d_default&extension=docx&type=oos
image-20240419-104949.png

Prepared Microsoft Word document

3. Prepare document from external file

CODE 
<frontend_url>/compose/create/external?mode=create&definition=<document_type>&type=ext

You must specify document type

Example:

For document type d_default use:

CODE 
<frontend_url>/compose/create/external?mode=create&definition=d_default&type=ext
image-20240419-105051.png

Prepared document from external file

4. Sign document in Circularo

Open “Select who needs to sign” dialog

CODE 
<frontend_url>/signPrepare?mode=create&documentId=<document_ID>&documentType=<document_type>&callbackUrl=<URL>

You must specify document type and ID of existing document

You can specify callbackUrl if you want to be redirected after successful signature or failure (user will not be able to leave the signing process - It does not mean the token has restricted rights! Just the current window does not allow you to leave the process)

Example:

For existing document with type c_time_off_request, ID 51ebfacf-6c5a-4261-b2c4-5c2401e98d80 and callback URL https://www.google.com use:

CODE 
<frontend_url>/signPrepare?mode=create&documentId=51ebfacf-6c5a-4261-b2c4-5c2401e98d80&documentType=c_time_off_request&callbackUrl=https%3A%2F%2Fwww.google.com
image-20240419-105359.png

“Select who needs to sign“

Sign document

CODE 
<frontend_url>/sign/<document_ID>/<document_type>

You must specify document type and ID of existing document

Example:

For existing document with type c_time_off_request and ID 51ebfacf-6c5a-4261-b2c4-5c2401e98d80 use:

CODE 
<frontend_url>/sign/51ebfacf-6c5a-4261-b2c4-5c2401e98d80/c_time_off_request
image-20240419-105458.png

Sign document

5. View documents

Filter documents by document type

CODE 
<frontend_url>/home/<document_type>

You must specify document type

Example:

For document type c_time_off_request use:

CODE 
<frontend_url>/home/c_time_off_request
image-20240419-105604.png

Documents filtered by type

Select document

CODE 
<frontend_url>/home/<document_type>?select=<document_ID>&selectType=<document_type>

You must specify document type and ID of existing document

Example:

For existing document with type c_time_off_request and ID 51ebfacf-6c5a-4261-b2c4-5c2401e98d80 use:

CODE 
<frontend_url>/home/c_time_off_request?select=51ebfacf-6c5a-4261-b2c4-5c2401e98d80&selectType=c_time_off_request
image-20240419-105704.png

Selected document

Show document detail

CODE 
<frontend_url>/home/<document_type>?select=<document_ID>&selectType=<document_type>&modal=detail

You must specify document type and ID of existing document

Example:

For existing document with type c_time_off_request and ID 51ebfacf-6c5a-4261-b2c4-5c2401e98d80 use:

CODE 
<frontend_url>/home/c_time_off_request?select=51ebfacf-6c5a-4261-b2c4-5c2401e98d80&selectType=c_time_off_request&modal=detail
image-20240419-105803.png

Detail of selected document

Show document preview

CODE 
<frontend_url>/home/<document_type>?select=<document_ID>&selectType=<document_type>&modal=preview

You must specify document type and ID of existing document

Example:

For existing document with type c_time_off_request and ID 51ebfacf-6c5a-4261-b2c4-5c2401e98d80 use:

CODE 
<frontend_url>/home/c_time_off_request?select=51ebfacf-6c5a-4261-b2c4-5c2401e98d80&selectType=c_time_off_request&modal=preview
image-20240419-105857.png

Preview of selected document

Show recent activity

CODE 
<frontend_url>/home/recentActivity
image-20240419-105930.png

Recent activity

6. Share link for external users

CODE 
<frontend_url>/share?shareId=<share_ID>

You must specify share ID

Example:

For existing share with id ad54c893defd0cb7c613147a0d427155bcfd82d3dc3905b59d05721e261e4e04 use:

CODE 
<frontend_url>/share?shareId=ad54c893defd0cb7c613147a0d427155bcfd82d3dc3905b59d05721e261e4e04
image-20240419-110056.png

Shared document to sign

7. Redirect on Login with token to a given state

This allows for you to use authentication token as a mean to login and automatically get redirected towards a state with provided parameters

This is just a transfer state - does not have its own screen

Usage

CODE 
<frontend_url>/loginRedirect?redirect=<new_state>&redirectParams=<redirect_params>&token=<token>

  • <new_state> - Application state where you should be redirected see possible values below

  • <redirect_params> - Parameters for new state where you are going to be redirected to

  • <token> - User token for automatic authorization

Example

CODE 
<frontend_url>/loginRedirect?redirect=app.signPrepare&redirectParams=%7BdocumentId%3A%E2%80%9Drandom_document_id%E2%80%9D%2C%20documentType%3A%E2%80%9Dd_default%E2%80%9D%2C%20forceHandover%3A%20%E2%80%9CAdam%20Smith%E2%80%9C%2C%20callbackUrl%3D%E2%80%9Dhttps%3A%2F%2Fwww.google.com%2F%E2%80%9D%7D&token=abcd

Remember to use encodeURIcomponent on each parameter that is more complex than a simple sequence of letters

Possible states with parameters

  • app.signPrepare - Prepare state for signing a document

    • documentId - ID of document to be signed

    • documentType - Definition of document

    • forceHandover - Name of user which should be automatically passed as in-person signer

    • callbackUrl - Sandbox the process of signing from rest of application and redirect on success or error to given URL

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close