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

# Simla.com plugin

> Access and manage customers, orders, catalogs, loyalty, deliveries, tickets, telephony and other resources through the current Simla.com REST API v5.

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

Connect with an API key and the account subdomain (`acme` for `https://acme.simla.com`; the full URL works too). Requests use `X-API-KEY` and `https://{subdomain}.simla.com/api/v5/`. POST nested values are JSON strings inside form-urlencoded bodies. Responses are checked for structure only, because live data differs from the published models (string ids, lists where the model has an object).

List operations pass through the documented `page`/`limit` pagination metadata; cursor-based operations accept their documented cursor parameter. The account is limited to 10 requests per second per IP (40 for telephony); the provider may respond with 503 when the limit is exceeded.

Binary upload expects base64 in `body`; binary download responses are `{ kind: 'binary', contentType, base64 }` and the client enforces a 20 MiB safety limit.

The plugin excludes the 27 provider-hosted integration-module callback/configuration routes, the `update-scopes` route (it mints a new API key) and all inbound webhook receiving/management (outside issue #2408).

**What you get:**

* 229 typed API operations

## Setup

**1. Install**

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		simlacom(),
	],
	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 Simla.com API key before the first call: `pnpm corsair setup --plugin=simlacom --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).
>
> Each connection stores its API key and account subdomain (acme for [https://acme.simla.com](https://acme.simla.com)). Set `subdomain` here only to override the stored one.
>
> ```ts theme={null}
> simlacom()
> ```
>
> 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: 'simlacom',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Read the available Simla.com API versions**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.simlacom.api.api.apiVersions.get({});
```

**Create a customer record**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.simlacom.api.customers.create.post({});
```

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

## What's next

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