Firmreader Docs Online logo

JavaScript

Узнайте, как установить и использовать JavaScript SDK Firmreader в Node 18+ и современных браузерах с полной поддержкой TypeScript из коробки.

JavaScript SDK работает в Node 18+ и современных браузерах. Он включает типы TypeScript из коробки.

Установка

npm install @firmreader/sdk

Инициализация клиента

import { Firmreader } from "@firmreader/sdk";

const client = new Firmreader({
  apiKey: process.env.FIRMREADER_API_KEY, // fr_live_...
});

Создание публикации

const post = await client.posts.create({
  channelId: "ch_company_news",
  title: "Welcome to Firmreader",
  body: "We're excited to announce our new internal communications platform.",
  priority: "normal",
});

console.log(`Published post ${post.id}`);

Получение списка публикаций

const { data: posts } = await client.posts.list({
  channelId: "ch_company_news",
  limit: 20,
});

for (const post of posts) {
  console.log(post.title);
}

Обработка ошибок

Клиент выбрасывает FirmreaderError для ответов с кодами, отличными от 2xx. Проверяйте status и code, чтобы выбрать дальнейшее действие в зависимости от ошибки.

import { FirmreaderError } from "@firmreader/sdk";

try {
  await client.posts.create({ channelId: "ch_invalid", title: "Hi", body: "..." });
} catch (err) {
  if (err instanceof FirmreaderError) {
    console.error(`${err.status}: ${err.code}`);
  }
}

Все методы записи являются идемпотентными, если передать параметр idempotencyKey, поэтому повторные попытки не создадут дубликаты публикаций.

Last updated on