Skip to main content

SmartHR Integration

Connecting SmartHR with Josys allows the IT Admin to access user accounts seamlessly. Additionally, SmartHR can serve as an External Data Source, automating the process of adding and updating user profiles within Josys.

Two methods of integrating SmartHR are:

  • OAuth authentication
  • API key

Key benefits

When you integrate Josys with SmartHR, you can view a list of user accounts, including their status, roles, and when their accounts were created or updated.

Note: Josys supports multiple SmartHR integrations.
 

Prerequisites

Before you begin with the integration, make sure that you have:

  • A SmartHR admin account.
  • Installed Josys Link function from SmartHR Plus and identified the Email Address Custom Field Name for OAuth authentication integration.
  • The Tenant ID, Access Token, and Email Address Custom Field Name for API integration.

Locating Employee Address Custom Field Name

Note: If an employee's personal email address is registered in SmartHR, you have the option to create a custom field. This field can be used to link the employee's organization's email address with Josys.

Step 1: Sign in to SmartHR using an admin account. Navigate to the User Profile and click on the Common setting. Then, choose Custom employee fields and click Add custom field group.

Step 2: Provide a name to identify the Custom field group name and select Registration.

Step 3: Copy the Business Email Address for later use in the integration steps. 

Locating the Access Token

Step 1: Sign in to SmartHR using an admin account. Navigate to the User Profile and click on the Common setting. Then, choose External system cooperation and click the access token.

Step 2: Click new posting.

Step 3: Provide a name to identify the access token.

Step 4: Select the reference option for Employee Information, Account, and Departments, and deselect the other selected options.

Step 5: Select the reference option for the following fields in the Limitations on attributes (employee output items) section. If any option is not selected, then that data is not linked. Deselect other selected options and click Registration.

  • User ID
  • Surname
  • given name
  • Surname (Katakana)
  • First name (Katakana)
  • Business name: Last name (only if you want to sync business name as member name)
  • Business name: First name (only if you want to sync business name as member name)
  • email address
  • profile image
  • Enrollment status
  • Date of joining
  • Date of retirement/dismissal/death
  • employee number
  • post
  • Employment status
  • Department
  • Custom fields (sync company email address from custom fields in SmartHR) (Optional) 

 

Step 6: Copy the access token for later use in the integration steps. 

Steps to Integrate

Step 1: Select SmartHR from the App Catalog in the Apps section.

Step 2: Select any one Integration method as follows:OAuth: Enter the Email address Custom Field Name copied in the previous section.

  • API Key
    • Enter the Tenant ID in the respective field. For example, in the URL https://yourtenantid.smarthr.jp/, yourtenantid is the Tenant ID.
    • Enter the Access Token and Email Address Custom Field Name copied in the previous section.

Step 3: Provide a suitable Label for identification. Click Next to proceed.

 

Step 4: After the integration is complete, allow some time for data synchronization. You can now view and perform required actions from the Managed Apps in the Apps section.

 

Related articles