Before creating a Service Account and opening API access, it is important to understand how the API will be used as this will determine whether they need view access for pulling data out and/or edit access for pushing data into the system. If you don't know, ask the client the intent.
For client's adding web services here are the steps to add a new service account that can be used in conjunction with the API Key.
IMPORTANT: Service Accounts can only be accessed via API, if a client or third party needs to login as the API user directly, then a user with a 'not in payroll' status i.e. User Only would need to be hired in the system and created for this purpose. They will also be subject to all authentication policies including 2 factor verification and password changes.
1) Create the API security profile. Clone the Payroll Admin w/ tax docs Security Profile and name it "Security for API User Only". Then verify it has the appropriate API Access on the modules tab based on how the API will be used. The below would be for an API that will be both viewing to pull data out of the system and editing to push data in. IMPORTANT: DO NOT INCLUDE THE ABILITY TO DELETE EMPLOYEES
2) Locate the API Key in the company use the eye icon to show the key to copy it. Note you may need to edit tabs to bring in the API Key Widget.
Important: DO NOT GENERATE A NEW KEY as this will potentially break any existing APIs the company already has setup.
2) On the Service Accounts widget (inside the company global setup) choose Add New Account. Note: you may need to edit tabs to bring in the service accounts widget.
3) Create the account
- Choose a Username (i.e. API User) and Password
- External ID is optional.
- Choose a security profile based on what the API will be used for. This can be modified later.
- Choose an account group, i.e. All Company Employees if they will access everyone. Optional: ONLY provide Edit access if they will be updating or editing employee data via API. You can add this later, too.
- Click Save
5) Provide the client with the necessary API Message and Credentials below:
Your API Service account is setup and the credentials are below. This account can only be used through an API configuration. We have setup the security profile and group access based on best practices and the intended use case, however if additional security access is needed, please let us know.
API Reference Guide: https://secure.saashr.com/ta/docs/rest/public/
Client Short ID:
Username:
Password:
API Key: