@nexbasira/node
Server-side TypeScript-SDK. Täcker varje resurs i det publika API:et med typade request- + response-former, hjälpfunktioner för cursor-paginering och en webhook-signaturverifierare som körs i konstant tid.
Installera
npm install @nexbasira/node Kräver Node 18+. Både ESM + CommonJS stöds.
Initiera
import { NexBasira } from "@nexbasira/node";
const nb = new NexBasira({
apiKey: process.env.NB_PUBLIC_KEY!, // nb_pub_*
apiSecret: process.env.NB_SECRET_KEY!, // nb_sec_*
// baseURL: "https://app.nexbasira.com/api/v1/public", // default
// timeout: 30_000, // default
}); Resurser
Varje resurs i det publika API:et har en typad klient på cvp-instansen:
nb.sessions // create / list / retrieve / end / invite
nb.evidence // list / retrieve / signed download URL
nb.whiteboards // list per session
nb.webhooks // register / rotate-secret / test-fire / constructEvent
nb.branding // read-only
nb.org // read-only Vanliga mönster
Skapa + bjud in
const session = await nb.sessions.create({
notes: "Vehicle damage claim CL-2026-0042",
scheduled_for: "2026-05-23T10:00:00Z",
locale: "fr",
});
const invite = await nb.sessions.invite(session.id, {
recipient_email: "alex@policyholder.com",
send_email: true,
});
console.log(invite.url); // shown ONCE Async-iterator-paginering
List-endpoints returnerar en async-iterator som paginerar transparent. Slut på "kom ihåg att skicka cursor från föregående svar":
for await (const session of nb.sessions.list({ limit: 50 })) {
console.log(session.id, session.status);
}
// Or a single page if you want pagination control:
const page = await nb.sessions.listPage({ limit: 25 });
// page.data, page.has_more, page.next_cursor Idempotent POST
Skicka en idempotencyKey för att göra en skrivning säker att göra om:
const session = await nb.sessions.create(
{ notes: "..." },
{ idempotencyKey: crypto.randomUUID() },
); Backenden cachar svaret per (key, credential) i 24 timmar. En omförsökt POST med samma nyckel returnerar det ursprungliga svaret utan att återskapa resursen.
Verifiera en webhook
import express from "express";
import { NexBasira, InvalidSignatureError } from "@nexbasira/node";
const app = express();
const nb = new NexBasira({ apiKey: "...", apiSecret: "..." });
// IMPORTANT: use express.raw() — constructEvent needs the untouched
// bytes the signature was computed over.
app.post("/nb-webhook", express.raw({ type: "application/json" }), (req, res) => {
try {
const event = nb.webhooks.constructEvent(
req.body,
req.header("NB-Signature")!,
process.env.NB_WEBHOOK_SECRET!,
);
// event.type is type-narrowed; event.data is the resource shape
switch (event.type) {
case "session.completed":
return onCompleted(event.data, res);
case "audit.anchored":
return onAnchored(event.data, res);
}
res.status(204).end();
} catch (err) {
if (err instanceof InvalidSignatureError) {
return res.status(401).send("bad signature");
}
throw err;
}
}); Typade fel
SDK:n kastar en liten hierarki av typade fel så att du kan hantera varje klass medvetet:
| Klass | När |
|---|---|
AuthenticationError | 401 — felaktiga uppgifter eller saknad nyckel |
PermissionError | 403 — uppgiften saknar scopet |
NotFoundError | 404 — resursen finns inte eller är inte i din org |
RateLimitError | 429 — nådde strypningen. Har retryAfterMs |
InvalidSignatureError | Endast från constructEvent() — felaktig / saknad / utgången signatur |
NexBasiraError | Basklass — fånga denna för "vilket SDK-fel som helst" |
try {
await nb.sessions.create({ ... });
} catch (err) {
if (err instanceof RateLimitError) {
await sleep(err.retryAfterMs);
return retry();
}
if (err instanceof NexBasiraError) {
log.warn({ status: err.status, code: err.code }, "cvp error");
}
throw err;
} OpenAPI-typer
SDK:n levereras med openapi-typescript-genererade request- + response-typer under @nexbasira/node/types. Importera dem direkt om du vill ha starkt typade handlers uppströms om SDK-anropet:
import type { Session, Evidence, WebhookEvent } from "@nexbasira/node/types";
function onSessionCompleted(session: Session) {
// ...
}