SmartHR

Integration Methods

1. OAuth Integration
2. API Token Integration

OAuth Integration

Prerequisites

Integrating with Josys

1. From the left sidebar of Josys, click "Integrations > App Catalog".
2. Search for SmartHR and click on it.
3. The setup page will appear on the right side.
4. Select "OAuth" as the integration method.
   If you have configured a custom employee field for email addresses in SmartHR, enter the field name.
   For details, see below.
   About Custom Employee Field Names for Email Addresses
5. Click "Next" in the bottom right corner.
6. You will be redirected to the authorization screen. Log in with your SmartHR admin account and click "Authorize".

API Key Integration

Prerequisites

Checking Your Tenant ID

Obtaining the API Key

1. Log in to SmartHR using an account with Admin privileges.
2. After logging in, click "Common Settings".
   From the left menu on the screen, click "External Integrations".
3. Click "Access Tokens".
4. Click "Issue New Token" in the top right corner of the Access Tokens page.
5. Enter a name for the access token, such as "Josys Integration".
6. In the "Resource Permissions" section, configure the settings as follows:
   • "Employee Information" under Employee Features: Read and Write
   • "Account" under Common Settings: Read, "Departments" under Common Settings: Read and Write
   • Uncheck both [Read] and [Write] for all other items, as they are not used.
7. In the "Employee Field Permissions" section further down the screen, keep the [Read] checkbox selected for the following items:
   For Departments, keep both [Read] and [Write] checkboxes selected.
   Please note that if these are not checked, some data may not sync properly.

1. User ID
2. Last Name
3. First Name
4. Last Name (Katakana)
5. First Name (Katakana)
6. (Optional) Business Name: Last Name
   *Only required if you want to sync the business name as the member name when integrating User Profiles with SmartHR.
7. (Optional) Business Name: First Name
   *Only required if you want to sync the business name as the member name when integrating User Profiles with SmartHR.
8. Email Address
9. Profile Image
10. Employment Status
11. Hire Date
12. Termination/Resignation/Decease Date
13. Employee Number
14. Job Title
15. Employment Type
16. Departments *Read and Write
17. (Optional) Custom Fields
    *Refer to: Syncing Work Email Addresses from SmartHR Custom Fields
18. Click "Register" at the bottom of the screen.
19. Copy the "Access Token" displayed on the screen. This will be used as the access key in Josys.

Integrating with Josys

1. From the left sidebar of Josys, click "Integrations > App Catalog".
2. Search for SmartHR and click on it.
3. The setup page will appear on the right side.
4. Select "API Key" as the integration method.

   

5. After selecting "API Key", enter your Tenant ID and Access Key.
   If you have configured a custom employee field for email addresses in SmartHR, enter the field name. For details, see below.

   About Custom Employee Field Names for Email Addresses
6. Click "Next" to complete the integration!

About Custom Employee Field Names for Email Addresses

If you register employees' personal email addresses in the "Email Address" field in SmartHR, the integration will link accounts to User Profiles based on those personal email addresses.
*If those personal email addresses are not registered in your User Profiles, the SmartHR users may be treated as "Unmanaged Users" because Josys cannot find matching profiles.

If you have created a custom field in SmartHR to manage work email addresses, you can use that field to link accounts to Josys User Profiles.

For details, please refer to the following help page:
Reference: Syncing Work Email Addresses from SmartHR Custom Fields

About the "Unregistered Member" Status in SmartHR

After integrating with SmartHR, the "Unregistered Member" status shown on the app details page indicates the same state as "Unmanaged Users" in other apps (accounts that are not linked to any user in Josys).

To link an "Unregistered Member" account to a specific user, follow the steps below:

1. Add the email address to the user: Go to "User Profiles", select the relevant user, and add the email address associated with the SmartHR account as an associated ID.
   Reference: Registering Associated IDs
2. Run a sync: Run a sync for SmartHR.