Wat zijn API tokens en wanneer gebruik je deze?

API tokens worden gebruikt voor integraties met RentMagic.

Een token is een API sleutel (Application Programming Interface) die wordt gebruikt door computerprogramma’s die de API aanroepen van RentMagic. Hiermee is het mogelijk om het aanroepende programma, diens ontwikkelaar of diens gebruiker te identificeren. API-tokens worden gebruikt om bij te houden en te bepalen hoe de API wordt gebruikt, bijvoorbeeld om schadelijk gebruik of misbruik van RentMagic te voorkomen.

De API-token fungeert als een unieke identificatie en als een geheim token voor verificatie. Er zijn tevens een aantal toegangsrechten aan gekoppeld. Als je meer informatie nodig hebt voor integraties met RentMagic neem dan contact op met je partner.

Je kunt in deze module API-tokens beheren, zodat je volledige controle blijft houden over de integraties met RentMagic.

Open overzicht API tokens

Om het overzicht van alle API tokens binnen RentMagic te openen:

  • Navigeer in het hoofdmenu naar Instellingen > Systeem > API tokens.

Het overzicht van de API tokens wordt nu geopend.

  • Gebruik het filter om met een zoekwoord een specifieke API token te zoeken.

Nieuwe API token

Om een nieuwe API token aan te maken:

  • Vanuit het overzicht klik je in de actiebalk op Nieuw.

Het details formulier voor het aanmaken van een nieuwe API token wordt weergegeven.

  • Vul alle velden zo compleet mogelijk in. Kijk bij Veldinformatie voor meer informatie over de velden. 
  • Klik in de actiebalk op Opslaan.

Nadat de token is aangemaakt wordt automatisch een uniek nummer aangemaakt, te vinden bij het veld token. Deze kun je desgewenst communiceren met de ontwikkelaar of gebruiken voor de andere applicatie. De token is na het aanmaken ook per direct actief.

API token wijzigen

Je kunt een API token niet wijzigen. Mocht je toch een wijziging willen doorvoeren kun je het beste de API token verwijderen en een nieuwe maken.

API token verwijderen

Je kunt een token die je niet meer gebruikt verwijderen. Vanuit veiligheidsoverweging is het ook verstandig deze dan te verwijderen. Deze token vormt dan immers geen risico meer.

Let op dat je de juiste token selecteert en dat je weet wat de functionaliteit is achter de token. Het verwijderen van een token kan leiden tot het verkeerd functioneren van de applicatie. Als de token eenmaal is verwijderd, kan deze niet meer worden teruggehaald vanwege het uniek gegenereerde nummer wat gekoppeld is aan de token.

Om een API token te verwijderen:

  • Gebruik het filter om met een zoekwoord een specifieke API token te zoeken. 
  • Selecteer de API token in het overzicht.
  • Klik op Verwijderen in de actiebalk.
  • Bevestig de melding.

Veldinformatie

 

Token informatie

Algemene informatie over de token, welke daarna kan worden toegekend aan één of meerdere externe applicaties.

  • Token type
    Het type token. Dit is een vrij veld en kan je zelf bedenken en invullen. Het type is bedoeld voor de herkenbaarheid van de token in het overzicht.
  • Token id
    De unieke identificatie code van de token.

Gebruiker

Gekoppelde RentMagic gebruiker voor de token.

  • Gekoppelde gebruiker
    Door welke gebruiker de token is gedefinieerd. Dit veld wordt automatisch ingevuld door het systeem.

Toegang

Periode voor toegang van de token. Een token kan tijdelijk worden ingesteld.

  • Uitgegeven op
    De datum waarop de token is uitgegeven.
  • Vervalt op
    De datum waarop de token mag komen te vervallen. Als dit veld niet wordt ingevuld dan vervalt de token in principe nooit.