Eigen app connector inrichten in vogelvlucht
Je kunt bij een nieuwe app connector direct een nieuwe gebruikersgroep, een connector-gebruiker en een token aanmaken. Hierna is de app connector klaar voor gebruik. Wel kun je in de eigenschappen van de app connector nog extra instellingen vastleggen.
Je kunt dit stappenplan o.a. gebruiken als een partner je vraagt om een app connector toe te voegen aan een omgeving. Wil je de app connector handmatig aanmaken (zonder automatisch een gebruikersgroep, connector-gebruiker en token aan te maken)? Lees dan deze beschrijving.
|
In dit artikel is gave nieuwe functionaliteit verwerkt die beschikbaar is vanaf Profit 6. We werken momenteel hard aan de documentatie van dit onderdeel. |
Je kunt je connectoren nu aanroepen op basis van Oauth 2.1. Hierbij worden de methoden Authorization code flow en Client credentials flow ondersteund. Om deze techniek te gaan gebruiken, moet je een nieuwe app connector met de juiste instellingen aanmaken.
Oude app connectoren hebben altijd het type Classic token. Bij een nieuwe app connector o.b.v. Oauth selecteer je het authenticatietype Oauth of Hybride.
App connector o.b.v. Classic token aanmaken
Je maakt de app connector aan en legt eventueel aanvullende instellingen vast. Bij deze methode genereer je een token voor elke connector-gebruiker. Vanaf Profit 6 gebruiken we hiervoor de term Classic token.
App connector aanmaken:
- Ga naar: Algemeen / Beheer / App connector.
- Klik op: Nieuw.
- Vul de omschrijving in.
Gebruik de omschrijving die bij externe gebruikers van de app bekend is. Als een gebruiker een token aanvraagt, krijgt hij namelijk een e-mailbericht met een OTP (one time password). In het onderwerp van het e-mailbericht wordt ook de omschrijving van de app connector gebruikt.
- Vanaf Profit 6 selecteer je Classic token bij het veld Authenticatieype. In Profit 5 is dit veld niet beschikbaar.
Let op:
Na het aanmaken van een app connector kun je het authenticatietype niet meer wijzigen.
- Vink het veld Automatisch token genereren aan.
- Je hebt nu de volgende keuze:
- Wil je een nieuwe gebruikersgroep en een nieuwe connector-gebruiker aanmaken?
Vink het veld Maak nieuwe gebruikersgroep op basis van App connector-naam aan.
- Wil je een bestaande gebruikersgroep gebruiken?
Vink het Gebruik bestaande gebruikersgroep aan en selecteer de gebruikersgroep. Hier na kun je bepalen of je een nieuwe gebruiker of een bestaande wilt gebruiken.
- Wil je een nieuwe gebruikersgroep en een nieuwe connector-gebruiker aanmaken?
- Selecteer de gewenste
Get- en UpdateConnectoren in de volgende stappen. - Klik op: Voltooien.
De token voor de connector-gebruiker wordt gegenereerd en getoond.
- Kopieer de token.
Let op:
Na het voltooien van de wizard kun je de token niet meer raadplegen via Profit. Als de token niet bekend is, dan moet je de oude token verwijderen en een nieuwe token toevoegen.
- Klik op Sluiten.
Na de bovenstaande stappen is de app connector in principe gereed voor gebruik. Je hebt immers een app connector met een gebruiker waarvoor een token is uitgedeeld. Wel is het nodig om de onderstaande punten uit te voeren.
Vervolgstappen:
De app connector wordt automatisch geopend.
- Op het tabblad Connectoren vind je enkele speciale connectoren. De meestgebruikte is AppConnectorSubject, deze is nodig voor het openen van bijlagen bij dossieritems.
- Kijk of je nog IP-restricities moet vastleggen.
Ga naar de Autorisatie tool en richt de filterautorisatie voor de gebruikersgroep in.
App connector o.b.v. Authorisation code flow aanmaken
|
In dit artikel is gave nieuwe functionaliteit verwerkt die beschikbaar is vanaf Profit 6. |
Je maakt een nieuwe app connector aan die de Authorisation code flow gebruikt. Dit type app connector is met name geschikt voor gebruikers van een externe applicatie die zelf via een portal inloggen en dan een access-token krijgen. De externe applicatie kan een AFAS-connector aanroepen met de access-token.
De access-token heeft een geldigheidsduur van 1 uur, de refresh-token heeft een geldigheidsduur van 30 dagen.
Als je de inrichting hebt voltooid, dan verloopt de aanroep kort samengevat als volgt:
- De externe applicatie roept de AFAS Online portal aan.
- De gebruiker meldt zich aan op deze portal.
- Als het aanmelden slaagt, dan stuurt AFAS Online een geüpdate refresh-token en een access-token terug naar de redirect-url die in de app connector is vastgelegd. De refresh-token kan namelijk maar éénmalig gebruikt worden voor het inwisselen tegen een access-token.
De beheerder kan in de AFAS Online portal eventueel een andere identity provider selecteren. Je richt de identity provider in op het tabblad Identity provider. Vervolgens ga je naar het tabblad Single sign-on en koppel je de identity provider.
App connector aanmaken:
- Ga naar: Algemeen / Beheer / App connector.
- Klik op: Nieuw.
- Vul de omschrijving in.
- Selecteer OAuth bij het veld Authenticatieype.
Let op:
Na het aanmaken van een app connector kun je het authenticatietype niet meer wijzigen.
- Selecteer de autorisatiegroep waarvan de leden de app connector mogen gebruiken om zich aan te melden via de Authorisation code flow.
- Selecteer Code bij Type OAuth flow.
- Vul de url van de externe applicatie in bij Redirect url.
- Selecteer de gewenste Get- en UpdateConnectoren in de volgende stappen.
- In het laatste scherm zie je de OAuth client id en de OAuth client secret.
Kopieer beide waarden en sla deze op een veilige plaats op.
Let op:
Na het voltooien van de wizard kun je OAuth client id nog wel raadplegen via de eigenschappen van de app connector, maar niet meer wijzigen.
De OAuth client secret kun je niet meer raadplegen EN niet meer wijzigen. Wel kun je een nieuwe OAuth client secret genereren, deze vervangt dan de oude. Als je een nieuwe OAuth client secret genereert, kan de oude niet meer gebruikt worden.
- Klik op: Voltooien.
Eigenschappen controleren:
De app connector wordt automatisch geopend.
- Op het tabblad Connectoren vind je enkele speciale connectoren. De meestgebruikte is AppConnectorSubject, deze is nodig voor het openen van bijlagen bij dossieritems.
- Kijk of je nog IP-restricities moet vastleggen.
Ga naar de Autorisatie tool en richt de filterautorisatie voor de gebruikersgroep in.
App connector o.b.v. Client credentials aanmaken
|
In dit artikel is gave nieuwe functionaliteit verwerkt die beschikbaar is vanaf Profit 6. |
Je maakt een nieuwe app connector aan die de Client credentials flow gebruikt. Dit betekent dat één connector-gebruiker zich bij de api aanmeld met de client-id en de client-secret. Hiermee kun je een refresh-token en een access-token op te halen. De refresh-token kan namelijk maar éénmalig gebruikt worden voor het inwisselen tegen een access-token.
De access-token heeft een geldigheidsduur van 1 uur, de refresh-token heeft een geldigheidsduur van 30 dagen.
App connector aanmaken:
- Ga naar: Algemeen / Beheer / App connector.
- Klik op: Nieuw.
- Vul de omschrijving in.
- Selecteer OAuth bij het veld Authenticatieype.
Let op:
Na het aanmaken van een app connector kun je het authenticatietype niet meer wijzigen.
- Selecteer de autorisatiegroep waarvan de leden de app connector mogen gebruiken om zich aan te melden via de Authorisation code flow.
- Selecteer Client credentials bij Type OAuth flow.
- Je selecteert de gebruiker die zich mag aanmelden bij de api.
- Selecteer de gewenste Get- en UpdateConnectoren in de volgende stappen.
- In het laatste scherm zie je de OAuth client id en de OAuth client secret.
Kopieer beide waarden en sla deze op een veilige plaats op.
Let op:
Na het voltooien van de wizard kun je OAuth client id nog wel raadplegen via de eigenschappen van de app connector, maar niet meer wijzigen.
De OAuth client secret kun je niet meer raadplegen EN niet meer wijzigen. Wel kun je een nieuwe OAuth client secret genereren, deze vervangt dan de oude. Als je een nieuwe OAuth client secret genereert, kan de oude niet meer gebruikt worden.
- Klik op: Voltooien.
Eigenschappen controleren:
De app connector wordt automatisch geopend.
- Op het tabblad Connectoren vind je enkele speciale connectoren. De meestgebruikte is AppConnectorSubject, deze is nodig voor het openen van bijlagen bij dossieritems.
- Kijk of je nog IP-restricities moet vastleggen.
Ga naar de Autorisatie tool en richt de filterautorisatie voor de gebruikersgroep in.
Combinatie van Authorisation code flow en Authorisation Client credentials aanmaken
|
In dit artikel is gave nieuwe functionaliteit verwerkt die beschikbaar is vanaf Profit 6. |
Je maakt een app connector aan die de methoden Authorisation code flow en Authorisation Client credentials ondersteunt. Aanmelden kan op de volgende manieren:
- Gebruikers van een externe applicatie melden aan op basis van de Authorisation code flow.
- Eén gebruiker kan zich aanmelden via de methode Client credentials (dus aanmelden met client-id en client-secret). In de eigenschappen van de app connector vind je deze gebruiker op het tabblad Algemeen.
App connector aanmaken:
Lees de toelichtingen op deze pagina. Bij het aanmaken van de app connector gebruik je de volgende instellingen:
- Authenticatietype: OAuth
- Type OAuth flow: Beide
Combinatie van Classic token, Authorisation code flow en Authorisation Client credentials aanmaken
|
In dit artikel is gave nieuwe functionaliteit verwerkt die beschikbaar is vanaf Profit 6. |
Je maakt een app connector aan die zowel Classic token, Authorisation code flow en Client credentials ondersteunt. Aanmelden kan op de volgende manieren:
- Gebruikers van een externe applicatie melden aan op basis van de Authorisation code flow. Dit is mogelijk voor alle leden van de gebruikersgroep die aan de app connector gekoppeld is.
- Gebruikers van een externe applicatie melden aan op basis van een Classic token. Dit is mogelijk voor alle leden van de gebruikersgroep die aan de app connector gekoppeld is EN die een classic token hebben.
- Eén gebruiker kan zich aanmelden via de methode Client credentials (dus aanmelden met client-id en client-secret). In de eigenschappen van de app connector vind je deze gebruiker op het tabblad Algemeen.
App connector aanmaken:
Lees de toelichting bij Authorisation code flow als Authorisation client flow op deze pagina. Bij het aanmaken van de app connector gebruik je de volgende instellingen:
- Authenticatietype: Hybride
- Type OAuth flow: Beide
Filterautorisatie instellen voor het ophalen van gegevens
De GetConnectoren die je de app connector gaat opnemen, kunnen alleen records ophalen voor zover dit is toegestaan op basis van de filterautorisatie. Wil je bijvoorbeeld medewerkergegevens ophalen via een app connector, dan moet dit zijn toegestaan op basis van filterautorisatie op medewerker.
Autoriseer de gebruikersgroep NIET voor functies (menu-items), tabbladen en acties. Het is immers niet de bedoeling dat via deze gebruikersgroep in Profit gewerkt wordt.
Filterautorisatie uitdelen:
- Ga naar het tabblad: Onderhoud groepen.
- Selecteer de gebruikersgroep. Als je automatisch een gebruikersgroep hebt aan laten maken, dan heeft deze dezelfde naam als de naam van de app connector.
- Ga naar het tabblad: Autorisatie.
- Deel rechten uit op de juiste filters.
Zie ook:
|
Direct naar |