Sage 100 Contractor Authentication

To authorize access to make API requests between your product and Sage 100 Contractor through Agave, you will need to complete the following steps:

caution

Before installing the Agave Connector, we recommend confirming you are on a supported version of Windows.

Step 1: Add a new SQL Admin User

Only SQL Admin Users can read and write data between your product and Sage 100 Contractor. To add a SQL Admin User:

Open the Sage 100 Contractor Database Administration app.
Under Company admin / SQL Logins, select "Add SQL Server Login". For Authentication, select "SQL Server Authentication" as the authentication mode, enter a strong password, and check “Add as member of the sysdamin role”.
To verify the new User has the correct permissions, go to "Modify SQL Server Administration" on the left-hand nav, select the login, and press "Update sysadmins".
Go to "Add Company Administrator" on the left-hand nav, and add the new user to your Company:

Step 2: Create Security Group

note

Make sure to complete the following steps in the Sage 100 Contractor company you plan to link to.

Your customer will need to create a Security Group and add the SQL Admin User to it.

To create a Security Group:

When logging into Sage 100 Contractor, your customer will need to Open the company with Administrator rights:
In the left hand rail, select 7 - Utilities --> 2 - Company Security --> 1 - Security Groups:
Insert a row to the Security Groups table (e.g. see the row for "API" below) and press the Save icon at the top right. Make sure to set the Save and Delete privileges to "Yes".
In the left hand rail again, select 7 - Utilities --> 2 - Company Security --> 2 - User List:
Assign the User created in Step 1 above to the Security Group you created and press the Save icon at the top right.

Step 3: Install Agave connector

note

We recommend installing the Agave Connector on the server used to host Sage 100 Contractor instead of a user's workstation.

Some customers also choose to run the Agave Connector on a separate account (rather than admin) on the host machine. Ensure you install the Agave Connector while signed in with the account that will run it.

The Agave Connector app is a standalone application that you can install in a Windows environment and can be used to connect to on-premise applications like Sage 100 Contractor.

To install and run the Agave Connector app:

Contact the Agave team at support@agaveapi.com for a link to download the .exe file.
Download the .exe file and open it. You will see the following install screen appear:
After installation, the Agave Connector app will open and appear in your Desktop folder:

Step 4: Authenticate with Sage 100 Contractor

For a user to authenticate with their Sage 100 Contractor instance from your product, they will need to complete the following steps:

From your application, open Agave Link and press “Sage 100 Contractor”:
Select "Create Account":
In parallel, open the Agave Connector app and select “Add Account”:
Input details for connecting to your Sage 100 Contractor SQL database:
- Database Name: this is the database for the Sage 100 Contractor company you are connecting.
- Host: this is the host for accessing the Sage 100 Contractor instance.
- User: this is a User that has been added by a Sage 100 Contractor Admininstrator. Note, the User must be a SQL Administrator for the Sage 100 Contractor database.
- Password: this is the password for the Sage 100 Contractor User.
- Instance Name: this is the SQL Server instance used by Sage 100 Contractor. If it is running on the default SQL Server instance, this may be blank.
note
The Database Name is found in the Company List when opening Sage 100 Contractor:
The Host and Instance Name are often found under the Home & Resources tab in Sage 100 Contractor:
Pressing “Test and Save” will open a page for "Agave API Configuration". Your user will need to return the Agave Link component, and copy and paste the Account ID and Token, then press "Test and Save":
Press “Validate Connection” in Agave Link. If the connection succeeded, Agave Link will close and you will be supplied with a Public Token to exchange for a permanent Account Token.