RestFul API Link Parameters

Name

Link name, which should be defined based on the data source type, so it is easier to remember what the link is for

RestFul API_link

Connection Address Prefix

Prefix of a batch of APIs, which may have a public authentication mode and default request header

https://test.com/rest/api

Test Request Path

Address to test, which is automatically combined with the connection address prefix. If 200 is returned, the connection is successful.

/test

Test Request Method

Type of the test request method. Only GET and POST requests are supported.

GET

Header Parameters

Default header parameters used to call the RESTful API. This header is carried when the API is called.

{"Content-Type":"application/json"}

Test Request Body

This parameter is available when Test Request Method is POST.

Request body for testing connectivity. If 200 is returned, the connection authentication is successful.

{"Content-Type":"application/json"}

Authentication Method

Authentication type.

• NONE: no authentication
• Basic Auth: basic authentication. If the data source API supports username and password authentication, you can select this authentication type and configure the username and password used for authentication. When the data source is connected, the username and password are transferred to the RESTful address through the Basic Auth protocol. The format is {"Authorization":"Basic base64(username:password)"}.
• Token Auth: token authentication. If the data source API supports token-based authentication., you can select this authentication type and set a fixed token for authentication. When the data source is connected, the token is transferred to the header for authentication. The format is {"Authorization":"Bearer "}.
• Oauth 2.0 (Authorization Code): In this mode, a username and a password are used to obtain an access token, which is used to access APIs.

Username

This parameter is displayed when Authentication Method is set to Basic Auth.

It indicates the username for RESTful API authentication.

-

Password

This parameter is displayed when Authentication Method is set to Basic Auth.

It indicates the password for RESTful API authentication.

-

Token

This parameter is displayed when Authentication Method is set to TOKEN_AUTH.

You can use #token to obtain the value and transfer it in body|header.

The token is static and never expires. Otherwise, jobs will fail if the token expires.

-

Authentication URL

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT.

This API supports OAuth 2.0. Authentication credentials are used to obtain a token. Before testing connections and jobs, call this API to obtain the token. In addition, the location, name, and value acquisition mode of the token carried in subsequent APIs are defined in the authentication token.

https://xxx.com/auth/token

Authentication Request Method

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT.

Authentication request method in OAuth 2.0 mode. The value can be Get or POST.

Get

Authentication Request Header

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT.

Request header for the Oauth 2.0 mode. The authentication account and password can be obtained through #authUsername and #authPassword.

{"username": "#authUsername","password": "#authPassword","Content-Type":"application/json"}

Authentication Request Body

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT and Authentication Request Method is set to POST.

It indicates the request body for the Oauth 2.0 mode. This parameter is unavailable when Auth request method is set to GET. The authentication account and password can be obtained through #authUsername and #authPassword.

{"username": "#authUsername","password": "#authPassword"}

Authentication Username

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT.

This parameter is mandatory for the Oauth 2.0 mode. You can use #authUsername to obtain the value of this parameter and enter it in the authHeader or authbody parameter.

-

Authentication Password

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT.

This parameter is mandatory for the Oauth 2.0 mode. You can use #authPassword to obtain the value of this parameter and enter it in the authHeader or authbody parameter.

-

Authentication Token

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT.

You can obtain the authentication token from the response body of the authentication API and transfer the token when testing connections or jobs. The token can only be added to the header. It contains a parameter name and a value. The value can be a SpEL expression.

The authentication response body is {"code" : 200,"data" : {"access_token" : "DSFSDFWE87WE9089W9EW9ER898WER9W89ER8","expired":1000}};.

To obtain the value of access_token and meet the Bearer format, enter {"NAME":"Authenrization","VALUE":"'Bearer ' + #response.data.access_token"}.

To obtain the token from the response header (for example, the key corresponding to the header is x-token), set VALUE to #header.x-token.

Authenrization corresponds to the key of the authentication parameter of the request API.

-

Authentication Token Validity Period

This parameter is displayed when Authentication Method is set to OAUTH_CODE_GRANT.

Validity period of the authentication token, in seconds. The value can be an EL expression. The default value 0 indicates that the token is permanently valid.

• 300 indicates that the validity period is 300 seconds.
• #response.data.expired: Obtain the value of the expired attribute from the JSON string returned by the authentication API. The default unit is second. If the value is not of the int type, enter a validity period.

Advanced attributes

Advanced attributes, including:

• maxTotal: maximum number of connections, which is 200 by default.
• connectTimeout: connection timeout duration, which is 10,000 ms by default.
• connectionRequestTimeout: timeout duration for obtaining connections, which is 5,000 ms by default.
• socketTimeout: timeout duration, which is 60,000 ms by default.
• maxRetryCount: maximum number of retries, which is 30 by default.
• maxRetryTime: maximum retry time, which is 10 minutes by default.
• httpCodeSuccess: HTTP response success code, which is 200, 201, or 202 by default.
• httpCodeNotNeedRetry: HTTP response code, which indicates that no retry is needed. The default value is 200, 201, 202, 401, 403, or 404.

-