# Orishare

Loyalty, incentives, promotions and engagement infrastructure behind one REST API. Integrate once, send events, and versioned rules award points, move tiers, issue rewards, progress challenges and emit webhooks.

## Start here
- Quickstart (CLI): https://docs.orishare.com/docs/quickstart
- Agent integration guide: https://docs.orishare.com/docs/agent-guide
- OpenAPI 3.1: https://docs.orishare.com/openapi.json (also served at https://api.orishare.com/v1/openapi.json)
- Error codes: https://docs.orishare.com/errors
- Page index (JSON): https://docs.orishare.com/index.json

## Pages
- [Agent integration guide](https://docs.orishare.com/docs/agent-guide): A step-by-step plan an AI agent can follow to integrate an application without help.
- [Orishare](https://docs.orishare.com/docs): Loyalty, incentives, promotions and engagement infrastructure behind one REST API.
- [Quickstart](https://docs.orishare.com/docs/quickstart): From signup to the first evaluated event with the CLI only, in a few minutes.
- [Reference scenario](https://docs.orishare.com/docs/reference-scenario): The audiobook purchase, progress and completion rules, every edge case and its expected result.
- [AI drafting](https://docs.orishare.com/docs/concepts/ai-drafting): Describe a campaign in plain language; get validated rule documents to review, simulate and publish.
- [Configuration as code](https://docs.orishare.com/docs/concepts/config): Export an environment as one JSON document and apply it to another, atomically.
- [Events and identity](https://docs.orishare.com/docs/concepts/events): Ingestion modes, idempotency, the client-event trust contract and customer identity.
- [Programs](https://docs.orishare.com/docs/concepts/programs): Currencies and the ledger, tiers, rewards, challenges, segments and historical counters.
- [Rules](https://docs.orishare.com/docs/concepts/rules): The orishare.rule/v1 document: triggers, conditions, limits, actions, versions.
- [Webhooks](https://docs.orishare.com/docs/concepts/webhooks): Signed deliveries, retries, replay and the event catalog.
- [Account](https://docs.orishare.com/docs/api/account): Signup, tokens, invitations, memberships and ownership for people and agents.
- [Management](https://docs.orishare.com/docs/api/management): Organizations, projects, environments, API keys and usage.
- [Events](https://docs.orishare.com/docs/api/events): Ingestion (202 async, 200 sync), event definitions, retries.
- [Customers](https://docs.orishare.com/docs/api/customers): Customers, aliases, attributes and the aggregated state view.
- [Ledger](https://docs.orishare.com/docs/api/ledger): Currencies, manual adjustments, entries and balances.
- [Rules](https://docs.orishare.com/docs/api/rules): Rules, immutable versions, publish, pause, simulate.
- [Campaigns](https://docs.orishare.com/docs/api/campaigns): Schedules, priorities, stacking groups, budgets, audiences.
- [Tiers](https://docs.orishare.com/docs/api/tiers): Tier programs, levels and per-customer tiers.
- [Rewards](https://docs.orishare.com/docs/api/rewards): Rewards, issuances, redemption and cancellation.
- [Challenges](https://docs.orishare.com/docs/api/challenges): Challenges, enrollment and progress.
- [Segments](https://docs.orishare.com/docs/api/segments): Static membership and live dynamic segments.
- [Counters](https://docs.orishare.com/docs/api/counters): Historical counter definitions and backfills.
- [Webhooks](https://docs.orishare.com/docs/api/webhooks): Endpoints, signed deliveries, replay.
- [Audit](https://docs.orishare.com/docs/api/audit): Audit trail.
- [Context](https://docs.orishare.com/docs/api/context): Project context for AI drafting and the UI.
- [Config](https://docs.orishare.com/docs/api/config): Whole-environment export and atomic apply.
- [Ai](https://docs.orishare.com/docs/api/ai): AI drafting: plain-English requests become validated rule documents for review; never published by the model.
- [Support](https://docs.orishare.com/docs/api/support): Audited staff access.