Документация

Авторизуйтесь по bearer-токену, отправляйте JSON, получайте JSON. Версионируется и обратно совместимо.

Обзор v3

RTAPI позволяет публиковать события и доставлять их в вебхуки и подписчикам в реальном времени. Базовый URL — https://api.rt-api.tech/v3.

Быстрый старт

Три шага до первого доставленного события:

# 1. Экспортируйте ключ
export RTAPI_KEY="sk_live_xxx"

# 2. Опубликуйте событие
curl https://api.rt-api.tech/v3/events \
  -H "Authorization: Bearer $RTAPI_KEY" \
  -H "Content-Type: application/json" \
  -d {"channel":"orders","type":"order.created","data":{"id":"ord_9F2"}}

# 3. -> 202 Accepted  { "id": "evt_7Ka1", "status": "queued" }

Аутентификация

Все запросы используют bearer-токен в заголовке Authorization. Ключи привязаны к окружению и мгновенно отзываются в панели.

Authorization: Bearer sk_live_xxx

Отправка события

Отправьте POST на /v3/events с каналом, типом и JSON-данными.

// JavaScript SDK
import { RTAPI } from "@rtapi/node";
const rt = new RTAPI(process.env.RTAPI_KEY);
await rt.events.publish({ channel: "orders", type: "order.created", data: { id: "ord_9F2" } });

Вебхуки

Зарегистрируйте endpoint — и RTAPI будет слать на него все подходящие события. Проверяйте заголовок X-RTAPI-Signature своим секретом.

POST https://api.rt-api.tech/v3/webhooks
{ "url": "https://yourapp.com/hooks", "channels": ["orders"] }

Неуспешные доставки повторяются с возрастающей задержкой до 24 часов; каждая попытка видна в журнале доставки.

SDK

Официальные библиотеки: JavaScript / TypeScript, Python, Go, PHP.

Ошибки

Используются стандартные коды HTTP. Тело ошибки содержит error.code и error.message.

{ "error": { "code": "invalid_channel", "message": "Канал не найден" } }

Получить ключ