Setting up an API security group and an API user in Sage 100 Contractor
Security groups let you control users’ ability to open windows as well as perform specific actions within a window. The 7-3-1 Security Groups window in Sage 100 Contractor contains a grid with numbered rows on the left and eight columns:
- Group# (User input is required to save the record.)
- Group Name (User input is required to save the record.)
- Save
- Delete
- Void
- Chg Period
- Print Checks
- Notes
When you set up user groups, you type a group number and group name. Then you determine whether or not that group will have rights to Save, Delete, and Void records, as well as to change the accounting period and print checks. You may use the Notes column to add any pertinent information about each group.
You must create an API security group that is named exactly API. At least one user must be added to the API security group. You have to set rights to save, void, and so on.
Important! If you use security groups for the tasks performed by the employee in Sage 100 Contractor, make sure the API security group has access to 3-Accounts Receivable, 3-5 Jobs (Accounts Receivable), 3-6 Receivable Clients, 4-Accounts Payable, 4-4 Vendors (Accounts Payable), 5-Payroll, and 5-2-1 Employees.
To set up a security group for using the API
|
1
|
Open 7-3-1 Security Groups. |
|
2
|
In the Group# cell, type a group number, such as 51. |
|
3
|
In the Group Name cell, type API and do the following: |
Important! The API security group must be named exactly API.
|
a
|
In the Save cell, type Yes. |
|
b
|
In the Delete cell, if you want to allow the users of the API group to delete records, type Yes. If not, type No. |
|
c
|
In the Void cell, type Yes. If not, type No. |
|
d
|
In the Chg Period cell, type Yes. If not, type No. |
|
e
|
In the Print Checks cell, type Yes. If not, type No. |
|
f
|
To store information that may be relevant or important to that specific group, type a note in the Notes cell. |
|
4
|
On the File menu, click Save. |
Tips:
- Before you can use the API security group to access Sage 100 Contractor company data, you have to assign a user to the API security group.
- Security is set up for each individual company, not for the entire program. Each company can use different user names and passwords. If you have more than one company, you have to set up passwords for multiple companies.
Then you have to assign a user to the API security group using 7-3-2 User List.
The 7-3-2 User List window controls major features dealing with users and program security.
To assign a user to the API security group
|
2
|
In the User Name cell, enter a user name, such as APIUser. |
|
3
|
In the Password cell, enter a password. |
|
4
|
In the Group 1 cell, click once in the cell, and from the drop-down list, select the API group. |
|
5
|
Repeat steps 3–5 for each API user. |
Important! The API will not accept “supervisor” as a user name.
Restricting employee access to Sage 100 Contractor
You can use one of the two following scenarios as an alternate way to provide the access to send information to Sage 100 Contractor from ACT!.
Scenario 1: Have a system administrator enter the API user and password on a workstation
If you would like the user to be able to select a salesperson when creating clients in Sage 100 Contractor, but not give the user the ability to log into Sage Sage 100 Contractor, use this method.
A single API user/password can be entered by a system administrator on one or more workstations, allowing the user the ability to create vendors, clients, and jobs without gaining these additional permissions when logging into Sage 100 Contractor. Essentially, this means users will not be able to log into Sage 100 Contractor using the API credentials, but will be able to send information to Sage 100 Contractor.
To set up security for Scenario 1
|
3
|
Go to each workstation with the ACT! integration and do the following: |
|
a
|
In the Tools menu, select Sage 100 Contractor Company Settings…. |
|
b
|
Click to enable the company the user can access. |
|
c
|
In the User Name field, enter the API username. |
|
d
|
In the Password field, enter the API user password. |
The individual work station users will not be able to log into Sage 100 Contractor and access employees.
Scenario 2: Restrict menu level security access to 5-2-1 Employees so employee cannot select a salesperson
If you would like to give each user their own username and password for the API, but not allow the user to select a salesperson when creating clients in Sage 100 Contractor, use this method.
You can choose to restrict menu level security access in Sage 100 Contractor to 5-2-1 Employees for an ACT! user that has access to the API user login and password.
Important! Users will not be able to select a salesperson if you restrict access to 5-2-1 Employees in Sage 100 Contractor.
More resources
For additional online resources for Sage 100 Contractor products, visit the Sage Customer Portal. Use the portal to access the knowledgebase, chat online with customer support, or enter a customer support ticket.
For additional training on Sage products, visit Sage University.