External Lookups

An overview on the external lookups

External lookups feature is used to retrieve single columned values (Names, City names, etc) into an Quixy application from any 3rd party database that has an Open/Rest API.

There are two different types of APIs:

  1. Open Source: These are universal APIs that can be used by any individual to retrieve the data from the 3rd party database without any restrictions because it does not require any authentication.
  2. Secured: These are also universal APIs but these are secured with a Password, or secret key, or token, etc., that require authentication while consuming these APIs and retrieve the data from the 3rd party database. 

How to configure External lookups (Without Authentication)?

  • On the dashboard page, click on the Admin Menu > Database > Lookups.

  • On Lookups list page, click on the External Lookups tab.

  • On External Lookups list page, click on the Add button on the top right corner of the page.

  • You will land on the External Lookups creation page.

  • Start by selecting a Workspace.
  • Give a Name to the External Lookup.
  • Enter the API in the App Reference Url box that you have obtained from 3rd party.
  • Obtain the Optional parameter from the 3rd party. Enter the parameter in the Optional parameter to test box and click on the Test URL button to check if the API is working.
  • Once the test is complete and API works, you will get an Select Elements drop-down to select the input values. 
  • Select the required input values for which you want the output values.
  • Since we are creating an External Lookup with an open API, it doesn't require any authentication, so, choose the Authentication Type as None.  
  • Save the External Lookup.

    How to configure External Lookups (With Authentication)?

    Many people across the globe would secure their database's APIs with different types of authentications. The APIs might be secured with a Password, or secret key, or token, etc.,

    To consume these APIs, in Quixy we have different types of authentications to access these secured APIs. We just need to obtain the security details from the 3rd party system and provide it in Quixy.

    Configure a External Lookup (With Authentication)

    • On the dashboard page, click on the Admin Menu > Database > Lookups.

    • On Lookups list page, click on the External Look up tab.

    • On External App References list page, click on the Add button on the top right corner of the page.

      • You will land on the External Lookups creation page.

    • Start by selecting a Workspace.
    • Give a Name to the External Lookup.
    • Enter the API in the App Reference Url box that you have obtained from 3rd party system.
    • Obtain the Optional parameter from the 3rd party system. Enter the parameter in the Optional parameter to test box and click on the Test URL button to check if the API is working.
    • Once the test is complete and API works, you will get an Select Elements drop-down to select the input values. 
    • Select the required input values for which you want the output values.
    • Since we are creating an External Lookup with an secure API, it requires authentication, so, choose the required Authentication Type.  
    • Obtain the authentication details from the 3rd party system.
    • As of now in Quixy, we have four different authentication types.
      • OAuth 2 Clientid Secret: This is used when the API is secured with a Secret Key.

      • Token Authentication: This is used when the API is secured with a Access Token.

     

      • Basic Authentication: This is used when the API is secured with a simple User Name & Password.

      • OAuth 2 Basic: This is used when the API is secured with a combination Access Token, User Name & Password.

    Note: You need to obtain the security details (i.e., Token End Point, User Name, Password, Secret Key, Client ID) from the 3rd party system and provide it in Quixy.

    • Once the API is authenticated, save the External Lookup.