Private Integraties: Alles wat je moet weten

Wat zijn Private Integraties?

Met Private Integraties kun je krachtige custom integraties bouwen tussen jouw account en elke andere third party app.

Als je jouw account wilt integreren met een third party app, heb je twee opties:

1. Zoek en installeer een relevante app vanuit de App Marketplace
2. Bouw je eigen private integratie zelf of met hulp van een ontwikkelaar door gebruik te maken van API's.

Private Integraties helpt je om optie 2 veilig te realiseren.

De belangrijkste voordelen van Private Integraties zijn:

• Eenvoudig: Genereer Private Integratie tokens vanuit je accountinstellingen en beheer ze met gemak.
• Veilig: Je kunt de scopes/permissies beperken waartoe een ontwikkelaar toegang heeft tot jouw account

Wat is het verschil tussen Private Integraties en API Keys?

Private Integraties zijn simpel gezegd een krachtiger én veiliger alternatief voor API Keys.

Wat is het verschil tussen Private Integraties en OAuth2 Access Tokens?

Private Integraties zijn simpel gezegd statische/vaste OAuth2 Access Tokens.

Hoe gebruik ik Private Integraties?

Private Integratie tokens worden gebruikt in de Authorisation header, net als andere Access Tokens.

Je kunt bijvoorbeeld GET Contact gebruiken met de Private Integratie Token in de Authorisation header.

curl --request GET \\
  --url <https://services.leadconnectorhq.com/contacts/ocQHyuzHvysMo5N5VsXc> \\
  --header 'Accept: application/json' \\
  --header 'Authorization: <YOUR PRIVATE INTEGRATION TOKEN>' \\
  --header 'Version: 2021-07-28'

Generiek

Hoe gebruik ik Private Integraties?

Wie kan Private Integraties aanmaken?

Standaard kunnen alle account admins Private Integraties aanmaken en beheren.

Je kunt deze permissie echter beperken op gebruikersniveau. Ga hiervoor naar Instellingen > Mijn Personeel > Bewerk de specifieke account admin > Rollen & Permissies, en schakel Private Integraties in of uit voor de admin.

Waar vind ik Private Integraties?

Om Private Integraties te beheren, ga je naar Instellingen en scroll je naar beneden naar de sectie 'Overige Instellingen' in het linker navigatiemenu.

Hoe maak ik een nieuwe Private Integratie aan?

Stap 1: Klik op "Nieuwe Integratie aanmaken"

Stap 2: Geef je Private Integratie een naam en beschrijving om jou en je team te helpen identificeren waarvoor deze bedoeld is.

Stap 3: Selecteer de scopes/permissies waartoe je wilt dat de private integratie toegang heeft tot jouw account. Zorg ervoor dat je alleen de vereiste scopes selecteert voor betere gegevensbeveiliging.

Stap 4: Kopieer de gegenereerde token en deel deze met je third-party app ontwikkelaar.

Zorg ervoor dat je de token alleen deelt met vertrouwde partijen. Deel deze niet publiekelijk.

Let op: Vergeet niet om de gegenereerde token te kopiëren, want je kunt dit later niet meer doen.

Wat zijn best practices om de beveiliging van mijn private integratie token te onderhouden?

We raden aan om je Private Integratie tokens elke 90 dagen te roteren.

Zo doe je dat.

Stap 1: Navigeer naar Private Integraties onder instellingen, en klik op de Private Integratie die je hebt aangemaakt.

Stap 2: Klik op "Roteer en laat deze token later verlopen".

Stap 3: Klik op "Doorgaan" als reactie op de waarschuwing als je zeker weet dat je door wilt gaan met rotatie.

Stap 4: Kopieer de nieuwe token en werk deze bij in je third-party app. Je hebt een periode van 7 dagen waarin zowel de oude als de nieuwe token blijven werken. Na 7 dagen verloopt de oude token. In deze periode van 7 dagen heb je de optie om:

1. "Rotatie annuleren" als bijvoorbeeld je ontwikkelaar meer tijd nodig heeft om de token bij te werken in de third-party app.
2. "Nu laten verlopen", als bijvoorbeeld de third party app is bijgewerkt met de nieuwe token.

Let op: Vergeet niet om de gegenereerde token te kopiëren, want je kunt dit later niet meer doen.

Mijn token is gecompromitteerd? Wat moet ik doen?

Stap 1: Navigeer naar Private Integraties onder instellingen, en klik op de Private Integratie die je hebt aangemaakt.

Stap 2: Klik op "Roteer en laat deze token nu verlopen".

Stap 3: Klik op "Doorgaan" als reactie op de waarschuwing als je zeker weet dat je door wilt gaan met rotatie.

Stap 4: Kopieer de nieuwe token en werk deze bij in je third-party app.

Let op: Vergeet niet om de gegenereerde token te kopiëren, want je kunt dit later niet meer doen.

Kan ik de Private Integratie permissies aanpassen zonder de token bij te werken?

Ja, je kunt de naam, beschrijving en scopes/permissies van de Private Integratie op elk moment aanpassen nadat je deze hebt aangemaakt.

Zo doe je dat.

Stap 1: Navigeer naar Private Integraties onder instellingen en selecteer "Bewerken" in het drie-punten menu.

Stap 2: Werk indien nodig de naam en beschrijving van de Private Integratie bij. Klik op "Volgende".

Stap 3: Werk indien nodig de scopes/permissies bij waartoe je wilt dat de private integratie toegang heeft tot jouw account. Zorg ervoor dat je alleen de vereiste scopes selecteert voor betere gegevensbeveiliging. Klik op "Bijwerken" om de wijzigingen op te slaan.

Let op: Het bijwerken van de Private Integratie details genereert geen nieuwe token. De bestaande token blijft werken.

Hoe verwijder ik de Private Integratie als ik hem niet meer nodig heb?

Je kunt de Private Integratie verwijderen zodra je de third-party app niet meer gebruikt.

Navigeer hiervoor naar Private Integraties onder instellingen en selecteer "Verwijderen" in het drie-punten menu.