listOfAdvertisers Endpoint

The listOfAdvertisers endpoint can be used by publishers to obtain the list of advertisers (insurers) and display it on their application screens.

Design Recommendation

The listOfAdvertisers endpoint should be called from the publisher's backend, and not from the customer application. Exposing this endpoint through the application will result in security concerns related to the API key.

GET https://iql.zendrive.com/iql/v1/advertisers

Headers

Name	Type	Description
Authorization*	String	APIKEY <apikey>

200: OK Request successful and list of advertisers returned as JSON.

{
    // Response
}

401: Unauthorized Unauthorized Request (problem with API key or setting authorization HTTP header in request).

{
    // Response
}

404: Not Found URL Not found (could be because the URL contains the wrong version of the endpoint).

{
    // Response
}

Response Body

Field Name	Nullable	Type
advertisers	No	List[String]	List of advertiser names

Sample Request URL

https://iql.zendrive.com/iql/v1/advertisers

Response

The list of advertisers will be sent to the publisher as a JSON file.

Sample Request

curl --location --request GET https://iql.zendrive.com/iql/v1/advertisers --header 'Authorization: APIKEY <apikey>'

Sample Response

{
    "advertisers": ["Advertiser1", "Advertiser2"]
}