1. Asenna PocketHook#
Lataa PocketHook App Storesta ja avaa se iPhonella, iPadilla tai Macilla.
2. Määritä palvelimesi#
PocketHook tarvitsee HTTPS-päätepisteen viestintään. Voit käyttää:
- Agent Server — Itse isännöity AI-agentti LLM:llä, työkaluilla, taustatöillä ja muistilla
- Oma API — Mikä tahansa palvelin, joka hyväksyy POST-pyynnöt ja palauttaa JSON-muotoista dataa
- n8n — Itse isännöity työnkulun automatisointi webhook-triggerillä
- OpenClaw — Itse isännöity AI-avustaja monikanavaisella viestinnällä
Palvelimen vaatimukset#
Palvelimesi täytyy:
- Hyväksyä POST-pyynnöt JSON-sisällöllä
- Palauttaa JSON-vastauksia
- Olla saavutettavissa HTTPS:n kautta (HTTP hylätään turvallisuussyistä)
- Valinnaisesti tukea Bearer token -todennusta
3. Yhdistä PocketHookissa#
- Avaa PocketHook ja siirry kohtaan Asetukset
- Syötä Palvelimen URL (täytyy olla HTTPS)
- Syötä Todennustoken (jos palvelimesi vaatii todennusta)
- Napauta Testaa yhteys vahvistaaksesi
4. Pyyntömuoto#
PocketHook lähettää viestit JSON-taulukkona:
[{
"sessionId": "uuid-v4",
"action": "sendMessage",
"chatInput": "viestisi tahan"
}]
5. Vastausmuoto#
Palvelimesi tulee vastata JSON-objektilla:
{
"msg": "Kayttajalle naytettava viesti",
"shortcut": "ValinnainenOikotieName",
"data": { "avain": "arvo" },
"url": "https://optional-url.com"
}
| Kenttä | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
msg | string | Kyllä | Chatissa näytettävä teksti |
shortcut | string | Ei | Suoritettava iOS-pikakuvake |
data | object | array | Ei | Pikakuvakkeelle välitettävä data |
url | string | Ei | Avattava tai näytettävä URL |
Monivaiheisiin automaatioihin palauta taulukko vastauksista:
[
{ "msg": "Vaihe 1...", "shortcut": "EnsimmainenOikotie" },
{ "msg": "Vaihe 2...", "shortcut": "ToinenOikotie", "data": { "input": "arvo" } }
]
6. Pika-aloitus Starter-palvelimella#
Käytä starter-palvelinmalliamme päästäksesi alkuun minuuteissa:
git clone https://github.com/pockethook-app/pockethook-server.git
cd pockethook-server
bun install
cp .env.example .env
# Muokkaa .env salaisella tokenillasi
bun dev
Starter sisältää sisäänrakennetut komennot (ping, hello, help, time) ja esimerkkejä pikakuvakkeiden käynnistämiseen. Katso API-viite täydellistä protokollamäärittelyä varten.
7. SDK:n käyttäminen#
Asenna pockethook-sdk-paketti tyyppiturvallisten vastausten rakentamiseen:
bun add pockethook-sdk
import { text, shortcut, responses, toResponse } from "pockethook-sdk";
// Yksinkertainen tekstivastaus
return toResponse(text("Hei palvelimeltani!"));
// Kaynnista Shortcut
return toResponse(shortcut("Suoritetaan...", "OmaOikotie", { avain: "arvo" }));
// Monivaiheinen automaatio
return toResponse(responses([
{ msg: "Vaihe 1", shortcut: "Ensimmainen" },
{ msg: "Vaihe 2", shortcut: "Toinen" }
]));