Microsoft Dynamics GP Service Based Architecture (SBA) API

What we need

• GP Service URL
• Windows Authentication Credentials
• SSL Certificate
• Proper GP User Permissions
• Tenant Configuration (if multi-tenant)

This guide walks through the process of setting up and configuring the Service Based Architecture (SBA) for Microsoft Dynamics GP to enable REST API access to GP functionality.

Overview

Service Based Architecture (SBA) is a method for enabling applications and services to access Dynamics GP functionality through a standards-based services model. It provides a REST Web service that exposes Microsoft Dynamics GP business logic as service operations.

SBA utilizes the same logic as the GP Client, which means that any functionality available in the GP Client can be exposed through the API without requiring separate synchronization of business logic.

Prerequisites

Before you begin, ensure you have:

1. Microsoft Dynamics GP installed with the Service Based Architecture feature
2. Internet Information Services (IIS):
   • installed with the following components: https://learn.microsoft.com/en-us/dynamics-gp/installation/sba#internet-information-services-iis
   • web site must be exposed to .Net Framework 4.0
   • web site must have an SSL Certificate bound to it
3. SQL Server with appropriate permissions
4. Administrator access to both the GP environment and the server where SBA will be installed
5. Domain user accounts with appropriate permissions

Step 1: Install Service Based Architecture (SBA) Feature

1. Installing Service Based Architecture without Tenant Services Detailed instructions: https://learn.microsoft.com/en-us/dynamics-gp/installation/sba#installing-service-based-architecture-without-tenant-services

Step 2: Set up SQL Server login in Dynamics Utilities

• Launch Dynamics Utilities
• Go to Additional Tasks and select Manage Web Client SQL Server Login
• Create a SQL Server login that will be used by the web service
• This user should NOT be a GP user
• The credentials will be used by the SBA service to connect to the GP databases

Step 3: Configure User Permissions in Dynamics GP

For a user to access the SBA API, they must have appropriate permissions set up in Dynamics GP:

1. Map Windows User to GP User

   • In Dynamics GP, go to Microsoft Dynamics GP > Tools > Setup > System > User
   • On the Windows Account tab, map the domain user that will be accessing SBA to a GP user

2. Grant Company Access

   • Go to Microsoft Dynamics GP > Tools > Setup > System > User Access
   • Ensure the GP user has access to the companies that will be accessed via the API

3. Configure Security Permissions

   • Go to Microsoft Dynamics GP > Tools > Setup > System > User Security
   • Grant the GP user access to the windows/functionality they will need to access via the API
   • As an example, if Domain\User needs access to create customers through SBA, Domain\User would need to be tied to a GP User, the GP User would need to have access to the company in which Domain\User would create customers and the GP User would need access to the Customer Maintenance window in Dynamics GP.

Step 4: Verify Installation

1. Test Basic Connectivity

   • Access the Ping endpoint: https://[server]:[port]/GPService/Tenants([tenant])/Companies([company])/Utility/Ping
   • This should return a timestamp if the service is working correctly

2. Check Diagnostics

   • Access the diagnostics page: https://[server]:[port]/GPService/Management/Diagnostics
   • Verify that at least one Tenant is listed and there is at least one value in the RoutingTable

3. View Available Methods

   • Access the help page: https://[server]:[port]/GPService/Tenants([tenant])/Companies([company])/Help
   • This provides information about all available methods by product

Additional Resources

• Microsoft Dynamics GP Documentation
• Service Based Architecture Documentation
• Microsoft Dynamics GP Web Components Installation Guide