Návod pro vývojáře

Integrace s pomocí AI

Integraci STROMCOM do vašeho systému zvládne napsat i AI asistent: Claude, ChatGPT, GitHub Copilot nebo Cursor. Aby nehádal a neopisoval zastaralé příklady z internetu, připravili jsme pro něj jeden soubor se vším, co potřebuje vědět.

Stáhnout instrukce

Jak to funguje

  1. Stáhněte soubor stromcom-ai.md a uložte ho do repozitáře svého systému, například jako docs/stromcom.md.
  2. Odkažte na něj z instrukcí asistenta: CLAUDE.md, AGENTS.md, .github/copilot-instructions.md nebo pravidla Cursoru. Případně ho asistentovi přiložte přímo do konverzace.
  3. Popište, co chcete: kde má být vlákno, kdo jsou uživatelé a z jaké entity se vlákno skládá.
  4. Asistent podle instrukcí vybere správný způsob integrace, napíše kód a projde kontrolní seznam.

Soubor obsahuje pokyny pro asistenta a je aktuální k datu stažení. Před větší úpravou integrace si stáhněte novou verzi. Stejný soubor je odkázaný i z llms.txt, takže ho najdou i asistenti, kteří čtou web sami.

Co v souboru je

  • Registrace a nastavení: kde se registrovat, jak založit projekt, kde najít klíče, jaký typ klíče kam patří a jak klíč omezit na doménu nebo IP.
  • Plány: jak zjistit, co který plán odemyká (API, embed, WebHooky, vlastní vzhled), a jak se projeví dosažení limitu. Plány se mění, proto je asistent nečte ze souboru, ale z aktuálního ceníku v JSON.
  • Ověření a bezpečnost: jak předávat identitu uživatele, proč hashovat kódy a jak ověřit podpis WebHooku.
  • Výběr cesty: kdy stačí PHP knihovna, kdy React balík, kdy ruční JavaScript, kdy embed odkaz a kdy Customer API.
  • Silné a slabé stránky balíků: co který balík stromcom/php-snippet, @stromcom/react-snippet a stromcom/customer-sdk umí. Asistent tak pozná, kdy balík nestačí a je lepší vlastní implementace.
  • Úskalí: dynamické stránky (SPA), nastavení CSP, vzhled, přílohy, stránkování zpráv, opakované pokusy u API.
  • Kontrolní seznam: jak ověřit, že integrace opravdu funguje.

Mění jen to, co má

Instrukce vedou asistenta k tomu, aby upravil jen kód potřebný pro integraci: vložení snippetu, předání uživatele, místa pro vlákna a případné volání API. Do zbytku vašeho systému nesahá, nemění jeho logiku, data ani nastavení. Pokud by integrace vyžadovala zásah jinam, asistent se nejdřív zeptá.

Co zůstává na vás

Registraci, výběr plánu a vytvoření klíčů za vás asistent neudělá. Na to se stačí zaregistrovat, založit projekt a v záložce API Klíče zkopírovat Client Key a Client Secret. Klíče předejte aplikaci přes proměnné prostředí, ne přímo do konverzace s asistentem.

Ukázka zadání pro asistenta

Podle docs/stromcom.md přidej do detailu objednávky v administraci vlákno STROMCOM.
Uživatel je přihlášený zaměstnanec (App\Security\User), objednávka je App\Entity\Order.
Klíče jsou v env STROMCOM_CLIENT_KEY a STROMCOM_CLIENT_SECRET, tajný klíč pro hash v STROMCOM_CODE_SECRET.
Do hlavního menu přidej počet nepřečtených zpráv. Nakonec projdi kontrolní seznam z §13.

Integrace krok za krokem

Stejné informace pro lidi: návod s ukázkami kódu a odpovědi na technické otázky.