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#
- Відкрийте PocketHook та перейдіть до Налаштувань
- Введіть URL Сервера (має бути HTTPS)
- Введіть Токен Аутентифікації (якщо ваш сервер вимагає аутентифікації)
- Натисніть Тестувати Підключення для перевірки
4. Формат Запиту#
PocketHook надсилає повідомлення як JSON-масив:
[{
"sessionId": "uuid-v4",
"action": "sendMessage",
"chatInput": "ваше повідомлення тут"
}]
5. Формат Відповіді#
Ваш сервер повинен відповідати JSON-об’єктом:
{
"msg": "Повідомлення, що відображається користувачу",
"shortcut": "НеобовязковеІмяКоманди",
"data": { "ключ": "значення" },
"url": "https://optional-url.com"
}
| Поле | Тип | Обов’язково | Опис |
|---|---|---|---|
msg | string | Так | Текст, що відображається в чаті |
shortcut | string | Ні | iOS Shortcut для виконання |
data | object | array | Ні | Дані, що передаються в Shortcut |
url | string | Ні | 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: "Друга" }
]));