Skip to main content
Version: 3.x

Integrate the Eligibility API with AI

Copy the prompt below into your AI assistant — Claude, ChatGPT, Cursor, Codex, or whatever you use. It points the agent at our full, always-current Eligibility API reference, so it works from the real documentation instead of guessing.

Copy this prompt into your AI assistant
I'm integrating TapResearch into my app using the Eligibility API. Read the full reference documentation at https://supply-docs.tapresearch.com/llms-eligibility-api.txt first — it's the current, authoritative source — then help me implement it step by step, matching my project's existing structure and conventions. Follow the best-practices and testing guidance in the docs, and call out common mistakes as we go. If something isn't covered in the docs, tell me instead of guessing. Use placeholders like API_TOKEN for any credentials — don't ask me to paste real tokens or keys into this chat, and keep server-side keys out of client code and version control. Show me where to add my API token and placement tag from the TapResearch dashboard. When the integration is in place, help me write and run a smoke test for each step and debug anything that fails — I'll confirm each step is passing in the TapResearch dashboard.

Your agent reads the live docs bundle, so it always has the current integration steps — no stale copy, nothing to keep in sync.

Open in ClaudeOpen in ChatGPT

Using a terminal or IDE agent (Claude Code, Cursor, Codex)? The Add to AGENTS.md line drops into your repo so the agent picks it up automatically. No web access in your agent? Open the full docs bundle and paste it in directly.

Your agent can implement the server-side eligibility check, the hand-off link, and your postback handler for you. Review what it writes, and reach for the rest of these docs whenever you want the details yourself.

After you integrate: verify it's working​

Run through these checks with help from your AI agent — it can write and run them and debug failures, but it can't see your account. So the API Implementation checklist on your app's Integration tab in the Publisher Dashboard is what confirms each step actually passed.

Use a real test session

These checks register from real activity — a test postback on its own won't complete them. Add a test device first (More menu → Test devices).

  1. API request received — Make your first authenticated eligibility request while your app is in test mode.
  2. Reward callback configured — Set your server-to-server postback URL.
  3. Enter survey wall from app — For a test user with has_offer: true, send the user to the returned offer_url.
  4. Generate test survey complete — Complete a test survey.
  5. Reward redeemed for test user — Confirm your endpoint receives the signed postback, validates sig, and credits the reward.

If a step doesn't check off, it's the fastest signal of where the integration broke. When every step is done, use Go Live on the same tab. For deeper testing guidance, see Testing.