Dela via


Docurain

Docurain API allows you to create your own documents using template files registered in Docurain and Data for each App and DB.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Docurain support
URL https://api.docurain.jp/console/inquiry
Email cs@docurain.jp
Connector Metadata
Publisher root42 Inc.
Website https://docurain.jp/
Privacy policy https://docurain.jp/privacypolicy/
Categories Content and Files;Productivity

Docurain is a cloud service that allows you to insert data into your own form layout designed in Excel and output it in Excel/PDF. By connecting with Docurain, you can easily create and output original business forms that work with PowerApps. The original forms can be designed in Excel, so you don't need to understand how to use complex design tools. You can design highly expressive forms in a short amount of time.

Prerequisites

  1. Go to the Docurain website (https://docurain.jp) to obtain an account.
  2. Log in to the Docurain site with the account you have obtained.
  3. Register an Excel file template for the report you want to output.
  4. Issue an authentication token.
  5. You can use this service free of charge up to 300 times/month for development use, but you will also need to register a credit card for commercial use.

How to get credentials?

  1. Login to the Docurain website.
  2. Go to the "Tokens" page.
  3. Click on the "Add New" button.
  4. Set an expiration date of your choice and the allowed IP address is *.*.*.* (any IP address is allowed) and press the "Publish" button.
  5. Then the token string will be generated. This is your API authentication key.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring 'The Access token you created in the Docurain console screen will be your API Key: token [access_token] True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get the processing result

Get the processing result of the specified result ID.

Get the processing status

Get the processing status of the specified result ID.

Render a form

This API renders a form by specifying the name of a template saved in Docurain beforehand.

Render a form asynchronously

API to render a form asynchronously by specifying the name of a template saved in Docurain beforehand.

Get the processing result

Get the processing result of the specified result ID.

Parameters

Name Key Required Type Description
Result ID of the processing result to be acquired.
resultId True string

Specify the result ID returned by RenderAsync.

Returns

If the process is successful, the binary data of the generated form is returned. If the process fails, JSON with the details of the error is returned.

body
binary

Get the processing status

Get the processing status of the specified result ID.

Parameters

Name Key Required Type Description
Result ID to query processing status
resultId True string

Specify the result ID returned by RenderAsync.

Returns

Name Path Type Description
status
status string

Processing status of the specified result ID: PROCESSING:Rendering in progress, FAIL:Failure, SUCCESS:Success

Render a form

This API renders a form by specifying the name of a template saved in Docurain beforehand.

Parameters

Name Key Required Type Description
output format
outType True string

Set the output format: pdf, xls(xlsx), png, jpg, jpg, gif, svg

pre-saved template name
templateName True string

Specify the name of the template you have already saved in Docurain.

data format
X-Docurain-Data-Type True string

Set the data format : json, csv, tsv

body
body True string

Specify the string data in the format (json/csv/tsv) that you specify for the data format.

Returns

Reply to the binary data of the rendered form.

body
binary

Render a form asynchronously

API to render a form asynchronously by specifying the name of a template saved in Docurain beforehand.

Parameters

Name Key Required Type Description
output format
outType True string

Set the output format: pdf, xls(xlsx), png, jpg, jpg, gif, svg

pre-saved template name
templateName True string

Specify the name of the template you have already saved in Docurain.

data format
X-Docurain-Data-Type True string

Set the data format : json, csv, tsv

body
body True string

Specify the string data in the format (json/csv/tsv) that you specify for the data format.

Returns

Name Path Type Description
resultId
resultId string

ID for querying the processing status of the asynchronous API and obtaining processing results

Definitions

binary

This is the basic data type 'binary'.