Enabling the APIs for Dynamics 365 Business Central (v1.0)

  • Article

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.

Important

REST programming is not natively supported in C/SIDE. In order to run the APIs you must add the REST dependent types manually. Existing W1 objects can compile and load, but some .NET types cannot be loaded into the C/SIDE Development environment variable editor due to missing server dependencies.

Enable access to the APIs

  1. Open the Business Central Administration tool.
  2. Expand the OData Services tab, and select the Enable OData Services checkbox first, then select the Enable API Services checkbox.
  3. Check that the values for the OData Base URL and Port are entered correctly.
    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.
  4. In Business Central, search for API Setup and then choose the related link.
  5. On the API Setup page, choose the Integrate APIs button.
    This will start 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