IQL Testing Framework API Endpoints

IQL Testing Framework API endpoints are used to create mock data such as Trip and SDK Health to verify IQL use cases, for example: a list of trips, Ad Unit information and so on. Publishers can create mock data using only those users that are provided by the Zendrive team.

IQL Testing Framework includes the following three API endpoints:

1. createMockTrips

2. createMockSDKHealthPackets

3. triggerMockEngagement Webhook

How To Use the IQL Testing Framework API Endpoints?

Perform the following steps to deploy the IQL testing framework API endpoints:

1. Verify the driverTrips API

To verify the driverTripsAPI, you need to successfully invoke the mockTrips API, for any given date.

2. Verify the driverStatus API

To verify the driverStatusAPI, successfully invoke the mockTrips API for any given date.

3. Verify User Qualification

We have created a mock campaign to display an offer to users who meet the following qualifying criteria:

• trip_count >=5

• unique_driving_days>=3

• distance >=12

• country =’USA’

• state["AZ", "IL",”IN”, “MS”, “NE”, “UT”]

Create mock data using the following APIs to make the user eligible for mock campaigns:

• Set the State for the user using the driverInfo API.

• Create a set of required trips using the mockTrips API.

4. Verify Ad Unit API

Invoke the adUnit API to verify that the qualification webhook is received for the mock user.

5. Verify the Engagement Webhook

Verify following the three engagement webhooks to establish that the mock engagement is working. Note that in order to qualify for engagement, the user needs to belong to the State where the mock campaign is alive.

5.1. Verify Permission and Inactivity Engagement Webhooks

Create the SDK Health packet, using the sdkHealth API, containing the user's permission and inactivity information for the last 24 hours. The Engagement Webhook executes automatically after it receives the SDK Health packet.

5.2. Verify the Opt-In-Days Engagement Webhook

In order to trigger the Engagement Webhook, Publishers need to request the Zendrive team to create a mock user who satisfies the pre-set configuration.

5.3. Verify the No-Click Engagement Webhook

If the user has been presented with an offer but has not yet clicked it, the No-click Webhook will be triggered, based on the click threshold that you set. Then, invoke the triggerMockEngagement API, to trigger any of the above engagement webhooks.

Reference

Click here to know more about various engagement webhooks.