Muokkaa

Jaa


Endpoints for the APIs for Dynamics 365 Business Central On-Premises and Online

Note

Azure Active Directory is now Microsoft Entra ID. Learn more

Business Central on-premises and online expose an API that makes it possible to integrate with other services. To enable integration with these APIs, you must go through a few steps to enable the access first. For more information about these steps, see Enabling APIs for Dynamics 365 Business Central.

Accessing the endpoints

Once you have the API access enabled, you can write code that integrates your web service or SaaS solution with Business Central. Creating your integration through an API provides simple access to the supported functionality in a single endpoint, giving you a simplified experience for creating a single app with integrations across multiple Microsoft products.

Important

With the introduction of multiple Business Central > environments, the name of the environment being connected to needs to go into the URI. To learn how to get a list of environments deployed on the tenant, see Getting a list of environments.

Business Central

Means of connection Microsoft Graph Common endpoint service Direct tenant
Usage Production Production Production
Endpoint https://
graph.microsoft.com
/beta/financials/
https://
api.businesscentral.dynamics.com/
v2.0/<environment name>/api/v2.0

Example:
https://
api.businesscentral.dynamics.com/
v2.0/production/api/v2.0
https://
api.businesscentral.dynamics.com/
v2.0/<user domain name>/<environment name>/api/v2.0

Example:
https://
api.businesscentral.dynamics.com/
v2.0/cronus.com/sandbox/api/v2.0
Availability Always enabled Always enabled Always enabled
Authentication Microsoft Entra ID
Microsoft Entra ID
Microsoft Entra ID
API/Data access Based on user's
permissions
Based on user's
permissions
Based on user's
permissions
API update cycle Monthly Monthly Monthly
Development instance Sign up for a tenant Sign up for a tenant Sign up for a tenant

Business Central On-Premises

Means of connection Direct installation
Usage Production
Endpoint OData base URL in installation:
https://
<base URL>:<port>/<serverInstance>/api/<API version>/
Example: https://
nav.contoso.com:7048/
bc/api/v2.0
Must be exposed through a firewall.

Extension APIs:
https://<base URL>:<port>/<serverinstance>/api/<API publisher>/<API group>/<API version>
Availability Disabled by default.
Must be enabled by the administrator.
Authentication Basic authentication.
Username and web service
access key
as password. Your solution must be configured to use NavUserPassword or AccessControlService authentication in order to configure Business Central user accounts to include an access key.
API/Data access Based on user's
permissions
API update cycle Hotfixes installed by partner
Development instance Get Docker instance

Which IP addresses or ranges does my environment's API use?

When you exchange data through the API, you might have to safelist the IP addresses.

For more information, see FAQ: IP addresses or ranges for the Business Central service

Developing Connect apps for Dynamics 365 Business Central
Microsoft web services overview
OpenAPI specification