Overview
API Blocks allow you to connect to other data sources in your organization in order to augment or verify extracted data. You can work with your Hyperscience representative to configure these blocks and place them anywhere in your flow after data extraction. API Blocks do not contain business logic; that logic is configured in subsequent flow blocks.
We offer two types of API Blocks: HTTP API Request and SOAP.
Sample use cases
I want to call out to an external REST API to validate data I have extracted from my submission.
I want to call out to an external SOAP API to pull in additional data to enhance the submission data I have in my flow.
Block settings table
HTTP Rest
Settings
You can customize the functionality of your block by editing the settings described below.
Name | Required? | Description |
|---|---|---|
Enabled | Yes | Indicates whether the API connection is enabled. |
Name | Yes | The name of the API connection. |
Method | Yes | The method of the API request. |
Endpoint URL | Yes | The URL that requests will be posted to. |
[v37.0.6 and later] Endpoint URL Secrets | No | A list of secret key names and values to be sent as parameters in the endpoint URL. Enter each name-value pair in its own line of text. Example: |
Authorization Type | Yes | The type of authorization used to authenticate the API request. Can be one of the following:
|
HTTP Authorization Header | Yes | The content of the request's Authorization header. |
OAuth2 Authorization URL | Yes | The URL of your downstream system's authorization server that will issue the connection's access token. |
Client ID | Yes | The client ID for the connection, as issued by your downstream system during the application-registration process. |
Client Secret | Yes | The client secret for the connection, as issued by your downstream system during the application-registration process. |
Audience | Yes | The resource service URL that will be sent to the OAuth2 Authorization URL, along with the client credentials, when obtaining the access token. |
SOAP
Settings
Name | Required? | Description |
|---|---|---|
Use WSDL | Yes | Indicates whether the API connects to a web service using WSDL. |
Endpoint URL | Yes, if Use WSDL is not selected | Absolute URL, including the schema’s HTTP endpoint, for this request. This setting is available only if Use WSDL is not selected. |
WSDL URI | Yes, if Use WSDL is selected | URI to a XML-based interface description language that is used for describing the functionality offered by a web service. This setting is available only if Use WSDL is selected. |
Method | Yes | The method of the API request (e.g., Add, Get). |
WSDL Service Name | No | This value binds to the WSDL service element name. The service element defines the collection of ports supported by the web service. For each of the supported protocols, there is one port element. This setting is available only if Use WSDL is selected. |
WSDL Port Name | No | This value binds to the WSDL port element name. A port element defines an individual endpoint by specifying a single address for a binding. This setting is available only if Use WSDL is selected. |
Body Namespace | Yes | The namespace URI for the SOAP request body. |
Headers Namespace | Yes | The namespace URI of the SOAP request headers. |
SOAP Headers | No | The SOAP request headers. |
SOAP Parameters | No | Key-value pairs used as query parameters in the request, which are inserted in the SOAP body. |
Setting up API Blocks
To set up the HTTP Rest or SOAP API Block, enter the settings as described in the Block settings table above. You do not need to configure anything outside of the Hyperscience application.