App Integrations

1. App Integrations Introduction

App integration enables seamless communication between two or more software systems, allowing them to exchange data and coordinate actions. It allows different systems to communicate with each other automatically, reducing the need for manual input. With integration, information entered in one system can be used or updated in another without duplication. This helps improve accuracy, save time, and streamline workflows across departments or platforms. App integration is especially useful for businesses that use multiple tools for operations like sales, inventory, finance, or customer service.

In the context of this setup, Accelera is integrated with Microsoft Business Central to manage and synchronize business operations such as orders, inventory, and shipments. This integration uses secure credentials and API endpoints to establish a reliable connection, ensuring data flows smoothly between both systems. Proper configuration of integration settings allows users to streamline daily tasks and maintain data integrity across departments.

• Go to Administration
• Click on Admin Settings
• Click on App Integrations under Admin Settings Action

2. Key features of the App Integrations tab

• Pagination Controls: Located in the top right corner, these controls allow users to navigate between different pages of integration listings. The "First" and "Last" options help quickly jump to the beginning or end of the records. The current page number is shown in a small input field which can be manually edited to jump to a specific page. Arrows on either side provide next and previous navigation functionality. 
• Refresh Button:  The "Refresh" button, located on the right side of the filter section, reloads the current view and updates the integration list. This is helpful for seeing any new data or changes made in the background without needing to reload the entire page. 
• Filter Dropdown: The "Select Filter" dropdown provides options for narrowing down the list of app integrations based on specific attributes. Users can select predefined criteria to locate relevant records quickly. The filter panel allows users to sort and view integration records based on specific attributes such as Code, Name, and Active status. 

• • Code: Represents the internal reference used for sorting or identifying integrations. Helpful in organizing large lists efficiently.

  • Name: Displays the readable label of the integration. 

• Search Bar: This input field allows users to search through integrations by code or name. It helps them locate a specific application without needing to scroll through the entire list. 

2. App Integrations Overview

• Code:  This section represents an individual integration entry. The title "MICROSOFT_BUSINESS_CENTRAL" is displayed in uppercase, reflecting the system's internal code for this integration.
• Name: This field represents the readable or user-defined label assigned to each integration. It is typically used to help users recognize an integration's purpose or association without needing technical details.
• Authentication Status—Valid Auth: This label indicates the integration's current authentication status, displayed here as “Valid Auth.” It confirms that the connection between the system and the external application is authorized and functional. 

• Click on View Details

4. App Integration Details

• Name: This field specifies the name of the external application being integrated. It helps users quickly identify the purpose or target system of the integration. It is typically pre-filled based on the configuration during setup. 
• Business Central Base URL: This field holds the URL used to communicate with the Microsoft Business Central instance. It serves as the base endpoint for all related API calls made through this integration. The system relies on this URL to send and receive data to the external application. It must be correctly configured to ensure successful request routing. 
• Business Central API Version: This field indicates the version of the Microsoft Business Central API being used. It helps ensure compatibility between the system and the external application’s API endpoints. Specifying the correct version ensures that the correct features and data formats are applied during communication. 
• Tenant ID: This value identifies the specific company account in Microsoft Business Central. It helps the integration connect to the correct organization when many companies are using the system. The Tenant ID ensures that data is sent to and received from the right workspace. It is often used during authentication or added to API requests to target the correct account.
• Database Name: This field defines the name of the database instance being accessed through the integration. It allows the system to interact with a specific database within the Business Central environment. This ensures that the integration targets the correct data source for all read/write operations.
• API Publisher: This field identifies the organization or party responsible for publishing the API. It is often used for categorization and validation purposes. Knowing the publisher allows for better tracking of updates and changes to the API. 
• API Group: This field organizes the API into a specific group or category. It helps users or systems logically separate APIs based on usage, functionality, or business purpose. Grouping can simplify version control, access control, and overall integration management.
• API Version: This field shows the specific version of the API that the integration is currently using. Keeping the right API version helps ensure that responses and available methods are consistent. This is important as APIs change or get updates over time.
• Company Name: This field captures the name of the organization associated with this integration setup. It helps link the integration configuration to a specific client, partner, or internal division. Displaying the company name improves clarity in multi-company or multi-tenant environments.
• Company Id: This value is used to associate the integration setup with a specific company in the system. It ensures that integration actions are properly scoped to the right company environment. This field is essential for maintaining data separation and control.
• Client Id: This field stores the client reference used for authentication with the external system. It is part of the credentials utilized in OAuth or other authorization processes. This value is sensitive and must be configured properly to ensure secure communication.
• Client Secret: This field holds the secure key associated with the client for authentication. It is used during the authorization process to verify the system’s identity. This value is confidential and must be protected, as misuse can lead to unauthorized access.
• Constant Text: This field includes static information that may be required for the integration to function properly. It is often used to define data formats, tokens, or flags used across multiple API requests.
• Redirect URI: This field defines the callback URL used after an authorization attempt. It ensures that the user or system is returned to the correct location after a login or token request. It is crucial in OAuth-based integrations.
• Authorize Section: This section displays the current authentication status, such as “Valid Auth.” It includes buttons to Authorize or Deauthorize the integration. These actions control whether the integration is active and allowed to communicate with the external system. Proper authorization is necessary before any API requests can be sent.

   5. API Details Panel

       This section lists all the API endpoints in the integration setup. Each API entry contains multiple fields.

• Code: This is an internal reference used to label the API. It is typically written in uppercase with underscores for easy readability. The code helps distinguish between different API actions within the system. Developers or technical teams primarily use it to manage and maintain the integration logic. This value is not visible to end users.
• Name: The name provides a descriptive title for the API, indicating its purpose in a human-readable format. It is intended to make the function of the API clear for administrators or system users reviewing the configuration. 
• Method: This field specifies the type of HTTP operation the API performs. Common methods include:

  • GET – used to retrieve or read data from the target system.

  • POST – used to send or create data in the target system.
    The method defines how the request should behave and what action it is expected to complete.

• API URL: The API URL is the complete web address that the system uses to send or receive data from another application, such as Microsoft Business Central. It defines the exact location (called the endpoint) where a specific API action is performed.
• API Enabled: A toggle switch indicating whether the specific API is active. When enabled, the system will include this API in integration operations. Each block represents a specific function related to Business Central operations, such as getting order numbers, posting shipments, or updating records. The user can manage which endpoints are active and ensure that each is correctly configured for communication.
• Save and Cancel Buttons: Located at the bottom, the Save button applies all changes made in the form. The Cancel button discards any unsaved changes and closes the panel. These controls help finalize or exit the configuration process safely.

 6. How to Delete an API

To delete an API from the interface, go to the API Details section, where all your configured APIs are displayed.

Step 1: Find the API You Want to Delete

Go to the API Details section on your screen. You’ll see a list of API blocks, and each one shows:

• The API Code

• The API Name

• The Method 

• The API URL

• A toggle to show if the API is enabled

Each block also has a delete icon (a small circle with a minus sign in it) in the top-right corner.

Click on that delete icon for the API you want to remove.

Step 2: Confirm the Deletion

Once you click the delete icon, a confirmation box with the message shown in the image will appear.

You’ll have two options:

• Yes – Click this if you're sure you want to delete the API.

• No – Click this if you changed your mind and don’t want to delete it.

• Once you click Yes, the API will be permanently deleted and cannot be undone.

• Make sure you're deleting the correct API before confirming.

• A deleted API will no longer be available to use or configure in the system.