API Keys Setup Guide

Open the Facebook Developers Portal. Go to developers.facebook.com and sign in with your Facebook account.

Create a new app. Click "My Apps" → "Create App". Select the "Business" app type. Enter a name (e.g., CacheWarmer) and create the app.

Copy the App ID. After creation, you'll be redirected to the dashboard. The App ID is displayed at the top of the page.

Copy the App Secret. Navigate to Settings → Basic. Click "Show" next to "App Secret" and confirm with your password. Copy the value.

Configure in CacheWarmer. Enter the App ID and App Secret in your CacheWarmer settings. The access token is automatically composed as app_id|app_secret.

facebook:
  enabled: true
  appId: "123456789012345"
  appSecret: "abc123def456ghi789jkl012mno345pq"
  rateLimitPerSecond: 10

Understand the options. LinkedIn offers two approaches: the Marketing API (OAuth 2.0 flow) for production use, or a session-based approach for personal/development use.

Option A: LinkedIn Marketing API. Register an app at linkedin.com/developers, configure OAuth 2.0, and obtain an access token through the authorization flow.

Option B: Session-based approach. For personal use, you can extract the li_at session cookie from your browser's developer tools while logged into LinkedIn.

Set the environment variable.

LINKEDIN_SESSION_COOKIE=your_li_at_cookie_value

Generate a key. Create a 32-character hexadecimal key:

openssl rand -hex 16

Example output: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Host the key file. Create a text file at your web root with the key as both the filename and content:

# The file should be accessible at:
# https://yourdomain.com/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6.txt
#
# The file content should be the key itself:
a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Set the environment variable.

INDEXNOW_KEY=a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Create a Google Cloud project. Go to console.cloud.google.com and create a new project (or select an existing one).

Enable the Search Console API. In the API Library, search for "Google Search Console API" and enable it for your project.

Create a service account. Go to IAM & Admin > Service Accounts > Create Service Account. Download the JSON key file.

Add to Search Console. Copy the service account email (e.g., [email protected]) and add it as a user in Google Search Console with "Full" access for your property.

Set the environment variable. Point to the JSON key file:

GOOGLE_SERVICE_ACCOUNT_JSON=./config/google-service-account.json

Sign in to Bing Webmaster Tools. Go to bing.com/webmasters and sign in with your Microsoft account.

Verify your site. Add and verify ownership of your website if you haven't already.

Get your API key. Navigate to Settings > API Access > API Key. Copy the generated key.

Set the environment variable.

BING_API_KEY=your_bing_api_key_here

Open the Cloudflare Dashboard. Go to dash.cloudflare.com and select your domain.

Copy the Zone ID. On your domain overview page, find the Zone ID in the right sidebar under "API" (a 32-character hex string).

Create an API Token. Go to My Profile → API Tokens → "Create Token". Choose "Custom Token" with permissions: Zone → Cache Purge → Purge. Restrict to your specific zone.

Configure in CacheWarmer.

cloudflare:
  enabled: true
  apiToken: "YOUR_CLOUDFLARE_API_TOKEN"
  zoneId: "YOUR_ZONE_ID"

Open the Imperva Console. Go to my.imperva.com and sign in.

Get your API ID and API Key. Go to Account Settings → API Keys. If no key exists, click "Add API Key". Copy both the API ID (numeric) and API Key (alphanumeric).

Find your Site ID. Go to Websites → select your site. The Site ID is a numeric value found in the URL or under Settings → General.

Configure in CacheWarmer.

imperva:
  enabled: true
  apiId: "YOUR_IMPERVA_API_ID"
  apiKey: "YOUR_IMPERVA_API_KEY"
  siteId: "YOUR_SITE_ID"

Open Akamai Control Center. Go to control.akamai.com and sign in.

Create an API Client. Go to Identity & Access → API Clients → "Create API Client". Select the CCU APIs (Content Control Utility) with READ-WRITE access.

Copy all four credentials. After creation, immediately copy the Host, Client Token, Client Secret, and Access Token. These are only shown once.

Configure in CacheWarmer.

akamai:
  enabled: true
  host: "akaa-xxxxx.luna.akamaiapis.net"
  clientToken: "akab-xxxxx"
  clientSecret: "xxxxx="
  accessToken: "akab-xxxxx"
  network: "production"