1b: Additional Information Tab Explanation

Getting started with Adapter Builder can be quite a daunting task; however, we will clarify some of the concepts of the Information tab to help with some of the questions you may have throughout the process.

Let's begin with the very first part of our Information tab, we will call it the adapter basic information. Here is a screenshot of what it looks like:

Name and Description

From the top to the bottom, we will explore each and every field on this screen. The first two fields on the top Adapter Name and Adapter Key are highly related to each other, therefore, it is important that we name the adapter properly and ensure that it does not match the name or adapter key of any other adapter in the Adapters Catalog. That being said, our first step will be to enter the name of your new adapter, and you will notice that the Adapter Key will be automatically generated based on the name given to the adapter. Here is an example:

Next is the Description portion of the adapter, we believe this is pretty self-explanatory, however, one of the tips we will give is that you provide a concise, clear description of your adapter's purpose (for example, "this adapter makes magic happen"):

The next portion is the select the application program interface (API) setup. You should notice that you have 3 options at the present time: REST API, SOAP API, and finally, Database. Select the appropriate option based on your API structure:

The final portion of the Information setup screen is the select the Authentication flow required to interact with your integration. We support some of the most common methods such as OAuth2, OAuth1, Basic, among others. You can find all the options available by simply click on the drop-down menu, and selecting the option that fits your authentication flow:

After all these fields are completed, you can just upload your adapter "image" and you will be to move on by clicking the Save and Next button on the right top corner of the page.