Authorization and Authentication
This document provides instructions to customer's IT team on how to grant access to the Ultipro HCM for integrating the company organization chart with Together.
Ultipro Connect is a set of APIs that allow apps to integrate with an Ultipro organization's HRIS data. A system administrator can create a set of authorized credentials by registering a web service account. This service account has a defined scope of rights, and it is with these credentials that the app accesses protected information, such as employee titles.
Each service account has a unique API key and username and password.
For the purposes of an integration with Together, only read access is required. Together will not make any writes to your HRIS data.
Step 1: Generate a new web service account for Together
Login to Ultipro as a system administrator
Head to System Configuration > Security > Service Account Administration
Begin adding a new service account.
Enter a new username and password for the service account. A suggested username is TogetherIntegration, however, you may choose any username and password that fit your organization security standards.
Enter the system administrator's email in the email field.
Under the Web Service scopes, choose the following:
Personnel Integration: View
- This provides Together with the ability to construct an organization chart via Employee Id, Job Title, Supervisor Id, etc
Company Configuration Integration: View
- This provides Together with a code table to join to fields such as Job Code, which by default are not in readable string representations
Employee Contacts: View
Employee Person: View
Employee Job: View
Employee Person Details: View
Hit save, and obtain and hold onto the provided User API key, username and password.
Obtain the Customer API key from System Configuration > Security > Web Services
Obtain and hold onto the Customer API.
Note down the root URL of all of the web services above, e.g. https://service4.ultipro.com/
Step 2: Sending credentials
Add the User API key, Customer API key, root URL, username and password to a notepad (.txt) file. Send the file securely to email@example.com by visiting https://send.firefox.com, uploading the file and sending the link via email.