edoc automate Guide
Breadcrumbs

RestAPI - edoc automate

The RestAPI data source enables access to REST API functions. The data source is used to define the basic parameters for accessing the API.

Parameters

Type

Name

Description

TEXT

Host

Specifies the base URL of the REST API.

SELECT

Auth Type

Specifies the authentication type. Possible values are: noauth, basic, and apikey.

TEXT

Username

Specifies the user name for authentication.
Is only used for Auth Type in conjunction with basic.

PASSWORD

Password

Specifies the password for authentication.
Is only used for Auth Type in conjunction with basic.

SELECT

API-Key Location

Specifies where the API key should be placed. Possible values are: header and query.
Is only used for Auth Type in conjunction with apikey.

TEXT

API-Key Name

Specifies the name of the API key.
Is only used for Auth Type in conjunction with apikey.

PASSWORD

API-Key Secret

Specifies the secret key of the API key.
Is only used for Auth Type in conjunction with apikey.