Edit

Share via

Enabling the APIs for Business Central

  • Article

APPLIES TO: Business Central on-premises

Business Central exposes 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 for Business Central.

Enable access to the APIs

  1. Open the Business Central Administration Shell.

    For more information, see Run Business Central Administration Shell.

  2. Run the Set-NAVServerConfiguration cmdlet to enable OData services.

    PowerShell 
    Set-NAVServerConfiguration <BC server instance name> -KeyName ODataServicesEnabled -KeyValue true

  3. Run the Set-NAVServerConfiguration cmdlet to enable API Services.

    PowerShell 
    Set-NAVServerConfiguration <BC server instance name> -KeyName ApiServicesEnabled -KeyValue true

  4. Check that the values for the PublicODataBaseUrl and ODataServicesPort parameters are correct.
    When exposing a web service, you must open the port for other consumers of your web service to access it. You can have your system administrator add the port through Windows Firewall on the computer running Business Central server. The default port for OData web services is 7048.

    You can verify these settings by running the Get-NAVServerConfiguration:

    PowerShell 
    Get-NAVServerConfiguration <BC server instance name>

  5. In Business Central, search for API Setup and then choose the related link.

  6. On the API Setup page, choose the Integrate APIs button.
    This starts a process of populating all the integration tables with records for all APIs. The process can take several minutes.

Depending on where you want to access the APIs from, you must specify the correct endpoint. For more information, see Endpoints for APIs.

Note

For on-premises environments where SOAP, OData, or APIs have been turned off, any call to such an endpoint will also return a HTTP status code 405 (so check your server configurations if you see those).

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