Developers: Getting started

Steps on how to get started and setting up local environment for development and testing.

go to referral.qwestive.io and select your project

referral.qwestive.io landing page

make sure you can access admin section

admin section from left sidebar

go to API settings to access project level api keys

  • Copy ProjectId will be used in SDK initialization and server-side API

  • Copy API key for client-side SDK purpose

  • Copy API secret Key for server-side APIs

  • Add client-side app's domain, also localhost while testing in development

API settings page

These values will be required while using our tracking SDK or embedUI SDK or calling our server-side APIs.

Parameter
Description

projectId

Unique id for the project

apiKey

Public api key to be used to from tracking SDK and embedUI SDK (client-side only)

secretApiKey

Secret api key to be used for calling APIs directly from a server where it is stored securely (server-side only)

Please note to add your web app's domain or localhost in allowed domains list for authorization, where SDK will be integrated or initialized from

Once, the integration has been completed and tested, it can be removed from the list.

Few other parameters like project-key and campaignId will be required for EmbedUI:

Parameter
Description

project-key

project-key is the subdomain of the project assigned within qwestive's referral app

campaignId

Unique id for the campaign within the project

  1. Go to qwestive's referral app and select your project

  2. From project page, select specific campaign which you want to display in embedUI by default

  3. Now, copy the url from the navigation bar of your browser, it should look something like this: "https://test.referral.qwestive.io/referral/uPqB6kNJwd6SXVsXIVTa ".

  4. Here, test.referral is project-key and uPqB6kNJwd6SXVsXIVTa is campaignId

Last updated