Orishare
Loyalty, incentives, promotions and engagement infrastructure behind one REST API.
Orishare is API-first. You integrate once by sending customer events; deterministic, versioned rules award points, move tiers, issue rewards, progress challenges and emit webhooks. Non-engineers edit the same rules in the web app, and AI can draft them, but every runtime decision is made by the rule engine from the published version.
How it fits together
- Environments hold everything: a project has a
sandboxand aproductionenvironment with separate keys and data. Secret keys (osk_…) are bound to one environment; personal access tokens (opat_…) manage organizations and name an environment withX-Orishare-Environment. - Events are the only input.
POST /v1/eventsstores the event and returns202, or evaluates inline withmode: syncand returns the effects and a trace. - Rules are JSON documents (
orishare.rule/v1) with a trigger, conditions, limits and actions. Publishing creates an immutable version; the next event uses it. - Programs sit on top: currencies and the ledger, tier programs, rewards, challenges, campaigns, segments and historical counters.
- Webhooks deliver signed events for everything that changed.
Machine-readable entry points
| What | Where |
|---|---|
| OpenAPI 3.1 | /openapi.json here, or https://api.orishare.com/v1/openapi.json |
| Error codes | /errors (every doc_url in an error body points here) |
| Page index for agents | /llms.txt and /index.json |
| CLI | orishare --help; every command accepts --json |
Start with the quickstart or, if you are an agent, the integration guide.