App connector inrichten voor public client (Profit 9)

In dit artikel is gave nieuwe functionaliteit verwerkt die beschikbaar is vanaf Profit 9.

Je maakt een app connector aan voor een public client. Dit is een client waarop geen geheim wordt opgeslagen, omdat dit door een kwaadwillende achterhaald kan worden. Een public client is altijd gebaseerd op de Authorization code flow.

Inhoud

  • Beschrijving
  • Technische informatie en endpoints
  • App connector aanmaken
  • Vervolgstappen
Beschrijving

Voorbeelden van een public client:

  • Single-page application (SPA) die volledig in de browser draait.
  • Mobiele app
  • Desktopapplicatie of commandline-tool die op de computer van de gebruiker wordt geïnstalleerd.

Een public client heeft geen client secret en voert dus geen client authenticatie uit. In plaats daarvan zorgen deze technieken voor de beveiliging. Deze technieken zijn verplicht bij een public client.

  • De gebruiker logt zelf in bij Profit op basis van de Authorization code flow in combinatie met PKCE. Dit voorkomt dat een onderschepte authorization code door iemand anders kan worden ingewisseld.
  • De tokenbeveiliging is altijd op basis van DPoP.

    DPoP (Demonstrating Proof of Possession) koppelt een token aan een sleutelpaar dat deze applicatie zelf aanmaakt. Bij elke aanroep stuurt de applicatie een ondertekend bewijs mee dat zij de bijbehorende private sleutel bezit. Profit accepteert het token alleen samen met een geldig bewijs, waardoor een onderschept token niet in een andere applicatie of op een ander apparaat werkt.

Technische informatie en endpoints

Verwijs je koppelpartner of de ontwikkelaar van je applicatie naar de API Docs voor een overzicht van de endpoints, codevoorbeelden, etc.

Een access-token is 1 uur geldig. Hierna ververst de applicatie de token met de refresh_token-grant. AFAS gebruikt roterende refresh_tokens: bij iedere vernieuwing krijg je een nieuwe refresh-token en de oude vervalt.

De maker van de externe applicatie heeft de volgende informatie nodig. Bij test- en accept-omgevingen moet je de url uiteraard nog aanpassen.

  • Token endpoint:

    https://<omgevingsnummer>.rest.afas.online/profitrestservices/oauth/token

    Bijvoorbeeld:

    https://12345.rest.afas.online/profitrestservices/oauth/token

  • Authorize endpoint:

    https://<omgevingsnummer>.rest.afas.online/profitrestservices/oauth/authorize

    Bijvoorbeeld:

    https://12345.rest.afas.online/profitrestservices/oauth/authorize

App connector aanmaken
  1. Ga naar: Algemeen / Beheer / App connector.
  2. Klik op: Nieuw.
  3. Vul de omschrijving in.
  4. Selecteer OAuth bij het veld Type authenticatie.
  5. Selecteer Mobiele en desktopapplicatie of Single-page-application (SPA) bij het veld Type applicatie.

    Let op:

    Door de bovenstaande keuzen maak je een app connector van het type Public client aan. DPOP wordt hierbij verplicht ingeschakeld. Dit kun je achteraf niet meer wijzigen.

  6. Selecteer de autorisatiegroep waarvan de leden de app connector mogen gebruiken.
  7. Vul de url van de externe applicatie in bij Redirect url.

    De url van de externe applicatie moet overeenkomen met de Redirect url in Profit. Na het voltooien kun je extra redirect urls toevoegen in de eigenschappen van de app connector.

  8. Klik op: Voltooien.
  9. De eigenschappen van de app connector worden geopend. Je kunt de OAuth client id kopiëren.

    Let op:

    Je kunt de OAuth client id wel raadplegen via de eigenschappen van de app connector, maar niet wijzigen.

Vervolgstappen

Voer deze stappen uit na het aanmaken van een app connector.

Instellingen van de app connector volledig maken:

  • Selecteer de Get- en UpdateConnectoren die via de app connector mogen worden aangeroepen.

    Koppel de gewenste GetConnectoren aan de app connector. Met een GetConnector kan een externe applicatie gegevens ophalen uit Profit. Alleen de gekoppelde GetConnectoren kunnen in combinatie met deze app connector worden aangeroepen door een externe applicatie.

    Het koppelen kan op twee manieren:

    • Handmatig. Klik op Nieuw. Vink de gewenste GetConnectoren aan en klik op Voltooien om deze te koppelen.
    • Via een import. Klik op Acties / Importeren en importeer de GetConnectoren, bijvoorbeeld GetConnectoren die je eerder van een partner gekregen hebt.

    Koppel de gewenste UpdateConnectoren aan de app connector. Met een UpdateConnector kan een externe applicatie gegevens aanmaken, wijzigen of verwijderen in Profit. Alleen de gekoppelde UpdateConnectoren kunnen in combinatie met deze app connector worden aangeroepen door een externe applicatie.

  • 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.

Filterautorisatie uitdelen voor GetConnectoren:

De GetConnectoren die je via de app connector gaat aanroepen, 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.

Let op:

Richt dit altijd in voordat een app connector op een productieomgeving (of een kopie hiervan) in gebruik wordt genomen. Als er geen filterautorisatie is ingesteld, kan een koppeling via een GetConnector namelijk alle records ophalen, bijvoorbeeld alle medewerkers en hun gegevens.

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.

  1. Ga naar: Algemeen / Beheer / App connector.
  2. Op het tabblad Algemeen zie je de gebruikersgroep waarvoor je de filterautorisatie moet instellen.
  3. Ga naar het tabblad: GetConnectoren.
  4. In de eigenschappen van een app connector zie je per GetConnector welke filterautorisatie je kunt toepassen. Dit is nieuw in Profit 9

  5. Ga naar: Algemeen / Beheer / Autorisatie tool.
  6. Ga naar het tabblad: Onderhoud groepen.
  7. Selecteer de gebruikersgroep die aan de app connector gekoppeld is.
  8. Ga naar het tabblad: Autorisatie.
  9. Deel rechten uit op de juiste filters.

Zie ook:

  • Autorisatiefilters toevoegen
  • Gegevensfilter activeren