Working With External Integrations

Integrations determine how your app interacts with external APIs. Using integrations, you can:

  • allow users to authenticate with 3rd party services
  • create dynamic views that are bound to API endpoints

Adding an integration

Qwikly provides a set of pre-configured integrations that make it easy to get set up with popular services. You can also create a custom integration if the service you need isn’t among the pre-configured integrations.

Adding a pre-configured integration

To add a new pre-configured integration, do the following:

  1. Open ‘Menu > File > Project Settings’
  2. Click the ‘Integrations’ tab
  3. Click ‘Add Integration’
  4. Search for a service using the search box
  5. Click a service icon to create the integration
  6. Click the new integration and fill out the required info

adding-an-integration

Adding your own integration

To add a new custom integration, do the following:

  1. Open ‘Menu > File > Project Settings’
  2. Click the ‘Integrations’ tab
  3. Click ‘Add Integration’
  4. Click ‘Add your own’ to create a new integration
  5. Fill out the integration’s basic information
    • Name - used in the Qwikly UI
    • Base URL - the fullly-qualified URL (e.g. https://example.com/api/v2)
    • Auth - the authentication options
  6. create any API requests you want to make (see ‘Requests’ below)

adding-custom-integration


Requests

Each integration can define any number of API requests - these requests are the mechanism by which your app can communicate with the external API.

To create a new request, do the following:

  1. Open ‘Menu > File > Project Settings’
  2. Click the ‘Integrations’ tab
  3. Click on an integration to display it
  4. Click ‘Add a request’
  5. Fill out the request details:
    • Name - this will be used in the Qwikly UI
    • Endpoint - this is the path for this request, relative to the integration’s Base URL.
    • You can include placeholders for path segments (e.g. /projects/:id)
    • Placeholders allow you to use view properties to interpolate request URLs
    • Method - the HTTP method type
    • Params - each param will be included as name/value pairs when making the API Request

adding-requests