Skip to main content

Developer Quickstart

Surfside provides a simple interface and API's to build state-of-the-art advertising, personalization, and monetization capabilities into any digital business. Follow this guide to learn how to render onsite ads, setup event tracking for advanced measurement and sync product data for advanced personalization and sponsored products.

Steps to Integrate with Surfside​

1. Onsite Ads Integration​

  • Purpose: At the core of Surfside’s technology is our advanced auction system, which selects winning products or creatives based on real-time bidding and predefined criteria.

  • Functionality: This integration handles bid processing and logic, ensuring that the most relevant and highest-bidding advertisements are displayed to your end users.

  • Onsite Ads Documentation

2. Event Tracking Integration​

  • Purpose: Event tracking is crucial for measuring the effectiveness of advertised products and creatives, including clicks, impressions, and purchases.

  • Functionality: Integrated event tracking offers comprehensive analytics and reporting, providing insights into ad performance, user engagement, and incremental sales

  • Event Tracking Documentation

3. Products Integration​

  • Purpose: Product integration synchronizes your vendor and product data with Surfside to identify items eligible for promotion within your marketplace.

  • Functionality: This component ensures all promotable items are accurately represented and available for auctions, seamlessly linking retailer inventory with advertising opportunities.

  • Product Documentation

  • Personalization API Documentation

4. User Acceptance Testing​

  • All required data is being sent through (Location ID, Auction Events, etc)
  • Events (wins, impressions, clicks and ecommerce events) are fired on their respective triggers.
  • Product Card and carousel config is consistent with onsite experience
  • Ad Units are correctly rendering onsite
  • Ensure Brand Advertisers are able select products when creating a campaign or adding products to an existing one.
  • Data within Digital Source and Retail Dashboard is accurate.

5. Production Deployment​

After completing the UAT, deploy to production with these 3 steps:

  • Connect your live catalog: either share the url to your product feed with Surfside or use the API.
  • Surfside will provide admin credentials and production Source keys.
  • Replace your sandbox credentials with production credentials for both Event Tracking and Onsite Ads and move integrations to production.