Add a REST API connection
You can add a connection to an application through REST API using ThoughtSpot DataFlow.
To add a new connection to Salesforce, follow these steps:
-
Click Connections in the top navigation bar.
-
In the Connections interface, click Add connection in the upper right corner.
-
In the Create Connection interface, select the Connection type.
-
After you select the REST API Connection type, the rest of the connection properties appear.
See Connection properties for details, defaults, and examples.
- Connection name
-
Name your connection.
- Connection type
-
Choose the REST API connection type.
- Authentication type
-
Specify the type of authentication that is required to connect to the REST API service.
- REST API base URL
-
Specify the end point URL to access REST API web-service.
- Response format
-
Specifies the response format of the file.
- User
-
Specify the user who connects to the Rest web service. This user must have data access privileges.
For BASIC authentication type only. - Password
-
Specify the password for the User.
For BASIC authentication type only. - Obtain access token
-
Select this option to use access key/token to connect to the REST API web-service.
For OAuth 2.0 authentication type only.
- Access token
-
Specify the access token to authenticate REST API.
For OAuth 2.0 authentication type only.
- Refresh token
-
Specify the refresh token to authenticate REST API.
For OAuth 2.0 authentication type only.
- OAuth client ID
-
Specify the OAuth client ID.
Displayed only when "obtain access token" check-box is selected.
- Mask client secret
-
Specify the OAuth client secret.
Displayed only when "obtain access token" check-box is selected.
- OAuth authorization URL
-
Specify the OAuth authorization URL.
Displayed only when "obtain access token" check-box is selected.
- OAuth accesstoken URL
-
Specify the OAuth accesstoken URL.
Displayed only when "obtain access token" check-box is selected.
- Scope
-
Specify the number of users to access the account.
Displayed only when "obtain access token" check-box is selected.
- Callback URL
-
Secured domain URL of the repo which is used to register in REST API.
Displayed only when "obtain access token" check-box is selected.
- REST API parameters
-
When adding REST API parameters, click Add, and then specify the
Parameter name
,Value
, and if the parameter is aHeader
.
-
Click Create connection.