Jortt API: Authenticatie

Voordat je gegevens kunt uitwisselen via de jortt API, moet je jouw software toegang geven tot je jortt-administratie. Dit proces heet authenticatie.

Authenticatie zorgt ervoor dat jortt weet welke applicatie gegevens opvraagt of wijzigt en voor welke administratie dit mag gebeuren.

Wil je niet zelf een koppeling maken? Dan kun je kiezen voor een standaardoplossing via bijvoorbeeld Webwinkelfacturen. Zij bieden kant-en-klare koppelingen aan die direct werken met jortt. Voor het gebruik betaal je kosten aan hen.

Via de jortt API kun je verschillende processen automatiseren. In dit artikel lees je hoe authenticatie werkt en welke mogelijkheden er zijn.

Wil je zelf of samen met een ontwikkelaar aan de slag? Bekijk de volledige documentatie: developer.jortt.nl.

Wanneer heb je authenticatie nodig?

.

Authenticatie is nodig voor iedere koppeling die gegevens wil lezen of schrijven in jortt. Bijvoorbeeld wanneer je:

  • klanten wilt aanmaken in jortt;
  • facturen wilt aanmaken vanuit je webshop;
  • boekingen automatisch wil verwerken;
  • gegevens wil ophalen uit je administratie;
  • een eigen applicatie wil koppelen aan jortt.

Zonder authenticatie kan een koppeling geen gegevens uitwisselen met jortt.

Welke soorten koppelingen zijn er?

.

Jortt ondersteunt twee manieren om een koppeling te authenticeren.

Authorization Code Flow

Gebruik deze methode wanneer meerdere jortt-gebruikers jouw koppeling kunnen gebruiken.

Iedere gebruiker geeft zelf toestemming aan de koppeling. Daardoor kan dezelfde applicatie worden gebruikt door meerdere administraties.

Client Credentials Flow

Gebruik deze methode wanneer de koppeling alleen toegang nodig heeft tot één administratie.

De koppeling krijgt rechtstreeks toegang tot die administratie. Er is geen toestemmingsscherm nodig voor andere jortt-gebruikers.

Toestemming geven aan een koppeling

.

Wanneer een koppeling toegang nodig heeft tot jouw administratie, vraagt jortt eerst om toestemming. Je logt in bij jortt en ziet welke rechten de applicatie aanvraagt. Daarna bepaal je zelf of je deze toegang wilt geven.

Pas na jouw toestemming kan de applicatie gegevens lezen of schrijven in jouw administratie. Dit zorgt ervoor dat je controle houdt over welke software toegang heeft tot jouw gegevens.

Welke rechten geef je aan een koppeling?

.

Een koppeling krijgt alleen toegang tot de onderdelen waarvoor toestemming is gegeven. Voorbeelden van rechten zijn:

  • facturen lezen;
  • facturen aanmaken;
  • klanten lezen;
  • klanten aanmaken;
  • boekingen lezen;
  • boekingen aanmaken.

Een ontwikkelaar bepaalt vooraf welke rechten nodig zijn voor de koppeling. Tijdens het autoriseren wordt hiervoor toestemming gevraagd.

Client ID en Client Secret

.

Voor iedere koppeling zijn identificatiegegevens nodig. Na registratie van een applicatie ontvangt een ontwikkelaar een:

  • Client ID
  • Client Secret

Met deze gegevens kan de koppeling zich identificeren bij jortt en toegang aanvragen.

Access token

.

Nadat een koppeling succesvol is geauthenticeerd, ontvangt deze een access token. Met dit access token kan de koppeling gegevens lezen of wijzigen binnen de toegestane rechten. De koppeling gebruikt dit token bij ieder verzoek aan de jortt API.

Een applicatie registreren

.

Wil je een eigen koppeling bouwen? Dan moet de applicatie eerst worden geregistreerd. Stuur hiervoor een e-mail naar support@jortt.nl.

Bij het registreren van een applicatie geef je onder andere aan:

  • de naam van de applicatie;
  • hoe gebruikers de applicatie kunnen gebruiken;
  • welke rechten de applicatie nodig heeft.

Na registratie ontvangt de ontwikkelaar de gegevens die nodig zijn om de koppeling in te richten.

Resultaat

Na het instellen van authenticatie kan jouw software veilig gegevens uitwisselen met jortt. Daarmee leg je de basis voor koppelingen met klanten, facturen, boekingen en andere onderdelen van je administratie.

De content is door Jortt met de grootst mogelijke zorg samengesteld, doch, aanvaardt Jortt geen aansprakelijkheid ten aanzien van mogelijke onjuistheden van het getoonde. Lees de volledige disclaimer.