SDK и примеры

Официальные SDK

Для серверной разработки доступны SDK для PHP, JavaScript/TypeScript и Python. Все клиенты используют Runtime API по адресу https://chat.wokey.pro/_keychat и умеют проверять подписи webhook по исходному raw body. Полная документация платформы доступна по ссылке ниже.

• Документация платформы ботов

PHP 8.1+

Пакет keychat/bots опубликован в Packagist. Выполняйте установку внутри проекта с composer.json; для нового проекта сначала запустите composer init.

• keychat/bots в Packagist
• Исходный код PHP SDK

composer init --name=your-name/your-bot --no-interaction
composer require keychat/bots

JavaScript / TypeScript — Node.js 18+

До публикации пакета в npm установите SDK напрямую из GitHub. Библиотека предназначена для серверного кода; токен бота нельзя помещать в браузер.

• Исходный код JavaScript/TypeScript SDK

npm install github:mikhailrepka/keychat-bots-js

Python 3.10+

До публикации пакета в PyPI установите SDK напрямую из GitHub.

• Исходный код Python SDK

python -m pip install git+https://github.com/mikhailrepka/keychat-bots-python.git

@echo_bot

Системный тестовый бот возвращает полученные сообщения и помогает проверить установку, webhook pipeline и отображение контента. Он не заменяет тесты подписи и повторной доставки.

Минимальный production checklist

1. Секреты не попадают в клиент и логи.
2. Подпись проверяется по raw body.
3. События дедуплицируются.
4. Обработка вынесена в очередь.
5. Отправка использует idempotency_key.
6. 429 и 5xx повторяются с backoff.

Практика с SDK

SDK отвечают за авторизацию, сериализацию, загрузку медиа и проверку webhook. Бизнес-состояние, очередь, дедупликация и политика повторов остаются ответственностью приложения.

Закрепляйте совместимую версию зависимости и обновляйте её отдельно от приложения после прохождения интеграционных тестов.

import { KeyChatBot } from '@keychat/bots';

const bot = new KeyChatBot(process.env.KEYCHAT_BOT_TOKEN!);