Integration docs
API Integration Considerations & Best Practices
Integrating RevU via API allows for a fully custom, white-labeled offer experience, providing greater control over layout and user flow. However, this advanced integration method requires significant engineering resources and a deep understanding of how to manage offer data effectively.
To maximize revenue and minimize user friction, developers should adhere to the following technical and strategic considerations.
1. Managing "User Levels" in the All Offers API
The All Offers API is designed for broad inventory ingestion and internal discovery. One critical data point within this API is the User Level. This field identifies offers restricted to specific user segments based on demographic or behavioral data.
If your system is not currently configured to programmatically verify and target users based on these specific levels, you must discard all offers where user level > 0. Showing a "Level 1" offer to a "Level 0" user will result in immediate disqualification upon clicking, leading to a poor user experience and wasted traffic. We recommend stronger documentation on these levels so your team can eventually tap into this high-value demand by only showing them to relevant users.
The All Offers API provides a raw list of inventory, but it does not perform real-time eligibility checks. You should utilize the User-Level Offer API in tandem with your ingestion logic. The User-Level API filters offers based on an individual user's history and attributes.
Failing to run eligibility checks via the User-Level API leads to "dead clicks," higher customer service volumes, and lower overall conversion rates.
3. Avoiding Content Assumptions (Gaming vs. Non-Gaming)
A common misconception among new API adopters is that only gaming-related offers will perform. While gaming is a strong vertical, RevU's expertise and data show significant success in diverse categories such as financial services and home delivery (e.g., pet food). Because API integrations bypass RevU’s native offer ranking and optimization logic, you should actively engage with your RevU Publisher Account Manager to understand which high-yielding non-gaming offers are currently trending for your specific audience.
4. Data Freshness and Polling Frequency
The All Offers API is your primary tool for ingesting inventory into your internal database. To maintain a healthy ecosystem:
Call Frequently: You must call the All Offers API frequently enough to ensure your local database stays in sync with our live inventory.
Remove Stale Offers: Failure to poll frequently results in users seeing paused or expired offers, which triggers error messages and decreases user trust in your reward platform.
5. Implementation Reminder: Device & IP Detection
When using the User-Level Offer API, it is highly recommended to call the API client-side. This allows RevU to automatically detect the user's device type and IP address. If you must call this server-side, you are responsible for passing the correct device and ip values to ensure the user is shown offers they can actually complete on their current hardware.