Your API key

Create a project's API key on the Modern Web card, send it in the X-Rankfender-Key header, and replace it safely.

The content API knows which project you are asking about from its API key. Each project has its own key, created on the project's "Modern Web Integration" card. The key only reads that project's published articles.

Create the key

  1. Open the card

    Settings › Integrations, then "Connect" (or "Configure") on "Modern Web Integration". Stay on the "PULL (API)" tab.

  2. Click "Generate API Key"

    The key appears with a "Copy" button. It starts with rfk_ followed by 64 letters and digits.

  3. Click "Test Connection"

    "Connection successful! API key is valid and working." confirms it.

Send it with every request

Put the key in the X-Rankfender-Key header. There is no other way to pass it.

curl "https://odbowhcyfpzsifyibsdu.supabase.co/functions/v1/public-article-api?limit=1" \
  -H "X-Rankfender-Key: rfk_your_key"
AnswerMeaning
401 "API key required. Pass via X-Rankfender-Key header."The header is missing.
401 "Invalid API key"The key does not match any project, for example after it was replaced.

Replace a key

Click "Generate API Key" again. The new key replaces the old one at once: every site still using the old key gets "Invalid API key" until you update it.

Important

Anyone with the key can read the project's published articles. Keep it on your server, in an environment variable, and call the API from server-side code rather than from the browser.

Account Settings › "API Keys" shows "API key management coming soon": keys are managed per project, as above. Next: Content API reference.