Configuration

Unless otherwise noted, all settings described here can be found under Stores > Settings > TechDivision > Dynamics BC API Client.

General

Base URL

Defines the base URL that will be used to access API page endpoints. The client’s design is based on specifying paths relative to the base URL defined in this setting. Leading slashes are trimmed off the path specified in order to make sure that requests are always sent against the correct system.

Default: n.a.
Scope: Store View

Authentication

This panel contains all settings that are necessary to authenticate a request.

Type

Defines the type of authentication that shall be used. By default, the module supports the following authentication types:

  • "None" when no authentication is required at all.

    This setting is not recommended in environments other than local development.

  • "Basic Authentication" when authentication is performed via HTTP Basic Authentication.

  • "Microsoft OAuth2" when an OAuth2 token from a Microsoft service is required.

Default: "None"
Scope: Store View

Username

Only visible when the setting Type is not set to "None".

Defines the username part of the credentials that shall be used to authenticate.

Default: n.a.
Scope: Store View

Password

Only visible when the setting Type is not set to "None".

Defines the password part of the credentials that shall be used to authenticate.

Default: n.a.
Scope: Store View

Microsoft OAuth2

This panel is only visible when the setting Type is set to "Microsoft OAuth2".
It is a sub-panel of Authentication.

URL

Defines the URL that is used to obtain an OAuth2 token from the Microsoft service.

Default: n.a.
Scope: Store View

Grant type

Defines the grant type that shall be requested.

Default: "client_credential"
Scope: Store View

Scope

Defines the scope for which the generated token shall be valid.

Default: "https://api.businesscentral.dynamics.com/.default"
Scope: Store View

Logging

Enabled

When enabled all data sent from and received by the client is written in plaintext to Magento’s log files, this exposing sensitive data.
Do not enable this setting in a production environment!

Defines whether request and response content shall be logged for debugging purpose. Log messages are added with level \Psr\Log\LogLevel::NOTICE and can thus be found in var/log/system.log.

Default: "No"
Scope: Global