Ga naar inhoud

Tips & tricks voor integraties en API-sleutels

Om een integratie toegang te geven tot Yesplan, moet je een API-sleutel aanmaken. Je kan echter op verschillende manieren omgaan met integraties en deze API-sleutels. Op deze pagina vind je enkele tips.

Veiligheid§

Een API-sleutel is eigenlijk een wachtwoord voor een API:

  • Iedereen met de API-sleutel heeft toegang tot je API én tot informatie in je installatie en kan zelfs velden aanpassen als de rechten zo ingesteld zijn. Behandel de sleutel dus even omzichtig als een wachtwoord en publiceer die niet op een publieke plaats.
  • Maak geen API-sleutel aan voor een gebruiker die beheerder is.
  • Deel sleutels niet met anderen (buiten de maker van je integratie, natuurlijk).
  • Verwijder een API-sleutel als je vermoedt dat die gelekt is.
  • Denk goed na voor je een API-sleutel verwijdert: als die gebruikt wordt door een integratie, dan zal de integratie niet meer correct functioneren. Maak in dat geval meteen een nieuwe API-sleutel aan voor de integratie in kwestie en bezorg de nieuwe sleutel aan de beheerder van de integratie.

Gebruikers voor API-sleutels§

Je kan een API-sleutel aanmaken voor eender welke gebruiker van Yesplan, maar je moet dan wel onthouden dat de sleutel van een bepaalde integratie verbonden is aan een specifieke gebruiker:

  • De integratie zal geen toegang meer hebben tot Yesplan als je deze gebruiker verwijdert.
  • Je moet ervoor zorgen dat de rechten voor de gebruiker én de integratie correct ingesteld zijn.
  • Deze gebruiker mag geen beheerder gemaakt worden.

Daarom raden we aan om voor elke integratie een specifieke gebruiker aan te maken die enkel gebruikt wordt voor die integratie. Op die manier voorkom je dat de gebruiker per ongeluk verwijderd wordt of beheerder wordt, en zorg je dat de juiste rechten toegepast worden per integratie. Voer daarvoor de stappen hieronder uit.

Gebruiker aanmaken§

Maak een nieuwe gebruiker aan en wijs de juiste rechtensjablonen toe:

  • Ga naar “Systeeminstellingen” > “Gebruikers” > “Gebruikers”.
  • Klik onderaan op “Voeg gebruiker toe” en vul de velden in:

    • Gebruikersnaam: de (bedrijfs)naam van je integratie, bijv. “Website”
    • Wachtwoord: Yesplan helpt je om een sterk wachtwoord te kiezen
    • Naam: de (bedrijfs)naam van je integratie, bijv. “Website”
    • E-mail: niets invullen, aangezien deze gebruiker enkel voor de integratie gebruikt zal worden
    • Maak een gekoppelde resource aan: vink deze checkbox aan
    • Maak een gekoppeld contact aan: vink deze checkbox uit.

Tip

Aangezien deze gebruiker enkel gebruikt wordt voor de API-sleutel van de integratie, heeft het geen zin om er een contact aan te koppelen.

  • Eens de gebruiker aangemaakt is, kan je die nog verder instellen:

    • Gebruikersgroepen: optioneel
    • Hoofdgebruikersgroep: optioneel
    • Rechtensjablonen:
      • “Common” of “Algemeen”, afhankelijk van je installatie
    • Beheerder: mag niet aangevinkt zijn.

Tip

  • Je kan ook een gebruikersgroep aanmaken voor deze gebruiker of hem toewijzen aan een bestaande gebruikersgroep als je op deze manier werkt in je installatie. Dat is echter niet noodzakelijk.
  • We raden af om integraties toegang te geven via een gebruiker die beheerder is.

Rechten toewijzen§

Wijs rechten toe aan de gebruiker voor de integratie:

  • Ga naar “Systeeminstellingen” > “Gebruikers” > “Rechtensjablonen”.
  • Klik op “Toon rechten” voor het algemene sjabloon. Vaak heeft dit de naam “Algemeen” of “Common”. Het gaat hier om het sjabloon dat bepaalt welke rechten uitgedeeld worden aan gebruikersgroepen.
  • Klik onderaan op “Voeg gebruikersgroep of gebruiker toe”, kies de gebruiker die je net aangemaakt hebt (of de gebruikersgroep waar hij deel van uitmaakt), en klik op “Voeg toe”.
  • Selecteer in deze rij enkel de rechten die de integratie nodig heeft:
    • Moet de integratie bijv. evenementen kunnen ophalen maar niet wijzigen? Selecteer dan enkel “Bekijken” onder evenementen.
    • Moet de integratie bijv. resources kunnen ophalen en aanpassen? Selecteer dan “Bekijken” en “Wijzigen” onder resources.

Tip

Elke integratie heeft andere vereisten voor rechten. Overleg indien nodig met de maker van je integratie of met je Customer Success Manager van Yesplan om te achterhalen welke rechten de integratie precies nodig heeft.

Gekoppelde resources verbergen§

Bij het aanmaken van een gebruiker wordt automatisch een resource met dezelfde naam aangemaakt. Aangezien deze gebruiker enkel gebruikt wordt voor de API-sleutel van de integratie, verberg je beter de gekoppelde resource zodat die niet geboekt wordt:

  • Klik in het navigatiemenu op “Resources”.
  • Zoek via de zoekbalk de naam van de gebruiker die je net aangemaakt hebt. In ons voorbeeld was dat “Website”.
  • Klik in de zoekresultaten rechts op de juiste resource en kies “Toon info”.
  • Deselecteer in het tabblad “Rechten” alle checkboxen in de kolom voor “Bekijken”.

Opmerking

Beheerders zien altijd alle resources, zelfs als het recht “Bekijken” gedeselecteerd is voor bepaalde resources.

API-sleutel aanmaken§

Om de API te te ontsluiten moet je een API-sleutel aanmaken in Yesplan en die bezorgen aan de maker van de integratie.

  • Ga naar “Systeeminstellingen” > “Integraties” > “API-sleutels”.
  • Kies de gebruiker die je net aangemaakt hebt (bijv. “Website”) in de keuzelijst onderaan de tabel en klik op “Voeg toe”.
  • De gebruiker wordt toegevoegd aan de tabel. De waarde in de kolom “Sleutel” is de API-sleutel waarmee de integratie toegang krijgt tot de API van Yesplan.

Tip

Zie een API-sleutel aanmaken voor meer informatie.

Tabblad voor je integratie§

Je integratie zal nog steeds perfect werken als je deze stap niet uitvoert, maar we raden aan om een tabblad aan te maken voor al de customdatavelden die gebruikt worden door de integratie. Op die manier heb je in Yesplan per evenement of resource een mooi overzicht van de gegevens die gebruikt worden door een externe integratie.