Skip to main content
Use these resources when asking AI coding tools to help integrate Scrip. Start with the core model, then add task-specific guides and the OpenAPI spec when the tool needs endpoint schemas.

​
Context files

  • Scrip overview: Start here if the tool only knows the product website.
  • Docs index: Use this to choose relevant docs pages.
  • Full docs: Load this when the tool supports large context files.
  • OpenAPI spec: Use this for endpoint paths, request schemas, response schemas, and error codes.
To let an AI client work with authorized account data instead of static context, connect the MCP server. It exposes Scrip as a curated set of tools and serves these docs as resources the model can pull on demand. Events are the input that drives rule evaluation, balance changes, ledger entries, webhooks, and downstream reporting. Load event context before asking an AI tool to design rules, balances, or automations. For most integration work, load these pages in order:
  1. Introduction
  2. Core concepts
  3. Authentication
  4. Quickstart
  5. Event processing
  6. API introduction
  7. OpenAPI spec

​
Workflow context

For programs and assets, load Core concepts, Programs, and Asset configuration. For participants and groups, load Core concepts, Participants, State management, and Groups. For rules and events, load Event processing, Writing rules, CEL expressions, and Rule actions. For balances and ledger behavior, load Ledger, Balance operations, and Lots and expiration. For redemptions and rewards catalog work, load Ledger, Balance operations, Redemptions, and Rewards catalog. For transfers, load Ledger, Balance operations, and Transfers. For reporting, load Ledger, Event processing, and Reporting. For automations, load Event processing, Writing rules, and Automations. For webhooks, load Event processing and Webhooks. For testing, load Quickstart, Event processing, and Testing.

​
Integration path

When an AI tool is helping build a first REST API integration, use this sequence:
  1. Set up server-side authentication.
  2. Create a program.
  3. Create and link an asset.
  4. Define a rule with a CEL condition and one or more actions.
  5. Ingest an event with an idempotency_key.
  6. Verify the participant balance and ledger entries.

​
Security constraints

Keep production credentials server-side. Do not expose them in browser code, mobile apps, public repositories, or AI prompts. Use deterministic idempotency_key values for event retries. Reusing the same key returns the same event identity without reprocessing, even if the payload differs. To correct or replace an event, send a new event with a new idempotency key.