Перейти к основному содержимому
  1. Документация/

Руководство по Настройке

1. Установка PocketHook
#

Скачайте PocketHook из App Store и откройте его на iPhone, iPad или Mac.

2. Настройка Вашего Сервера
#

PocketHook нуждается в HTTPS-эндпоинте для связи. Вы можете использовать:

  • Сервер Agent — Самостоятельно размещаемый AI-агент с LLM, инструментами, фоновыми задачами и памятью
  • Собственный API — Любой сервер, принимающий POST-запросы и возвращающий JSON
  • n8n — Самостоятельно размещаемая автоматизация рабочих процессов с webhook-триггером
  • OpenClaw — Самостоятельно размещаемый AI-ассистент с многоканальными сообщениями

Требования к Серверу
#

Ваш сервер должен:

  • Принимать POST-запросы с JSON-телом
  • Возвращать JSON-ответы
  • Быть доступным через HTTPS (HTTP отклоняется из соображений безопасности)
  • Опционально поддерживать аутентификацию Bearer token

3. Подключение в PocketHook
#

  1. Откройте PocketHook и перейдите в Настройки
  2. Введите URL Сервера (должен быть HTTPS)
  3. Введите Токен Аутентификации (если ваш сервер требует аутентификации)
  4. Нажмите Тестировать Подключение для проверки

Экран настроек PocketHook

4. Формат Запроса
#

PocketHook отправляет сообщения в виде JSON-массива:

[{
  "sessionId": "uuid-v4",
  "action": "sendMessage",
  "chatInput": "ваше сообщение здесь"
}]

5. Формат Ответа
#

Ваш сервер должен ответить JSON-объектом:

{
  "msg": "Сообщение, отображаемое пользователю",
  "shortcut": "НеобязательноеИмяКоманды",
  "data": { "ключ": "значение" },
  "url": "https://optional-url.com"
}
ПолеТипОбязательноОписание
msgstringДаТекст, отображаемый в чате
shortcutstringНетiOS Shortcut для выполнения
dataobject | arrayНетДанные, передаваемые в Shortcut
urlstringНетURL для открытия или отображения

Для многошаговых автоматизаций верните массив ответов:

[
  { "msg": "Шаг 1...", "shortcut": "ПерваяКоманда" },
  { "msg": "Шаг 2...", "shortcut": "ВтораяКоманда", "data": { "input": "значение" } }
]

6. Быстрый Старт с Сервером Starter
#

Используйте наш шаблон сервера starter, чтобы начать за считанные минуты:

git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# Отредактируйте .env с вашим секретным токеном
bun dev

Starter включает встроенные команды (ping, hello, help, time) и примеры запуска Shortcuts. Смотрите Справочник API для полной спецификации протокола.

7. Использование SDK
#

Установите пакет pockethook-sdk для создания типобезопасных ответов:

bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";

// Простой текстовый ответ
return toResponse(text("Привет с моего сервера!"));

// Запуск Shortcut
return toResponse(shortcut("Выполняется...", "МояКоманда", { ключ: "значение" }));

// Многошаговая автоматизация
return toResponse(responses([
  { msg: "Шаг 1", shortcut: "Первая" },
  { msg: "Шаг 2", shortcut: "Вторая" }
]));