Installation

Add your application manually

•  Login to API Center. You received the login credentials by email.
• Click the Applications and then search Business Central and you will be able to see the application.
  

For Business Central Application the following fields need to be filled out for a successful connection to be established.

• Display Title: The name of the application, no special requirements.
  • This can be useful if there are multiple Business Central applications, to be able to distinguish between them.
• API Password: This is your Web Service Access Key
  • Check the next section for description on how to find this.
• API Username: This is the user that has access to the Webservice
  • Check the next section for description on how to find this.
• API URL: The URL is build from different sections, the following information is included in the URL 
  • Tenant ID information
    • Check the next section for description on how to find this.
  • Environment Type information
    • Check the next section for description on how to find this.
  • Company ID information
    • Check the next section for description on how to find this.
• API URL ON PREMISE 14 AND HIGHER: The URL is build from different sections, the following information is included in the URL 
  • [customer environment]/{apiversion}/{tenantID}/{divison}
    
    • Example: https://[enviroment name].example.cloud:8048/v1.0/{tenant-id]/production
• API Version: This is the API version used by the App.
  • Currently only V2 is supported.
• Division: Usually this is equal to the Environment Type

When all the settings are filled in, save the Application. It should look something like the image below.

Add your application by wizard

You can also add your application via the integration wizard, you can find the button for this on the dashboard page

After pressing the the start integrating button a pop up will appear with the wizard, please make sure you do not use any pop-up blocker at this point.

Press next and in the following screen you can add your applications that you want to connect. fill out the required information per app, authorize and test and then both applications are in your wizard available

In step 3 you can select the packages that you want to make use of. These packages are the flows that determine what data is send from and to Business Central.

In step 4 you can set the all the settings that tweaks your integration without adjusting mappings and or adjusting code. In this step you need to do this for all your flows. The settings we have standard enabled and disabled are based upon 90% of the integrations we currently have running.

Step 5 finishes the wizard and on this point you can enable the flows to start running, if you want to adjust advanced settings we advice to start them manually in the integrations overview.

Business Central settings location

This section will show you how to find the required settings in Business Central.

API Username and API Password

1. Login to Business Central with the administrator account and search for the Users section. 
   
   
   
2. Make sure the permission set is setup similar to the image below. Be sure to copy the access key for your user, before exiting the window. You will only get one chance. After that, the only retrievable option is to do HTML inspect on the element to acquire the Webservice Access Key. This is your API password. The username you will use will also be your API username.
   
   
   

API URL and Access parameters

1. Login to Business Central with the administrator account and search for the Web Services section.
   
   
   
   
2. Check a random Web Services and copy part of the URL as shown below. The URL does not have to include the 'https' part. And all data after the environment is not included in the API url. So your final result will look like this:
   • api.businesscentral.dynamics.com/v2.0/da3512cb-28be-4250-ac7f-1788c9f97839/Production
     
     
     
     
   • Where the first part is your Microsoft Business Central basic URL part: api.businesscentral.dynamics.com
   • The second part is your version number:
     v2.0
     
   • The third part is your tenant number:
     da3512cb-28be-4250-ac7f-1788c9f97839
     
   • The fourth part is your environment type and your division accessor:
     Production
     

Company ID

1. Login to Business Central with the administrator account and find the dashboard section. The Company ID is usually listed on top.