SDK Relaya: с чего начать, если не хочется писать API-клиент руками

Зачем вообще брать SDK

Если задача проста, raw HTTP-запросов иногда хватает. Но как только в проекте появляются реальные профили, токены, webhook, QR-авторизация и несколько интеграций, самодельный клиент быстро начинает разрастаться бесполезным кодом.

У Relaya уже есть публичные SDK, сгенерированные из OpenAPI-контракта. Это означает две полезные вещи: у вас сразу есть типизированные модели запросов и имена методов совпадают с тем, что реально опубликовано в API.

Какие пакеты уже есть

У каждого пакета уже есть свой quickstart: Node.js, Python и PHP.

Авторизация в SDK

В autogenerated-доках SDK явно описаны две схемы авторизации: Bearer JWT и заголовок X-Profile-Token. Для большинства первых интеграций хватает Bearer-токена пользователя.

• Bearer удобен, когда вы работаете от имени аккаунта и быстро собираете первый рабочий контур.
• X-Profile-Token полезен, когда вызов должен быть жёстко привязан к одному профилю.
• Если сомневаетесь, начните с Bearer и отдельно посмотрите разбор схем авторизации.

Первое сообщение

import { IntegrationsApi, SendMessageInputBody } from "@relaya/sdk-node";
 
const api = new IntegrationsApi("https://api.relaya.ru/v1");
api.accessToken = process.env.RELAYA_API_TOKEN || "";
 
const payload: SendMessageInputBody = {
  phone: "+79991234567",
  message: "Ваш заказ #1234 готов",
  clientId: "order_1234_ready",
};
 
const { body } =
  await api.postProfilesProfileIdIntegrationsIntegrationMessages(
    "prof_abc123",
    "max",
    payload,
  );
 
console.log(body);

Как выбрать стек

Выбирайте не “самый модный” SDK, а тот, который совпадает с вашим реальным backend-слоем.

• Если основной backend на TypeScript, не тяните Python только ради одной интеграции.
• Если у вас уже живут cron-задачи и data pipelines в Python, логично оставить отправку там же.
• Если продукт на Laravel или legacy PHP, SDK для PHP сэкономит больше всего ручной работы.

Сами SDK не заменяют продуктовые решения вроде очередей, retry и idempotency. Но они убирают лишнюю низкоуровневую рутину и уменьшают риск ошибиться в базовом клиенте.

Хороший первый шаг в Relaya это не “написать свой SDK”, а взять готовый пакет и быстрее дойти до реального события: профиль подключён, сообщение ушло, статус приехал обратно.