Setting up a security group for using the API
The Sage 100 Contractor application program interface (API) enables you to use third-party programs to perform the same tasks that you would perform when using different Sage 100 Contractor windows. The API allows the third-party program to insert, as well as delete, modify, or retrieve data from one or more existing Sage 100 Contractor company databases.
Using the Sage 100 Contractor API to access Sage 100 Contractor company data requires a license use. That is why you have to set up an API security group using 7-2-1 Security Groups. Then you have to assign a user to the API security group using 7-2-2 User List.
Note: If no license uses available, the API program alerts you.
To set up a security group for using the API:
-
Open 7-2-1 Security Groups.
-
In the Group# cell, type a group number, such as 51.
-
In the Group Name cell, type API.
Important! The API security group must be named exactly API.
-
In the Save cell, type Yes.
-
In the Delete cell, to allow the users of the API group to delete records, type Yes. If you do not want to allow them to delete records, type No.
-
In the Void cell, type Yes to allow API users to void records. Otherwise, type No.
-
In the Chg Period cell, type Yes to allow API users to change periods. Otherwise, type No.
-
In the Print Checks cell, type Yes to allow API users to print Checks. Otherwise, type No.
-
To store information that may be relevant or important to that specific group, type a note in the Notes cell.
-
Click > .
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.