App connector tokens geautomatiseerd toekennen/intrekken

Bij een app connector vindt authenticatie plaats op basis van tokens, niet op basis van gebruikersnamen en wachtwoorden. Een token is een sleutel die geldt voor een combinatie van omgeving/app connector/gebruiker/device.

Inhoud

Beschrijving

Als een gebruiker een externe app in gebruik neemt, vraagt hij eerst een token aan via de externe app. Je moet hiervoor zelf een geautomatiseerd proces opzetten. Het is wel mogelijk om op ad-hoc basis handmatig tokens toe te voegen bij een app connector. Als een bepaalde token niet meer gebruikt mag worden, verwijder je deze.

Het geautomatiseerde proces verloopt als volgt:

  • De gebruiker vraagt via de app een token aan. Hierbij stuurt de app de api-key van de Profit-omgeving en de app connector mee.
  • Profit controleert of de gebruiker lid is van de gebruikersgroep die aan de app connector gekoppeld is. Zo ja, dan stuurt Profit een e-mailbericht met een eenmalig wachtwoord naar de gebruiker.
  • De gebruiker rondt het proces af door met het eenmalige wachtwoord (OTP) een token aan te vragen.
  • Profit verifieert het wachtwoord en stuurt de token terug naar de externe app.

    App_Cnr Eigen App connector Gebruikerstokens beheren (Beschr)

Als een gebruiker een app connector kan benaderen via verschillende apparaten, heeft hij bij de app connector voor elk apparaat een gebruikerstoken. Je kunt alle gebruikerstokens verwijderen als de gebruiker geen toegang meer mag hebben. Als je alleen een specifieke device wilt blokkeren, verwijder je alleen de corresponderende token. Je maakt onderscheid tussen de verschillende gebruikerstokens van een gebruiker door per gebruikerstoken een andere (unieke) omschrijving in te vullen.

Voorbeeld:

Een gebruiker gebruikt een app connector via een iPhone en een iPad. Hij heeft dus twee gebruikerstokens.

De gebruiker geeft aan je door dat hij zijn iPad verloren heeft. Daarom verwijder je de gebruikerstoken van de iPad bij de app connector. Hij heeft nog wel toegang via zijn iPhone.

Je kunt de gebruikerstoken niet raadplegen via Profit. Als een gebruiker bijvoorbeeld zijn huidige apparaat vervangt door een nieuw apparaat, moet hij een nieuwe gebruikerstoken aanvragen.

Gebruiker vraagt activatiecode aan

Een gebruiker vraagt een token aan via een externe applicatie. Deze applicatie roept de Profit webservices aan. Bij een geslaagde aanvraag krijgt de gebruiker een e-mailbericht met een activatiecode. De activatiecode is een eenmalig te gebruiken wachtwoord (one time password). Hiermee kan via de webservice een token worden toegevoegd.

Als je connectoren test via een Testomgeving, dan is de e-mailserver standaard niet ingericht. Hierdoor zal Profit geen e-mailberichten versturen. Richt daarom de E-mailnstellingen opnieuw in.

Let op:

Hierdoor wordt het versturen van uitgaande e-mail vanuit de testomgeving mogelijk, inclusief e-mailberichten die automatisch verstuurd worden. Controleer eerst of dit gewenst is.

Je kunt dit proces alleen gebruiken als bij de gebruiker een geldig e-mailadres ingevuld is in Algemeen / Beheer / Autorisatie tool. De gebruiker moet lid zijn van de gebruikersgroep die gekoppeld is in de eigenschappen van de app connector, tabblad Algemeen.

Let op:

Je vindt alle URL's voor connectoren op de centrale pagina URL's van WebServices.

URL:

<endpoint>/profitservices/tokenconnector.asmx

Api-steutel en omgevingssleutel opvragen:

  1. Ga naar: Algemeen / Beheer / App connector.
  2. Open de eigenschappen van de app connector.
  3. Je hebt de velden API-sleutel en Omgevingssleutel nodig.

Aanroep:

Profit Connector voor het genereren van een activatiecode (one time password) bij een app connector.

Xml-voorbeeld-bestand downloaden

Velden:

  • userId: Naam van de Profit-gebruiker.
  • apiKey: API-sleutel van de app connector.
  • environmentKey: Omgevingssleutel van de app connector.
  • description: De omschrijving van het apparaat. Deze omschrijving wordt geregistreerd in de eigenschappen van de app connector.

Gebruiker verkrijgt gebruikerstoken via Webservices

Een gebruiker die een activatiecode ontvangen heeft, kan hiermee een gebruikerstoken aanvragen.

Je kunt ook tokens genereren of verwijderen via JSON/REST.

Let op:

Je vindt alle URL's voor connectoren op de centrale pagina URL's van WebServices.

URL:

<endpoint>/profitservices/tokenconnector.asmx

Aanroep:

Profit Connector voor het ophalen van een gebruikers-token bij een app connector.

Xml-voorbeeld-bestand downloaden

Velden:

  • userId: Naam van de Profit-gebruiker.
  • apiKey: API-sleutel van de app connector.
  • environmentKey: Omgevingssleutel van de app connector.
  • otp: OTP die aan de gebruiker is verstuurd.

    Let op:

    Als je een token hebt toegekend en de gebruiker/omschrijving wordt in Profit niet in de eigenschappen van de app connector getoond, dan moet je de eigenschappen van de app connector afsluiten en opnieuw openen. Hierdoor wordt de weergave op het tabblad Gebruikerstokens ververst en kun je de gebruiker/omschrijving raadplegen. De token zelf kunt niet raadplegen, deze wordt alleen teruggemeld via de webservice.

Gebruikerstoken eigen app connector verwijderen

Als een gebruiker de app connector niet meer mag gebruiken, verwijder je zijn tokens.

Een gebruikerstoken geldt altijd voor de combinatie van een app connector, gebruiker en device. Als een gebruiker een app connector kan benaderen via verschillende devices, heeft hij bij de app connector voor elke device een token. Je kunt alle tokens verwijderen als de gebruiker geen toegang meer mag hebben. Als je alleen een specifieke device wilt blokkeren, verwijder je alleen de corresponderende token.

URL:

<endpoint>/profitservices/tokenconnector.asmx

Let op:

Je vindt alle URL's voor connectoren op de centrale pagina URL's van WebServices.

Je kunt ook tokens genereren of verwijderen via JSON/REST.

Aanroep:

Xml-voorbeeld-bestand downloaden

Veld:

  • Token: De GUID van de token die je wilt verwijderen.

    Vul de gehele token in, inclusief de tags, zoals in het volgende voorbeeld:

    <token><version>1</version><data>58A1C697C5F3476F838199C0412F625C4F2C46E4CEA6735454FDBB9EEBEBD48</data></token>

Direct naar

  1. App connector
  2. Security bij Connectoren
  3. Eigen app connector inrichten in vogelvlucht
  4. Meer informatie over de app connector (o.a. IP-restricties)
  5. Handmatig token toevoegen aan eigen app connector
  6. Uitreiken/intrekken van tokens automatiseren via OTP
  7. Veilig gebruik van de API