Get started

# Web
npm install ./vendor/contentflow-sdk-2.4.1.tgz

# React: the same archive. React 17+ comes from your app; import from @contentflow/sdk/react.
npm install ./vendor/contentflow-sdk-2.4.1.tgz

# React Native and Expo: the same archive, plus storage. react-native-sse is optional (live updates instead of polling).
npm install ./vendor/contentflow-sdk-2.4.1.tgz @react-native-async-storage/async-storage react-native-sse
# React Native 0.72 to 0.78 need one Metro setting; 0.79+ and Expo SDK 53+ need none. See the React Native and Expo guide.

// iOS 15+, macOS 12+. Extract contentflow-sdk-swift-2.4.1.zip without changing its layout.
// Xcode: File → Add Package Dependencies → Add Local, and pick the extracted folder. Or in Package.swift:
dependencies: [.package(path: "../Vendor/contentflow-sdk-swift-2.4.1")],
targets: [.target(name: "App", dependencies: [.product(name: "ContentFlow", package: "contentflow-sdk-swift-2.4.1")])]

// minSdk 24, JVM 17. Extract contentflow-sdk-kotlin-2.4.1.zip; it is included as a composite build.
// settings.gradle.kts
includeBuild("vendor/contentflow-sdk-kotlin")
// app/build.gradle.kts
dependencies { implementation("click.contentflow:compose") }   // or :android without Compose

# Dart 3.5+, Flutter 3.16+. Extract contentflow-sdk-flutter-2.4.1.zip, then in pubspec.yaml:
dependencies:
  contentflow_sdk:
    path: vendor/contentflow-sdk-flutter

import { createCFClient } from '@contentflow/sdk/web';

const cf = createCFClient({ publicKey: CONTENTFLOW_SDK_KEY, locale: 'ar' });
await cf.start();                               // cached paint, sync, strings, live updates

await cf.setUserId(currentUser.id);             // after sign-in; skip for anonymous visitors
await cf.setConsent(userAcceptedAnalytics);     // the person's actual choice

const banner = cf.getBlock('home_banner');
if (banner) {
  showBanner(banner.get('title'), banner.imageUrl);
  cf.trackImpression(banner);                   // once it is actually visible
}

import { useEffect } from 'react';
import { CFProvider, useCF, useCFBlock } from '@contentflow/sdk/react';

export function App({ userId, analyticsConsent }: { userId?: string; analyticsConsent: boolean }) {
  return (
    <CFProvider config={{ publicKey: CONTENTFLOW_SDK_KEY, locale: 'ar' }}>
      <SessionSync userId={userId} analyticsConsent={analyticsConsent} />
      <Home />
    </CFProvider>
  );
}

function SessionSync({ userId, analyticsConsent }: { userId?: string; analyticsConsent: boolean }) {
  const cf = useCF();
  useEffect(() => { if (userId) void cf.setUserId(userId); }, [cf, userId]);
  useEffect(() => { void cf.setConsent(analyticsConsent); }, [cf, analyticsConsent]);
  return null;
}

function Home() {
  const banner = useCFBlock('home_banner');     // re-renders on live updates, tracks one impression
  return banner ? <Banner title={String(banner.get('title') ?? '')} /> : null;
}

import EventSource from 'react-native-sse';
import { CFProvider, CFBanner } from '@contentflow/sdk/react-native';

// Identify and set consent exactly as in the React tab (SessionSync), imported from react-native.
export function App() {
  return (
    <CFProvider config={{ publicKey: CONTENTFLOW_SDK_KEY, locale: 'ar' }} eventSource={EventSource}>
      <CFBanner blockKey="home_banner" render={(block) => <Banner title={String(block.get('title') ?? '')} />} />
    </CFProvider>
  );
}

import ContentFlow

let client = ContentFlow.start(configuration: ContentFlowConfiguration(
    apiKey: AppConfig.contentFlowKey,
    tenantId: AppConfig.contentFlowWorkspace,
    locale: Locale(identifier: "ar")
))

_ = try await client.identify(userId: currentUser.id)                                   // after sign-in
try await client.setAnalyticsConsent(userAcceptedAnalytics ? .granted : .denied)       // the person's actual choice

if let banner = try await client.fetchBlock(key: "home_banner") {
    let title = try banner.value(for: FieldKey<String>.text("#title"))
    showBanner(title)
    _ = try await client.trackEngagement(.impression(banner))                           // once it is actually visible
}

import click.contentflow.ConsentStatus
import click.contentflow.ContentFlow
import click.contentflow.FieldKeys

// Application.onCreate
ContentFlow.start(this, apiKey = BuildConfig.CONTENTFLOW_KEY)    // your publishable key (test environment in debug builds)

// After sign-in and from your consent UI, inside a coroutine
val client = ContentFlow.client
client.identify(userId = currentUser.id)
client.setAnalyticsConsent(ConsentStatus.of(userAcceptedAnalytics))   // the person's actual choice

client.fetchBlock("home_banner")?.let { banner ->
    showBanner(banner.value(FieldKeys.text("#title")))
    client.trackEngagement(type = "impression", blockKey = banner.key, instanceId = banner.instanceId)
}

import 'package:contentflow_sdk/contentflow_sdk.dart';

final cf = await ContentFlow.create(ContentFlowConfig(
  publicKey: const String.fromEnvironment('CONTENTFLOW_KEY'),   // your publishable key, test environment while developing
  locale: 'ar',
));

await cf.identify(userId: currentUser.id);    // after sign-in
await cf.setConsent(userAcceptedAnalytics);   // the person's actual choice

await cf.sync();
final banner = cf.getBlock('home_banner');
if (banner != null) {
  showBanner(banner.title);
  await cf.trackEngagement(type: CFEventType.impression, blockKey: banner.key);   // once it is actually visible
}

B=https://api.contentflow.click/sdk/v1

# 1. Content is a read: the key alone, no device id, nothing stored.
curl "$B/sync" -H "X-CF-Key: $CF_SDK_KEY"

# 2. Record the person's actual analytics choice for this install (one stable id you persist).
#    Identify either way, so a refusal is recorded too. Never hard-code true.
CF_CONSENT=$(yourConsentChoice)   # "true" only if they agreed, otherwise "false"
curl -X POST "$B/identify" -H "X-CF-Key: $CF_SDK_KEY" -H "X-CF-Device: $CF_DEVICE" \
  -H 'Content-Type: application/json' -d "{\"deviceId\":\"$CF_DEVICE\",\"consent\":$CF_CONSENT}"

# 3. Only the event is gated on consent. It answers 202 even when refused, so read
#    "accepted" and "dropReasons" (device_not_identified, consent_not_granted), not the envelope.
if [ "$CF_CONSENT" = true ]; then
  curl -s -X POST "$B/events" -H "X-CF-Key: $CF_SDK_KEY" -H "X-CF-Device: $CF_DEVICE" \
    -H 'Content-Type: application/json' -d '{"events":[{"type":"impression","blockKey":"home_banner"}]}' \
    | jq '.data | {accepted, dropped, dropReasons}'
fi