Overview - Corsair

Use FinerWorks through Corsair: one client, typed API calls, local DB sync. FinerWorks signs every request with two keys: the account’s web_api_key and an app_key for the calling app (create one under Account > API in FinerWorks). Corsair stores the web API key as the tenant’s API key and the app key as the account’s app_key field; you can also pass appKey to finerworks() to use one app key for every tenant. What you get:

33 typed API operations
3 synced entities (images, orders, virtualInventoryProducts) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/finerworks

yarn add corsair @corsair-dev/finerworks

pnpm install corsair @corsair-dev/finerworks

bun add corsair @corsair-dev/finerworks

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { finerworks } from '@corsair-dev/finerworks';

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

Multi-tenancy is the default — scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

finerworks()

More: API Key

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.

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

Example API calls

List images in the inventory library

const tenant = corsair.withTenant('acme');
await tenant.finerworks.api.images.list({
	library: { name: 'inventory' },
	per_page: 20,
});

Change a product’s asking price

const tenant = corsair.withTenant('acme');
await tenant.finerworks.api.inventory.update({
	virtual_inventory: [{ sku: 'AP1556P79511', asking_price: 200 }],
});

See the full list on the API page.

Query synced data

orders.fetchStatus stores each order by order_id. images.list, images.add and images.update store images by guid, and inventory.list and inventory.update store products by sku.

const tenant = corsair.withTenant('acme');
const rows = await tenant.finerworks.db.orders.search({
	data: { order_status_label: 'In Production' },
	limit: 50,
});

Synced entities: images, orders, virtualInventoryProducts. See Database for filters and operators.

What’s next

API reference

Every finerworks.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Query synced data

​What’s next