Developer Documentation

Step 1 — Sign up

Open the dashboard and create your account.

1. Enter First/Last name and Email (or choose Sign up with Google / X).
2. Create a strong password. We recommend a password manager and enabling 2FA if available.
3. Click Sign Up.

Create your account with email or SSO.

Step 2 — Confirm your email

Check your inbox for our verification message and click the link to activate your account.

• If you don’t see it, check Spam / Promotions.
• Links expire for security; request a new one if needed.

Step 3 — Trial (7 days)

New accounts start with a 7-day trial that includes 1 Flow. This lets you build and test a complete setup.

• Trial banner shows remaining days.
• When you reach your Flow limit (1/1), you can upgrade to add more.

Step 4 — Subscription & Payment

When you’re ready (or the trial ends), choose a plan and activate billing.

4.1 Choose a plan

Go to Subscription and compare plans. Starter includes 1 Flow / 10k visits/month.

4.2 Review & Subscribe

Confirm billing cycle and proceed to payment.

4.3 Payment

Send the exact amount to the address shown. We match automatically when the network confirms.

4.4 Payment history

Step 5 — Create your Flow

Go to Flows → New Flow and fill the form:

• Flow name & Purpose — internal labels for your team.
• Domain — hostname only (e.g., promo.example.com).
• White URL — where filtered/QA users go.
• Offer URL — where qualified visitors land.
• Default action — White is safest during testing.
• Integration — pick tech stack and platform (informational at creation).

Step 6 — Add Rules (Targeting & Protection)

Rules decide who reaches the Offer vs who goes to the White page (or gets blocked). Start conservative, then tighten.

6.1 Filtration toggles

• Cloaking — master smart-filtering switch; suspicious traffic goes to White (or blocked if you set Block elsewhere).
• Block IP — denylist single IPs or ranges.
• Block VPN/Proxy — filter known VPN/proxy IP space (reduces fraud; can affect some legit users).
• Block IPv6 — rarely needed; use only if your stack lacks IPv6 support.
• Block without ISP — blocks requests where ISP/ASN is missing (catches some bots).
• Block without Referrer — blocks direct/blank referrers; useful when traffic should only come from ads or partners.
• Clicks from one IP/day — rate limit repeated clicks per IP (e.g., 3).
• Clicks before filtering — grace clicks before strict filtering (handy during warm-up).

6.2 Audience targeting

• Countries — allowlist only markets you target (e.g., FR for France-only).
• Devices — Mobile / Desktop / Tablet. For app installs, select Mobile and match OS.
• Operating Systems — Android, iOS, Windows, etc.
• Browsers — Chrome, Safari, Firefox; optionally exclude fringe browsers seen in abuse.
• Languages — browser language (e.g., fr-FR).
• Time Zones — useful for day-parting or regional promos (e.g., Europe/Paris).
• Connection Type — Cellular/Corporate/Satellite. Cellular narrows to mobile networks only.

6.3 Advanced

• Referrer Filter — Allow only specific domains (safelist) or Block listed. Option to Block empty referrers. Example allowlist: google.com, facebook.com.
• UTM Filter — require parameters like gclid, utm_source; missing values send users to White/Block (per your default/other toggles).

Step 7 — Activate & Monitor

New flows start Paused. Toggle to Active, then watch Hits, Filtered, and Ratio in the flows list.

• Stats icon → insights/logs; validate routing and suspicious patterns.
• Edit rules anytime; use Pause to test safely.
• Bar shows plan Flow limit (e.g., 1/1). Upgrade to add more flows.

Step 8 — Integration (API / SDK)

Protect pages by checking visitors before rendering your offer. Typical order:

1. Server receives request to a protected route.
2. Server calls /api/v1/check-visitor with IP, UA, headers, and path.
3. Act on the decision: allow (render offer), challenge (light gate), or block/white.

<?php
// Laravel example (Server-side)
$resp = Http::withToken(env('CM_API_KEY'))
  ->post('https://api.example.com/api/v1/check-visitor', [
    'ip' => request()->ip(),
    'user_agent' => request()->userAgent(),
    'headers' => [
      'accept-language' => request()->header('accept-language'),
      'x-forwarded-for' => request()->header('x-forwarded-for'),
    ],
    'path' => request()->path(),
    'referrer' => request()->headers->get('referer'),
  ]);

$data = $resp->json();
switch ($data['decision'] ?? 'allow') {
  case 'allow':
    // render offer
    break;
  case 'challenge':
    // lightweight challenge page or fallback
    break;
  default:
    // route to White URL
}

// Client hint (optional, never rely on client-only)
(function(){
  window.cm = window.cm || {};
  cm.hints = {
    tz: Intl.DateTimeFormat().resolvedOptions().timeZone,
    lang: navigator.language,
    dpr: window.devicePixelRatio || 1
  };
})();

QA & Troubleshooting

• No traffic recorded → DNS not pointed yet, caching delay, or Flow still Paused.
• Everyone goes to White → rules too strict; relax VPN/Proxy, Referrer/UTM, or Geo/Device.
• High false positives → lower strictness; safelist known IPs/ASNs/referrers.
• Blank/403 → Default is Block with no matching rules; use White until finalized.