Seamless Integrations
Introduction
Seamless integration is the process of adding or integrating a new application’s action and its connection seamlessly. It allows you to simplify their repetitive need of integrating processes with just a few clicks.
How to use Native Apps
Native apps can be used by you in 2 manners, i.e., by creating the native connection and by creating the native action.
Steps To Use Native Connection
Click on create a connection on the right side of the screen. The following form will appear on the screen.
Select the desired application from the drop-down box of the select application field.
Select the connection mode based on your requirement. You can select the template-based connection or custom as per the requirement. The connection mode is circuit oriented. Data are transmitted in sequence over an established connection.
Select the connection name and fill in the description. The connection name is a unique identification name and description for the respective connection. For example, Jira connection.
Now, provide the authentication details, and access token URL as per the requirements. Authentication details are the information related to the process of recognizing a user's identity. It is the mechanism of associating an incoming request with a set of identifying credentials. On the other hand, an access token URL is required to ensure your platforms are safe from unauthorized access. Now click on authorize and save.
After clicking on the authorize and save, the URL of the application will be open. For example; Slack, as shown in the below image. Now you need to select allow for providing authorization, and the application will be created for future use.
You can also opt for custom, by selecting it from the drop-down box.
After selecting the custom they need to provide the information such as connection type. A connection type means a connection that identifies whether the connected person is a generator, distributor, or direct consumer and whether the connection is to the grid, a local network, or an embedded network.
Now add the rest connection type. For more details visit https://sappersoftware.atlassian.net/wiki/spaces/SD/pages/63602585
Add the connection name and provide a description. The connection name is the specific name of the connection.
Add a hostname, i.e. the domain of the provided application. It is the initial part of the URL of the landing page of the application. The hostname is a unique name or label assigned to any device that is connected to a specific computer network.
Provide the username and password. A username allows you to maintain your identification when you use a particular application or connection. Passwords require to protect your sensitive information. It’s can be generated with a unique combination of numerical and alphabetic characters.
Fill in the header field, and header prefix. The header field enables the client and server to provide additional information with the request or response. The header fields are specified in the <headers> element in the adapter request and support the HTTP standard headers in a JSON format.
On the other hand, a header prefix is a feature is used to ensure that a certain snippet of code is inserted at the beginning of every file. Following are the listed prefixes:
Basic: Basic Authentication is a method for an HTTP user agent (e.g., a web browser) to provide a username and password when the request proceeds. When employing Basic Authentication, you need to include an encoded string in the Authorization header of each request you want to make.
Bearer: Bearer authentication is an HTTP authentication scheme that involves security tokens called bearer tokens. The bearer token is a cryptic string, usually generated by the server in response to a login request.
Token: API tokens allow you to authenticate with cloud apps and bypass two-step verification and SSO, and retrieve data from the instance through REST APIs. Token controls allow admins to view and revoke the use of API tokens by their managed accounts.
None
Now click on save and the native connection will be saved. You can use it as per your requirements.
Native Actions
Native actions are listed under the action drop-down menu, which can be invoked in the integration with a few clicks. For example, the https://sappersoftware.atlassian.net/wiki/spaces/SD/pages/672464960
The task contains actions to post messages and list all channels in Slack.
You can also create a custom action for an application task as per their requirements.
For more information: https://sappersoftware.atlassian.net/wiki/spaces/SD/pages/671612968
Steps to use Native Actions
Click on create automation and select the Slack application. The following form will appear.
Drag and drop Slack from the task node and click on it, and the form will appear on the right side of the screen.
Select the connection i.e. Slack connection
Now, choose the action as per the scenario i.e. ‘Send message to Channel’. Actions put your app front and center in Slack. Nestled under the ellipsis menu, apps with actions show up on every Slack message in a workspace.
As per the selection of action, new input fields will appear in the form. Now, you need to fill in the channel name, A channel's name lets people know what it's used for. If the purpose of a channel changes at any point in time, it can be renamed.
Provide an appropriate message based on the requirements. A message can be a combination of text, symbols, and numerical characters.
Click on save to complete the action
Custom Action
If the action is not listed in the action’s drop-down menu then, you can create their actions with the help of the custom action. As the name suggests they can customize the action for the task based on their specific requirement.
Steps To Create a Custom Action
Drag and drop the desired Native app, you wish to work upon.
Select connections for the chosen Native app.
Now, click on action’s drop-down menu and select a custom action.
Choose the desired method of action:
GET is used to fetch something from the server
POST helps to create something on the server
PUT helps to update something on the server
DELETE is to delete something from the server
5. Provide the API URL for the action to be performed. For API URLs refer to the API documentation of the selected application which you can get from the application website.
6. Select the appropriate request type. A request type is the type of request sent by the requester such as an incident or request for any information.
7. To create the custom action, there is 4 request type, i.e., JSON request body, URL encoded form, multipart form, and raw request body.
Request Type | Description |
|---|---|
JSON request body | The JSON request body is a method of the request interface that reads the request body and returns it as a promise that resolves with the result of parsing the body text as JSON. |
URL encoded form | The URL-Encoded Form is a widely-supported encoding on the web. It's most often used for serializing web forms sent via POST requests. This encoding is also used to send structured data in URL query strings. It is a relatively efficient encoding for sending small amounts of data. |
Multipart form | A multipart/form-data is one of the values of the enctype attribute, which is used in form elements that have a file upload. multi-part means form data divided into multiple parts and send to the server. |
Raw request body | The raw HTTP request action sends an HTTP request to a web server. How the response is treated depends on the method, but in general, the status code and the response headers are returned in variables defined as part of the page load options. |
8. While opting for methods other than GET, for the JSON request body, an input field named use JSON will appear. You can add the data here, which will be converted into a form for further usability. Also, the generated form consists of three options i.e., dynamic list, static list, and clear list
9. Add the request header & query parameters as per the requirement. A request header is an HTTP header that can be used in an HTTP request to provide information about the request context, so that the server can tailor the response. On the other hand, query parameters are a defined set of parameters attached to the end of a URL. They are extensions of the URL that are used to help define specific content or actions based on the data being passed.
10. Now, click on save to successfully save the connection.
Community Templates
You also can view and use the can pair with and the automation just by clicking on the application. In this section, you can find out the applications that can be integrated with the specific app. For example, If you select Jira they will be able to see the existing applications that can be integrated, i.e., Salesforce, ADP, Slack, and many more.
Steps to use Community Templates
Select the application from the marketplace, For example, Jira
On the right side, you can find out the existing automation.
To find specific automation options, you need to check the can pair with the application on the left side.
To identify the integration apps you need to search from the search bar. In the can pair with input, you will be able to find the desired applications that you wanted to pair with other applications.
After pairing with the applications, you will be able to find out the existing automation for the specific application. For example., Jira and Salesforce
In the automation section, you can find out the existing automation or cases by clicking on the links.