Miten luon ventic-rajapinta-avaimen (API key)?
Integrointi ventic-alustaan vaatii API-avaimen pyyntöjen todentamiseen. Nämä avaimet ovat organisaatiollesi yksilöllisiä ja tarjoavat turvallisen pääsyn tuoteluetteloosi ja kaupankäyntipalveluihisi.
Näin hallitset API-avaimia.
1. Siirry kehittäjähallintaan (Developer Dashboard)
Kirjaudu sisään ventic-tilillesi ja siirry kohtaan Asetukset > Kehittäjät (Settings > Developers). Sieltä löydät välilehden "API Keys".
2. Luo uusi avain
Luo uusi avain seuraavasti:
- Klikkaa painiketta "Create API Key".
- Anna avaimelle kuvaava nimi (esim. "Tuotanto - Pääkauppa" tai "Testaus - Matti Meikäläinen").
- Valitse käyttöoikeudet (Scopes). Suosittelemme antamaan avaimille vain tarvittavat oikeudet (vähimpien oikeuksien periaate).
- Klikkaa "Generate".
3. Avaimen turvallinen säilytys
Kun avain on luotu, se näytetään sinulle vain kerran.
- Tärkeää: Kopioi avain ja säilytä se turvallisessa paikassa (esim. salasanan hallintatyökalussa tai organisaatiosi turvallisessa key vaultissa).
- Huomaa: Turvallisuussyistä ventic ei näytä koko avainta uudelleen ikkunan sulkemisen jälkeen.
4. Avaimen käyttö pyynnöissä
Kaikkien ventic-rajapintaan tehtävien pyyntöjen on sisällettävä API-avain HTTP-otsikossa X-API-Key.
Esimerkki cURL-kutsusta:
curl -X GET "https://api.ventic.ai/v1/products" \
-H "X-API-Key: oma_api_avaimesi_tähän" \
-H "Accept: application/json"
5. Avainten uusiminen ja poistaminen
Jos epäilet, että avain on paljastunut ulkopuolisille, se on mitätöitävä välittömästi.
- Valitse hallintapaneelista poistettava avain ja klikkaa "Revoke" (Mitätöi).
- Mitätöinnin jälkeen kaikki kyseisellä avaimella tehdyt pyynnöt hylätään.
- Luo uusi avain ja päivitä integraatiosi tiedot.
Parhaat turvakäytännöt
- Älä koskaan julkaise API-avaimia lähdekoodissa (esim. GitHubissa). Käytä ympäristömuuttujia.
- Käytä erillisiä avaimia testaus- ja tuotantoympäristöissä.
- Tarkista säännöllisesti aktiivisten avainten luettelo ja poista ne, joita ei enää tarvita.
Jos tarvitset apua integraatioon liittyen, ota yhteyttä tekniseen tukeemme osoitteessa support@ventic.ai.