- In Conduit, click on Endpoints: 


- From the available endpoints, choose REST Endpoint:



- All available REST API requests for Conduit will be displayed:


- Authorization needs to be carried out in order to have all requests authenticated; this can be done following the steps below:


1. Go to Conduit and click on your username:


2. Click on Access Token:




3. Click on Copy Access Token:


4. Go back to Swagger and click on Authorize:


5. Paste, in the available field, the access token previously copied from Conduit and click on Authorize:


6. Icon lock is closed now, meaning that the authorization was successful:



How to make an API request using Swagger:


Example #1

- For instance, in order to get the tables of a connector, choose the GET method below and click on Try it out:



- For this case scenario, the Conduit connector below will be considered:


- Then, for the above GET method in Swagger, in the Database name field, the name of the connector (here: example) needs to be inserted; after that, click on Execute:



- The response is received; the response code is 200 – REST API successfully carried out; the corresponding table of the above example connector is titanic:



- Other possible REST response and their corresponding meaning are displayed:



Example #2


- For instance, in order to get information about a Conduit Parquet Store entity, choose the GET method below and click on Try it out:



- For this case scenario, the same example connector will be used, just as in the above case; when checking the Parquet Store page in Conduit, it can be observed that the dataset corresponding to this connector is materialized and there is several information available for the Parquet Store entity:





- For the above mentioned API request, that gets the information about a materialized connector, the name of the connector (here: example) needs to be inserted in the Connector name field, as well as the extended table name corresponding to the materialized dataset (taken from Parquet Store - just as in the above image); after that, click on Execute:





- The response is received; the response code is 200 – REST API successfully carried out; all available information of the materialized titanic dataset of example connector is received:




- Other possible REST response and their corresponding meaning are displayed:





Related Articles