API reference

Public endpoints for integrating BannerFlex with your own frontend (React, React Native, or custom). No authentication required—use your Banner ID and Campaign ID from the dashboard.

Base URL

All requests use your BannerFlex API base URL. Default:

https://www.bannerflex.app

Requests are CORS-enabled for browser and mobile clients.

Endpoints

GET/api/public/should-show
Check whether to show a banner for this campaign (schedule + geolocation). Call before displaying the banner.
GET/api/public/campaign-config
Get campaign runtime config: show/hide decision plus campaign content fields (e.g. seasonal copy or image URLs).
POST/api/public/banner-events
Send impression, click, or custom metric events. Use for analytics and A/B reporting.

IDs from the dashboard

Create a banner and campaign in the BannerFlex dashboard. Copy the Banner ID and Campaign ID (e.g. bnrflx-xxxxxxxx) into your code. Use the campaign's Test link to preview with ?campaign= and optional ?country= and ?date=.