Overview

• Linguapop needs a paid plan for invitations. You can create an account and preview tests for free, but an active subscription with billing details is required to administer placement tests. Linguapop bills only completed tests.
• The key travels in the request body. Linguapop reads an apiKey field from the JSON body of invitations.create, not a header. Corsair adds it for you; it is not an input, and passing apiKey yourself is rejected. Errors thrown by this plugin never carry the key.
• Languages. languages.list returns { name, code } pairs. Pass the code (for example ita, and ger for German) as languageCode. More languages are planned, so the plugin does not restrict code to today’s five.
• No key is sent to languages.list. A live check showed Linguapop answers it without one, so the plugin does not put the key on a GET. Corsair still needs a saved key to run the call.
• Invitations are not undone. invitations.create is not documented as idempotent and has no cancel call, so it is never retried after a 5xx or a timeout. Check Linguapop before repeating a call that failed that way. externalIdentifier is your own ID for the candidate; it is not a duplicate guard.
• The returned url is the candidate’s access link. It holds the invitation token, so treat it as a secret. Set sendEmail: false to hand it to the candidate yourself.
• Results. Linguapop reports a finished test by POSTing to the callbackUrl you give. That call is unsigned and this plugin does not receive it, and the API has no call to fetch results.
• Unverified. The author had no paid account, so the live suite in api.test.ts has not run against invitations.create: the exact response shape follows the docs’ example and is untested against the real API. Only languages.list and the rejection of an unrecognised key were checked live.
• Webhooks. None are handled.

• 2 typed API operations

​

Setup

npm install corsair @corsair-dev/linguapop better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/linguapop better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/linguapop better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/linguapop better-sqlite3
bun add --dev @types/better-sqlite3

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

export const corsair = createCorsair({
	plugins: [
		linguapop(),
	],
	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!,
	},
});

linguapop()

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

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.linguapop.api.languages.list({});

const tenant = corsair.withTenant('acme');
await tenant.linguapop.api.invitations.create({
	email: 'sam.rivera@example.com',
	name: 'Sam Rivera',
	languageCode: 'ita',
	sendEmail: false,
	externalIdentifier: 'crm-lead-4812',
});

​

What’s next