— Before proceeding I’d suggest you read Part 1 and Part 2 of this article. —
In this age of integration, you need an edge. The DBSync Swagger API connector is it. If you have a Swagger compliant JSON description of your app’s RESTful API, you can use this tool to create a connector to your app, which can then serve as a bus to connect to other apps, such as Salesforce or Quickbooks, via the DBSync app.
In this tutorial you will learn how to create this kind of connector, enabling you to up your success at creating a meaningful and efficient ecosystem for your business.
Creating a Swagger API connector
Creating a Swagger API connector is simple. You just need to follow these two easy steps:
Step 1: Create a new project.
This step is required only if you don’t already have a project where you want to add the connector. In order to do so, just go to the DBSync app’s menu on the left side, and click on the Projects item. The below figure shows the results screen. Now, click on the Create New Project button, enter the name of your project and press the Save button. Your project will appear on the project’s list on the screen.
Figure 1 – Create a new project
Step 2: Create a new Swagger API connector
Once you have your project ready, select it and go to the main menu item Connectors. Once there, click on the Create New Connector button. You will see a screen asking for a name and connector type. Type in the name of your connector, and select Swagger API Connector from the dropdown menu. Then, click on the Save button. A new screen asking for the connector’s information will appear.
Figure 2 – Connectors’ item in main menu
Figure 3 – Create a new connector
The, in the next screen (figure 4) enter the following parameters:
- The username and password of your account in your app.
- Authentication type: select from the dropdown menu, among the following values:
- NoAuth: when no authorization is required.
- BasicAuth: when you are using a basic access authentication.
- OAuth 2.0: when you need to use the OAuth protocol.
- ApiCodeAuth: when the authorization mechanism is defined in your code.
- The URL to your RESTful API.
- Copy and paste the JSON file that documents your API.
Figure 4 – Connector’s parameters
Once all the required inputs are completed, click on the Save button. You will then see the following screen:
Figure 5 – Connector successfully saved
That is it! Your connector is ready to do the work for you.
You can test the connection by pressing the Validate Connection button, just to be sure that all is working correctly.
In these series of three articles on Swagger you have seen the importance of Swagger as a standard for creating APIs. You have also learnt how to create a JSON file that documents your app’s RESTful service. And finally, in this third part, you have understood how to create a Swagger API connector by using DBSync.
Ready to learn more? Check out our website and start your free trial now!