Kaip sugeneruoti „ventic“ API raktą?
Integracijai su „ventic“ platforma reikalingas API raktas užklausoms autentifikuoti. Šie raktai yra unikalūs jūsų organizacijai ir suteikia saugią prieigą prie jūsų produktų katalogo bei prekybos paslaugų.
Štai kaip valdyti API raktus:
1. Eikite į kūrėjų skydelį (Developer Dashboard)
Prisijunkite prie savo „ventic“ paskyros ir eikite į skiltį Nustatymai > Kūrėjai (Settings > Developers). Ten rasite skirtuką „API Keys“.
2. Sugeneruokite naują raktą
Norėdami sukurti naują raktą:
- Spustelėkite mygtuką „Create API Key“.
- Suteikite raktui aprašomąjį pavadinimą (pvz., „Gamyba - pagrindinė parduotuvė“ arba „Testavimas - Jonas Jonaitis“).
- Pasirinkite teisių sritis (Scopes). Rekomenduojame raktams suteikti tik būtinas teises (mažiausių privilegijų principas).
- Spustelėkite „Generate“.
3. Saugus rakto saugojimas
Sugeneravus raktą, jis bus parodytas jums tik vieną kartą.
- Svarbu: Nukopijuokite raktą ir saugokite jį saugioje vietoje (pvz., slaptažodžių tvarkyklėje arba savo organizacijos saugioje raktų saugykloje).
- Pastaba: Saugumo sumetimais „ventic“ neberodys viso rakto uždarius langą.
4. Rakto naudojimas užklausose
Visose „ventic“ API užklausose HTTP antraštėje X-API-Key turi būti nurodytas API raktas.
cURL pavyzdys:
curl -X GET "https://api.ventic.ai/v1/products" \
-H "X-API-Key: jūsų_api_raktas_čia" \
-H "Accept: application/json"
5. Raktų atnaujinimas ir trynimas
Jei įtariate, kad raktas nutekėjo, turite jį nedelsdami anuliuoti.
- Skydelyje pasirinkite raktą, kurį norite pašalinti, ir spustelėkite „Revoke“ (Anuliuoti).
- Po anuliavimo bet kokia užklausa naudojant šį raktą bus atmesta.
- Sugeneruokite naują raktą ir atnaujinkite savo integracijos duomenis.
Geriausia saugumo praktika
- Niekada neskelbkite API raktų pradiniame kode (pvz., „GitHub“). Naudokite aplinkos kintamuosius.
- Naudokite atskirus raktus testavimo ir gamybinėms aplinkoms.
- Reguliariai peržiūrėkite aktyvių raktų sąrašą ir pašalinkite tuos, kurie nebenaudojami.
Jei reikia pagalbos integruojant, susisiekite su mūsų technine komanda adresu support@ventic.ai.