Az API-kulccsal egy másik program (például a KapuSegéd, egy könyvelőprogram vagy egy saját irodai rendszer) gépi úton éri el a PmtSegédben tárolt ügyfeleidet és adataikat. A kulcsokat az API-kulcsok oldalon hozod létre, nevezed el és törlöd. Egy kulcs addig érvényes, amíg nem törlöd.
Új API-kulcs létrehozása
- A bal oldali menü Beállítások csoportjában kattints az API-kulcsok pontra.
- Kattints az Új API-kulcs gombra.
- Írd be a Megnevezés mezőbe, mire használod a kulcsot, például „KapuSegéd" vagy „könyvelőprogram". Így később is tudni fogod, melyik kulcs melyik rendszerhez tartozik.
- Kattints a Létrehozás gombra.
- Megjelenik a kulcs. Kattints a Másolás gombra, vagy jelöld ki és másold ki kézzel.
- Illeszd be a kulcsot abba a programba, amelyiket össze szeretnéd kapcsolni a PmtSegéddel.
- Kattints a Kész gombra.
Fontos: a kulcsot csak most, a létrehozáskor látod. Az ablak bezárása után nem lehet újra megnézni. Ha elveszted, hozz létre egy újat, és a régit töröld.
Az API-kulcsok listája
Az API-kulcsok oldalon a létrehozott kulcsaid táblázatban látszanak:
- Megnevezés: a létrehozáskor megadott név.
- Utoljára használva: mikor használta utoljára egy program a kulcsot. Ha még soha, a „Még nem használták" felirat áll itt.
- Létrehozva: a létrehozás ideje.
Az Utoljára használva oszlopból láthatod, hogy egy összekapcsolt rendszer valóban használja-e a kulcsot.
API-kulcs törlése
- Az API-kulcsok oldalon kattints a kulcs sorának végén a kuka ikonra.
- A Törlöd az API-kulcsot? ablakban kattints a Törlés gombra.
A kulcsot használó rendszer azonnal elveszti a hozzáférést. Ha a kulcsot például a KapuSegédben használtad, ott a szinkron ezután nem működik, amíg új kulcsot nem adsz meg.
Mire figyelj?
- A kulcs a te nevedben működik: ugyanazokat az ügyfeleket és adatokat látja és módosíthatja, mint te a felületen. Ezért úgy kezeld, mint egy jelszót, és ne küldd el senkinek, akinek nincs rá szüksége.
- A kulcsra ugyanazok az előfizetési szabályok vonatkoznak, mint rád: aktív előfizetés vagy próbaidő nélkül az ügyféladatokat nem éri el, és a csomagodban nem szereplő funkciókat sem használhatja.
- Minden összekapcsolt rendszerhez külön kulcsot érdemes létrehozni. Így ha egyet le kell tiltanod, a többi tovább működik.
Gyakori kérdések
Hány API-kulcsot hozhatok létre? Annyit, amennyire szükséged van. Mindegyik külön törölhető.
Lejár egy API-kulcs? Nem, addig érvényes, amíg nem törlöd.
Hol találom a fejlesztőknek szóló leírást? Az API-kulcsok oldal tetején az API-leírás gombra kattintva, ami új lapon nyitja meg a pmtseged.hu/api-leiras oldalt. Itt minden végpont, mező és hibakód le van írva.
Elfelejtettem kimásolni a kulcsot. Mit tegyek? Hozz létre egy új kulcsot, és másold ki azonnal. A régit töröld a listából, ha már nem használod.