@apinator/server

Node.js server SDK for Apinator.

Use this package to:

• trigger events to channels
• generate private/presence channel auth payloads
• verify webhook signatures

Installation

npm install @apinator/server

Quick Start

import { Apinator } from "@apinator/server";

const client = new Apinator({
  appId: process.env.APINATOR_APP_ID!,
  key: process.env.APINATOR_KEY!,
  secret: process.env.APINATOR_SECRET!,
  cluster: "eu", // or "us"
});

await client.trigger({
  name: "order-created",
  channel: "orders",
  data: JSON.stringify({ orderId: "ord_123" }),
});

Channel Auth (Private/Presence)

import { Apinator } from "@apinator/server";

const client = new Apinator({
  appId: process.env.APINATOR_APP_ID!,
  key: process.env.APINATOR_KEY!,
  secret: process.env.APINATOR_SECRET!,
  cluster: "eu", // or "us"
});

const channelData = JSON.stringify({
  user_id: "user-1",
  user_info: { name: "Alice" },
});

const auth = client.authenticateChannel(
  "12345.67890",
  "presence-chat",
  channelData
);

API

• trigger({ name, channel?, channels?, data, socketId? }): Promise<void>
• authenticateChannel(socketId, channelName, channelData?): { auth, channel_data? }
• getChannels(prefix?): Promise<ChannelInfo[]>
• getChannel(channelName): Promise<ChannelInfo>
• verifyWebhook(headers, body, maxAge?): boolean

See:

• API Reference
• Quickstart

License

MIT - see LICENSE.