API kulcspárok kezelése

Az API lehetővé teszi, hogy a SalesAutopilot rendszert integrálja saját webes alkalmazásával vagy weboldalával.

API kulcspár létrehozása

Az API használatához szükség van egy API kulcspárra, amelyet a szoftver generál Önnek. API kulcspár generálásához kattintson a bal oldali menüben a Beállításokra (fogaskerék ikon) (1), majd a megjelenő felületen az Integráció (2) menüpontot lenyitva az API kulcsok (3) opcióra.

A megjelenő képernyőn – ha először jár itt – még nincs létrehozva egyetlen API kulcspár sem. Kulcspár létrehozásához kattintson az "API kulcs hozzáadása" gombra. Ezután megjelenik az API kulcspár a listán.

A REST API dokumentáció szerint a létrehozott felhasználónevet kell megadnia az API felhasználónévnek és a jelszót pedig az API jelszónak.

API kulcspár letiltása / engedélyezése

Lehetőség van több API kulcspár létrehozására is, amelyeket külön-külön le lehet tiltani illetve újra engedélyezni (alapértelmezetten a létrehozott API kulcs engedélyezett). Így különböző projektekben különböző API kulcspárt lehet felhasználni és ha már nincs szükség rá vagy szükség van a letiltására, akkor ezt megteheti a zöld kapcsoló gombra történő kattintással (1). Ezután a felugró ablakban erősítse meg, hogy leszeretné tiltani (2) az API kulcsot.

A letiltás után a kulcspár működése azonnal felfüggesztésre kerül. A letiltott kulcspár mellett egy piros figyelmeztető ikon jelenik meg.

Az API kulcspár újbóli engedélyezéséhez kattintson ismét a kapcsoló gombra . Engedélyezés után a kulcspár azonnal működőképes.

API kulcspárhoz megjegyzés írása

Ha nem csak egy API kulcspárt hozz létre, akkor az idő múlásával nehezen megmondható, hogy melyik kulcspárt mire használja, így javasoljuk, hogy a létrehozás során lássa el egy rövid jegyzettel az API kulcspárt a felhasználás helyével, módjával kapcsolatban.

A jegyzet hozzáadásához kattintson az API kulcshoz tartozó kék jegyzet ikonra (1), majd a felugró felületen adja meg a rövid leírást (2) és a Mentés gombra kattintva (3) véglegesítse a jegyzetet.

API kulcspár törlése

Ha van olyan API kulcspár amit már nem használ, abban az esetben van lehetősége törölni a kulcspárt. Azonban a törlés előtt javasoljuk, hogy mindenképpen gondolja át, hogy nincs-e mégis használatban valahol a kulcspár. Ha nem biztos benne, abban az esetben törlés előtt állítsa inaktívra az API kulcsot, majd pár nap elteltével, ha úgy látja, hogy nem befolyásolta a rendszere működését törölje az API kulcspárt.

A kulcspár törléséhez kattintson a piros kuka ikonra (1) majd a felugró ablakban erősítse meg a törlési szándékát (2).

Kapcsolódó bejegyzések:

• Kapcsolódás az API-hoz
• Feliratkozók kezelése