Hoe genereer ik een ventic API-sleutel?

Integratie met het ventic-platform vereist een API-sleutel om verzoeken te authenticeren. Deze sleutels zijn uniek voor uw organisatie en bieden veilige toegang tot uw productcatalogus en commerciële diensten.

Hier leest u hoe u uw API-sleutels beheert.

1. Ga naar het Developer Dashboard

Log in op uw ventic-account en navigeer naar de sectie Settings > Developers. Daar vindt u het tabblad "API Keys".

2. Een nieuwe sleutel genereren

Om een nieuwe sleutel aan te maken:

1. Klik op de knop "Create API Key".
2. Geef de sleutel een beschrijvende naam (bijv. "Productie - Hoofdwinkel" of "Testen - Jan Jansen").
3. Kies de machtigingen (Scopes). We raden aan om sleutels alleen de noodzakelijke machtigingen te geven (principe van de minste machtigingen).
4. Klik op "Generate".

3. Veilig opslaan van de sleutel

Zodra de sleutel is gegenereerd, krijgt u deze slechts één keer te zien.

• Belangrijk: Kopieer de sleutel en sla deze op een veilige plek op (bijv. in een wachtwoordbeheerder of een beveiligde key vault in uw infrastructuur).
• Let op: Uit veiligheidsoverwegingen toont ventic de volledige sleutel niet meer nadat het venster is gesloten.

4. Gebruik van de sleutel in verzoeken

Alle verzoeken naar de ventic API moeten de API-sleutel bevatten in de HTTP-header X-API-Key.

Voorbeeld van gebruik met cURL:

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

5. Sleutelrotatie en wissen

Als u vermoedt dat een sleutel is uitgelekt, moet u deze onmiddellijk ongeldig maken.

• Selecteer in het dashboard de sleutel die u wilt verwijderen en klik op "Revoke".
• Na intrekking wordt elk verzoek dat deze sleutel gebruikt, geweigerd.
• Genereer een nieuwe sleutel en werk uw configuratie bij.

Best practices voor beveiliging

• Publiceer API-sleutels nooit in de broncode (bijv. op GitHub). Gebruik omgevingsvariabelen.
• Gebruik afzonderlijke sleutels voor test- en productieomgevingen.
• Controleer regelmatig de lijst met actieve sleutels en verwijder de sleutels die niet meer nodig zijn.

Als u hulp nodig heeft bij de integratie, neem dan contact op met ons technische team via support@ventic.ai.