Hogyan generáljunk ventic API kulcsot?

API kulcs szükséges a ventic platformmal való integrációhoz szükséges kérések hitelesítéséhez. Ezek a kulcsok egyediek az Ön szervezete számára, és biztonságos hozzáférést biztosítanak termékkatalógusához és kereskedelmi szolgáltatásaihoz.

Íme, hogyan kezelheti API kulcsát:

1. Hozzáférés a fejlesztői panelhez

Jelentkezzen be ventic fiókjába, és navigáljon a Settings > Developers szakaszhoz. Ott talál egy „API Keys” nevű fület.

2. Új kulcs létrehozása

Új kulcs generálásához:

1. Kattintson a “Create API Key” gombra.
2. Adjon a kulcsnak egy leíró nevet (pl. „Production - Main Store” vagy „Tesztelés - János”).
3. Válassza ki a jogosultságok körét (Scopes). Javasoljuk, hogy csak a szükséges jogosultságokat rendelje hozzá (a legkisebb jogosultság elve).
4. Kattintson a “Generate” gombra.

3. A kulcs biztonságos tárolása

Létrehozás után a kulcs csak egyszer jelenik meg.

• Fontos: Másolja ki a kulcsot, és tárolja biztonságos helyen (pl. jelszókezelőben vagy a rendszerében lévő biztonságos kulcstárolóban).
• Megjegyzés: Biztonsági okokból a ventic az ablak bezárása után nem mutatja meg újra a teljes kulcsot.

4. A kulcs használata a kérésekben

A ventic API felületére küldött összes kérésnek tartalmaznia kell az API kulcsot az X-API-Key HTTP fejlécben.

Példa cURL használatával:

curl -X GET "https://api.ventic.ai/v1/products" \
     -H "X-API-Key: az_on_api_kulcsa_itt" \
     -H "Accept: application/json"

5. A kulcs rotálása és visszavonása (Revocation)

Ha gyanítja, hogy kulcsa kiszivárgott, azonnal vissza kell vonnia azt.

• A vezérlőpulton válassza ki az eltávolítani kívánt kulcsot, és kattintson a “Revoke” (Visszavonás) gombra.
• A visszavonás után minden olyan kérés elutasításra kerül, amely ezt a kulcsot használja.
• Generáljon új kulcsot, és frissítse a rendszer konfigurációját.

Biztonsági ajánlások

• Soha ne tegye közzé az API kulcsokat a forráskódban (pl. a GitHubon). Használjon környezeti változókat (environment variables).
• Használjon külön kulcsokat a tesztelési (testing) és a produkciós (production) környezetekhez.
• Rendszeresen ellenőrizze az aktív kulcsok listáját, és távolítsa el azokat, amelyeket már nem használ.

Ha segítségre van szüksége az integrációhoz, vegye fel a kapcsolatot technikai csapatunkkal a support@ventic.ai címen.