> ## 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.

# Trustpilot plugin

> Read Trustpilot business, service review, product review, invitation, consumer profile and Data Solutions API data.

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

Public API operations need a Trustpilot API key. Private business and invitation operations need an OAuth 2.0 access token; select oauth\_2 for these calls. With oauth\_2, public operations send the OAuth app's client id as the API key (Trustpilot's API key is the client id), or apiKey from plugin options when it is set. Trustpilot documents authorization-code and client-credentials grants, but does not publish per-operation scopes in these references.

**What you get:**

* 53 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/trustpilot 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 { trustpilot } from '@corsair-dev/trustpilot';

export const corsair = createCorsair({
	plugins: [
		trustpilot(),
	],
	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 Trustpilot API key before the first call: `pnpm corsair setup --plugin=trustpilot --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}
> trustpilot()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

> [tab] OAuth 2.0
>
> Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your Trustpilot OAuth app.
>
> ```ts theme={null}
> trustpilot({
> 	authType: 'oauth_2',
> })
> ```
>
> More: [OAuth 2.0](https://docs.corsair.dev/concepts/oauth)

**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: 'trustpilot',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**`businessUnits.allReviews`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.trustpilot.api.businessUnits.allReviews({});
```

**`invitations.link`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.trustpilot.api.invitations.link({});
```

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

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/trustpilot/api.md)
>
> Every `trustpilot.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.