1️REST API
Connect REST API to QuickDEV
Follow these steps to connect to REST APIs.
Click Data Sources on QuickDEV homepage.
Click on "New data source" located in the upper right corner. Please note that this permission is restricted to workspace admins and developers.
Select APIs > REST API.
Configure general settings, providing at minimum the Name and base URL of the API to connect to. Headers and Parameters are optional, though they encompass common parameters including URL query prefixes.
Configure Authentication Type.
Click Save
Authentication type
The default authentication type is None. Additional options include Basic and Digest, which necessitate the configuration of Username and Password.
SSL Cert Verification
In the advanced settings tab, you can configure SSL Certificate Verification for your data sources. Three options are available: CA (Certificate Authority) Certificate, Self-Signed Certificate, or Disabled. By default, QuickDEV accepts APIs with CA certificates for security reasons. For APIs lacking CA certificates, you can either choose "Verify Self-Signed Cert" and provide the self-signed certificate, or disable the SSL Certificate verification altogether.
Note that for a self-signed certificate, the information must be provided in .PEM (Privacy-Enhanced Mail) format. This certificate will be encrypted and securely stored in QuickDEV.
Forward cookies
Cookies can be leveraged to send REST API requests to services within the same domain. You have two options - either forward all cookies or specify particular cookies to forward in the text field. This functionality is useful when cookies are used to share common context, like identification data in JWT format, across multiple services. By forwarding cookies, you can maintain context across services called through the API.
Create a REST API query
Two distinct approaches can be used to build REST API queries:
add a new data source and then create a query
create a query directly
Please be aware that unless a new data source is established, the REST API data source won't be retained in your Data Sources, rendering it inaccessible for constructing additional queries.
Create a query with a new data source
Proceed by following the steps to introduce a novel REST API data source, and subsequently, you can initiate the process of crafting a query.
Connect REST API to access to.
Within the query editor, select the option labeled + New.
Select the added API in Data source.
Enter URL, Headers, Parameters, and fill in other fields if needed.
Click ▶ Run.
Create a query with an existing data source
Follow the steps to create a REST API query directly.
Within the query editor, locate and select the option labeled "+ New".
Select REST Query in Data Sources.
Input the URL, Query, Variables, Parameters, and complete any other necessary fields as required.
Click ▶ Run.
Last updated