Documentation

API

Kezeld a szervezeted API kulcsait a Yaplet programozott eléréséhez és külső szolgáltatásokkal való integrációhoz.

Mi az az API kulcs?

Az API kulcs egy biztonságos token, amely teljes hozzáférést biztosít a Yaplet szervezeted adataihoz és funkcióihoz. Minden API híváshoz szükséges, és biztonságosan kell tárolni.

Legfontosabb tudnivalók

  • Szervezet szintű: A szervezetednek legfeljebb 10 elnevezett kulcsa lehet, megosztva a csapatodban — mindegyik egyszerre működik
  • Egyszeri megjelenítés: A kulcs titkos értéke csak egyszer jelenik meg, a létrehozáskor — mentsd el azonnal
  • Teljes hozzáférés: Minden kulcs teljes hozzáférést biztosít a fiókod adataihoz
  • Minden csomagon: az API kulcsok az ingyenes alap részei — nem kell fizetős csomag ahhoz, hogy létrehozz egyet
Az API-hozzáférés mostantól minden csomagban benne van, az ingyenesben is. Korábban csak a Growth csomag része volt, ami azt jelentette, hogy egy Starter ügyfél, aki kulcsot igénylő modult vásárolt — partnerprogram-követés, AI közösségi posztolás, hírlevél-munkafolyamatok —, nem tudott kulcsot létrehozni. A meglévő szervezetek automatikusan megkapták a jogosultságot; nincs mit megvenni és nincs mit bekapcsolni.
Attól, hogy létre tudsz hozni kulcsot, még nem kapsz funkciókat. Minden végpont, amit egy kulcs elér, továbbra is ellenőrzi a saját jogosultságát, így egy ingyenes szervezet kulcsa pontosan azt nyitja meg, amije a szervezetnek már amúgy is megvan.

API kulcsok kezelése

Menj a Beállítások → Szervezeti beállítások → API menüpontra (a képernyő címe maga API Kulcsok). A kulcsaid egy táblázatban jelennek meg, amely mutatja minden kulcs nevét, a végződését (yAPI_… plusz a titkos érték utolsó 6 karaktere, így össze tudod vetni a konfigurációdban lévő kulccsal), és a létrehozás dátumát.

Kulcs létrehozása

  1. Kattints az „Új API Kulcs” gombra
  2. Adj a kulcsnak egy nevet, ami leírja, mire fogod használni — pl. Éles szerver (kötelező)
  3. Másold és mentsd el a titkos értéket azonnal — később nem lehet lekérni; a Yaplet csak egy lenyomatát tárolja
  4. A kulcsok yAPI_ előtaggal rendelkeznek a könnyű azonosítás érdekében
Hozz létre külön kulcsot minden integrációhoz. Így később bármelyik kulcsot törölheted anélkül, hogy a többi integráció leállna.

Kulcs törlése

A törléshez be kell gépelned a kulcs nevét megerősítésként. A kulcs azonnal megszűnik működni, és nem állítható vissza — minden, ami még használja, hibát fog kapni.

Ha kiesés nélkül szeretnél kulcsot cserélni: hozz létre egy új kulcsot, állítsd át rá az integrációdat, majd töröld a régit.

A névvel ellátott kulcsok bevezetése előtt létrehozott kulcsok neve Default API key, és a soruk csak egy sima yAPI_…-t mutat — a végződésük sosem lett eltárolva.

API kulcs használata

Add meg bármelyik API kulcsodat a Y-API-Key fejlécben minden API kérésnél:

Y-API-Key: yAPI_your_generated_key_here

API felhasználási esetek

Az API kulcsaid különböző integrációkat tesznek lehetővé, például:

  • Affiliate követés - Ajánlások és jutalékok rögzítése
  • Hírlevél feliratkozó kezelés - Névjegyek tömeges importálása és frissítése
  • E-mail automatizálás indítása - Egy e-mail automatizálás elindítása egy névjegyre programozottan
  • Egyedi integrációk - Yaplet összekapcsolása a meglévő rendszereiddel
Részletes API dokumentáció minden végponthoz elérhető a megfelelő dokumentációs oldalakon:

Ugyanezek a kulcsok kötnek be egy MCP klienst

Bármelyik kulcsod egyben az is, amivel egy MCP kliens hitelesíti magát a Yapletnél. Az API kulccsal létrehozott kapcsolat a szervezet tulajdonosaként jár el, és minden engedélyezett eszközkategóriához hozzáfér — ez a legerősebb érv azért, hogy titokban tartsd a kulcsaidat.

Biztonság

Biztonsági ajánlott eljárások:
  • Tárold a kulcsokat biztonságosan (környezeti változók, titokkezelők)
  • Soha ne commitolj kulcsokat verziókezelőbe
  • Kulcscsere esetén hozz létre egy újat, állítsd át rá az integrációdat, majd töröld a régi kulcsot
  • Korlátozd a hozzáférést a szükséges csapattagokra