> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Pointagram plugin

> Gamification platform for scoring teams and players, running competitions and leaderboards, and running a reward store.

Use **Pointagram** through Corsair: one client, typed API calls.

Pointagram authenticates every call with two headers, and the plugin sends both for you: `Api-Key` is the integration key, and `Api-User` is the Pointagram login (email address) the key belongs to. Add a Custom Integration under Settings, Integrations, click Create Credentials, then Show Key; the key is a password, so keep it out of code. Both values are read from the account, never from plugin options; `test.credentials` confirms the pair without touching tenant data.

Things to know before you score anything:

* **Adding points.** `scoreSeries.addPoints` is how work done elsewhere becomes points. Supply one player identifier (`player_id`, `player_name`, `player_email` or `player_external_id`), one target (`scoreseries_id` or `scoreseries_name`, not both) and an amount (`points` or a `pointtype_name` the series defines). The plugin rejects a call that breaks any of those rules before it is sent.
* **Retry safety.** Pass `source_score_id` when the caller may retry, such as an order id: Pointagram treats a second call with the same value as a revision, revoking the earlier transaction instead of scoring twice.
* **Tags.** Score tags are sent as the JSON string inside the body that Pointagram parses, so pass `tags: [{ name: 'North' }]` and the plugin encodes it.
* **Paging.** `players.list` and `scoreSeries.history` return `pagination.next_offset`; pass it back as `offset`. The page size defaults to 50 and stops at 1000.
* **Reward store.** Every store route needs a `profileid`; a purchase also spends the player's currency, so it is marked destructive. Revoking an order is final because the docs do not say the currency comes back.
* **A rejected key looks like a missing page.** Pointagram answers a wrong key with HTTP 404 and `Invalid Credentials`, not a 401. The plugin tells the two apart, so a bad key is reported as an auth failure.
* **Webhooks.** The plugin does not receive webhooks, because Pointagram sends none.

**What you get:**

* 28 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/pointagram better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/pointagram better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/pointagram better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/pointagram better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { pointagram } from '@corsair-dev/pointagram';

export const corsair = createCorsair({
	plugins: [
		pointagram(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Pointagram API key before the first call: `pnpm corsair setup --plugin=pointagram --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> pointagram()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'pointagram',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List your competitions**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pointagram.api.competitions.list({});
```

**Score a deal for a player**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.pointagram.api.scoreSeries.addPoints({
	player_email: 'harry@pointagram.com',
	scoreseries_name: 'Points',
	points: 120,
	comment: 'Closed the Northwind deal',
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/pointagram/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/pointagram/api.md)
>
> Every `pointagram.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.