Een Graph API-verbinding instellen voor uw Microsoft Office 365-mailbox in ShopCtrl

In dit artikel leest u hoe u uw Microsoft Office 365-mailbox in ShopCtrl instelt met het OAuth-autorisatieproces via de Microsoft Graph API.

Hieronder staan de vier stappen om een Microsoft Office 365-mailbox in uw ShopCtrl-omgeving in te stellen.

Belangrijk:

Gedeelde mailboxen worden momenteel niet ondersteund voor de integratie met de Microsoft Graph API. Alleen gebruikersmailboxen kunnen via de API worden gebruikt voor e-mailfuncties en -gegevens.

Stap 1. Een API-applicatie voor ShopCtrl aanmaken en configureren

1. Log als beheerder in bij de beheerconsole van Azure Active Directory van Microsoft.

info

U kunt het beheercentrum van Azure Active Directory ook openen vanuit de Microsoft Admin Console door te klikken op ☰ menu > Admin Console > Azure Active Directory.

2. Ga in het beheercentrum van Azure Active Directory naar Enterprise applications > All applications en klik op New application.
3. Klik op de pagina Browse Azure AD Gallery op Create your own application.
4. Vul in het veld What's the name of your app een naam naar keuze in, waarmee u de toegevoegde app in de lijst met Active Directory-apps terugvindt.
5. Selecteer Register an application to integrate with Azure AD (App you're developing).
6. Klik op Create. Het toegevoegde programma verschijnt in de werkruimte in het gedeelte Enterprise applications. Het venster Register an application wordt geopend.
7. Selecteer in het gedeelte Supported account types: Accounts in this organizational directory only (Single tenant).
8. Selecteer bij Redirect URI de optie Web en vul de URL van uw ShopCtrl-omgeving in met het pad naar de e-mailautorisatie: https://{HOST}/Mail/Microsoft365/Auth.aspx.
9. Klik op Register.

De redirect-URI controleren en wijzigen

U kunt de ingestelde link altijd controleren en wijzigen via de Properties > application registration > Authentication van de applicatie. Zie de documentatie van Microsoft Redirect URI (reply URL) restrictions and limitations voor meer informatie. Als u een verbinding in de acceptatieomgeving test en dezelfde applicatie in de productieomgeving wilt gebruiken, voegt u voor dezelfde applicatie gewoon nog een Redirect URI naar uw productie-HOST toe.

Stap 2. Rechten toekennen aan de ShopCtrl-applicatie

Om de registratie van de applicatie af te ronden, geeft u de nieuwe app API-rechten om e-mail op te halen en te versturen.

De minimaal vereiste API-rechten aan de nieuwe app toevoegen:

1. Ga terug naar Enterprise applications > All applications.
2. Klik op de app die u net hebt aangemaakt. De details van de applicatie worden geopend.
3. Selecteer in het linkermenu Properties.
4. Klik op application registration om aanvullende eigenschappen te beheren.
5. Selecteer in het linkermenu API permissions.
6. Klik op de pagina API permissions op Add a permission.
7. Selecteer in het nieuwe venster Request API permissions op het tabblad Microsoft APIs de optie Microsoft Graph API.
8. Kies Delegated permissions voor Microsoft Graph.
9. Zoek in het veld Select permissions de volgende rechten en vink ze aan:
   • User.Read
   • offline_access
   • Mail.Read
10. Als u deze mailbox ook wilt gebruiken om e-mails te versturen:
    • Mail.Send
11. Klik op Add permissions.

De toegevoegde rechten verschijnen in de lijst:

Sluit het scherm nog niet. U moet de gegevens van de applicatie nog naar ShopCtrl kopiëren.

Stap 3. Inloggegevens voor de synchronisatie van uw Microsoft 365-mailbox met ShopCtrl ophalen

Om de Graph API-verbinding met uw Microsoft 365-account tot stand te brengen, hebt u de volgende gegevens nodig:

• Application (client) ID
• Directory (tenant) ID
• Waarde van het client secret

De gegevens aanmaken en ophalen:

1. Log als beheerder in bij de beheerconsole van Azure Active Directory van Microsoft.
2. Ga in het beheercentrum van Azure Active Directory naar Enterprise applications > All applications.
3. Klik op de app die u voor de integratie met ShopCtrl hebt aangemaakt. De details van de applicatie worden geopend.
4. Selecteer in het linkermenu Properties.
5. Beheer aanvullende eigenschappen door op application registration te klikken: "If this application resides in your tenant, you can manage additional properties on the application registration."
6. Selecteer in het linkermenu Overview.
7. Kopieer de Application (client) ID en bewaar deze op een veilige plek. Dit is uw Client ID.
8. Kopieer de Directory (tenant) ID en bewaar deze op een veilige plek. Dit is uw Tenant ID.
9. Selecteer in het linkermenu Certificates & secrets.
10. Klik op New client secret.
11. Vul in het deelvenster Add a client secret pane een Description voor het secret in.
12. Selecteer de geldigheidsduur (Expires) van het secret. Overweeg een langere periode in te stellen.

Belangrijk

Zodra het client secret verlopen is, stopt de e-mailsynchronisatie in ShopCtrl. Om de synchronisatie weer te starten, vraagt u een nieuw client secret aan en vult u dit in bij de betreffende mailboxinstellingen in ShopCtrl. U hoeft geen nieuwe applicatie aan te maken en te registreren: alleen het client secret van de bestaande applicatie moet worden vervangen door een geldig exemplaar.

13. Klik op Add om het client secret te genereren.
14. Kopieer het veld Value van het client secret en bewaar het, net als een wachtwoord.

Let op

De waarde van een client secret is alleen direct na het aanmaken zichtbaar. Sla het secret dus op voordat u de pagina verlaat.

Stap 4. De synchronisatie met de Microsoft Office 365-mailbox instellen in ShopCtrl

De volgende stap is het invullen van de gegevens van de aangemaakte applicatie in ShopCtrl en het autoriseren ervan in Microsoft 365.

Het ophalen van e-mail instellen

1. Klik in het deelvenster met verkoopkanalen op het pictogram van de shop en selecteer Settings in de lijst.

2. Ga in het menu naar Communication > E-mail > Receiving email.

3. Klik op Add om een nieuwe verbinding aan te maken.

   Belangrijk

   Als uw mailbox al in ShopCtrl is ingesteld, opent en wijzigt u de bestaande verbinding in plaats van een nieuwe aan te maken.

4. Selecteer het Protocol, in ons geval Microsoft Graph API.

5. Klap het deelvenster Auth Parameters uit en selecteer Microsoft 365 als Auth method.

6. Vul in het deelvenster Auth Parameters de Tenant ID van de aangemaakte applicatie in.

7. Vul de Client ID in.

8. Vul het Client Secret in. Het veld Status verandert in Not authorized.

9. Klik op Save and Authorize. U wordt doorgestuurd naar de bevestiging van de autorisatie. Zorg dat er op de andere tabbladen geen niet-opgeslagen wijzigingen zijn. Als u doorgaat, gaan wijzigingen op andere tabbladen verloren.

10. Log in bij uw Microsoft 365-account met de gebruiker die u instelt. Controleer de rechten en bevestig dat u toegang verleent.

    Belangrijk

    Om de integratie met de Microsoft Graph API in te stellen, moet u zich aanmelden met het gebruikersaccount dat bij de applicatie hoort, en niet als beheerder van Active Directory.

Gebruik het e-mailadres dat u voor de integratie wilt instellen. Als uw organisatie eenmalige aanmelding (Single Sign On) gebruikt, gebruik dan het adres van de shop en niet uw persoonlijke account. :::

11. Na de bevestiging verschijnt het venster Success, waarin staat dat de toegang voor het account is verleend. Als een van de autorisatieparameters onjuist was, verschijnt er een venster met de betreffende melding. Herstel de fouten en doorloop dezelfde stappen opnieuw.
12. Klik op de knop Back to Shop Settings. U wordt teruggestuurd naar uw ShopCtrl-omgeving.
13. Op de pagina met shopinstellingen verandert de Status van uw verbinding in Authorized.
14. Schakel de verbinding bovenaan het venster in met Enable.
15. Klik op Ok om de instellingen te sluiten.

De verbinding met de mailbox testen

Om te testen of de mailbox goed is ingesteld, klikt u op de knop Test MailBox. In een pop-upmelding ziet u of de verbinding is geslaagd. Zodra de verbinding tot stand is gebracht, vinkt u het selectievakje Check mail aan om e-mails in ShopCtrl te gaan ontvangen.

Het versturen van e-mail instellen

1. Klik in het deelvenster met verkoopkanalen op het pictogram van de shop en selecteer Settings in de lijst.

2. Ga in het menu naar Communication > E-mail > Sending email.

3. Klik op Add om een nieuwe verbinding aan te maken.

   

4. Selecteer het Protocol, in ons geval Microsoft Graph API.

5. Klap het deelvenster Auth Parameters uit en selecteer Microsoft 365 als Auth method.

6. Vul de Tenant ID van de aangemaakte applicatie in.

7. Vul de Client ID in.

8. Vul het Client Secret in. Het veld Status verandert in Not authorized.

9. Klik op Save and Authorize. U wordt doorgestuurd naar de bevestiging van de autorisatie. Zorg dat er op de andere tabbladen geen niet-opgeslagen wijzigingen zijn. Als u doorgaat, gaan wijzigingen op andere tabbladen verloren.

10. Log in bij uw Microsoft 365-account met de gebruiker die u instelt. Controleer de rechten en bevestig dat u toegang verleent.

Belangrijk

Om de integratie met de Microsoft Graph API in te stellen, moet u zich aanmelden met het gebruikersaccount dat bij de applicatie hoort, en niet als beheerder van Active Directory.

12. Na de bevestiging verschijnt het venster Success, waarin staat dat de toegang voor het account is verleend. Als een van de autorisatieparameters onjuist was, verschijnt er een venster met de betreffende melding. Herstel de fouten en doorloop dezelfde stappen opnieuw.
13. Klik op de knop Back to Shop Settings. U wordt teruggestuurd naar uw ShopCtrl-omgeving.
14. Op de pagina met shopinstellingen verandert de Status van uw verbinding in Authorized.
15. Schakel de verbinding bovenaan het venster in met Enable.
16. Klik op Ok om de instellingen te sluiten.

Een testmail versturen

Om te controleren of de gegevens van de uitgaande server juist zijn ingevuld, klikt u op Send test mail en vult u een e-mailadres in waarnaar een testmail wordt gestuurd.