B2see Public API
  • Overview
  • Advertising API
    • /GetMedia
      • Test UI
      • Webhook
    • /GetMediaByDealer
    • /GetMediaByGroup
  • Batch Data API
  • Change Log
  • Glossary
Powered by GitBook
On this page
  • Purpose
  • Available Media Files
  • Which Endpoint?

Was this helpful?

Advertising API

PreviousOverviewNext/GetMedia

Last updated 2 years ago

Was this helpful?

Purpose

Typically the Advertising API will be used by website agencies and classified portals to retrieve images and videos for displaying on a Vehicle Search Results and Detail web pages.

Available Media Files

Subject to individual account configurations, available for each vehicle are,

  • Up to 50 jpg image URLs per vehicle

  • 1 mp4 video as

    • Video URL

    • Video embed HTML

    • YouTube embed URL

    • YouTube watch URL

    • YouTube embed HTML

Which Endpoint?

Very Important to choose the right endpoint for your use case.

Use this endpoint if you want to retrieve media for a single vehicle at a time.

Best for incremental updates

Use this endpoint if you want to retrieve all media for a single Dealer at a time.

Use this endpoint if you want to retrieve all media for all locations for a Dealer Group at a time.

If there isn't a 1:1 relationship between locations in B2see and your system then this endpoint is best suited.

If you would prefer the extra security of checking for by Dealer use /GetMediaByDealer or /GetMedia

👍
👍
👎