Skip to main content

​
Prerequisites

Before you can use the web API, some initial configuration is required. The authenticated user must have API access to one or more modules within the environment. In , each user is assigned to a security group, which defines their permissions for individual modules. As a best practice, you should use a dedicated user account (rather than the default ADMIN account) for API access. Using the ADMIN account involves additional configuration steps. Follow the instructions in the next sections to create a dedicated user and enable API access.

​
Step 1: Create a User Account

Skip the following steps if you have already created a new user or if you want to use an existing account.
  1. Open the application, which is included in the installation. Log in with the ADMIN account.
  2. Select Administrative Services > Users. Enter the required information and click Add.

​
Step2: Set up the Security Group

  1. Open the application, which is included in the installation. Log in with the ADMIN account.
  2. Select Administrative Services > Security Groups. The application contains all of the application. The group identifier (Id) represents the security group that you want to modify.
  3. Create a new security group by filling out the Group ID and Group Description fields.
  4. Select any permissions you want for the group, including the web API permission.
  5. Click Add for each application that is required.
You can also select an existing security group (under Group ID) that you want to assign to the user. Make sure to select the web API permission for each application that is required.

​
Step 3: Assign a Security Group

After you create a security group, you can assign it to a user, as follows:
  1. Open the application, which is included in the installation. Log in with the ADMIN account.
  2. Select Administrative Services > User Authorization.
  3. Under User ID, select your new or existing user.
  4. For each application, assign the group ID that you created or modified.
After you complete these steps, ensure that the user account can access the web API by entering the URL for your instance in the URL text box in the “Authenticate to ” section below.

​
Add the Sage 300 Connector

​
Authenticate to Sage 300

After you add the connector, you need to set the required properties.
  • URL: Enter the URL for the server that hosts your instance of (for example, http://localhost/Sage300WebApi/v1.0/-/).
  • User: Enter the username that you use to authenticate to your account.
  • Password: Enter the password that you use to authenticate to your account.

​
Complete Your Connection

To complete your connection:
  1. For Company, enter the name of the company from which you want to retrieve data.
  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)
  3. Click Create & Test to create your connection.

​
More Information