Connecting to SmartHR

The SmartHR API uses a token-based authentication.

Using Token Authentication

Your SmartHR API Token and TenantId are required to create a connection to SmartHR. API Token can be generated in the SmartHR application integration page. Once you have obtained it, set it in the ProfileSettings API Key connection property. And You can find TenantId at your SmartHR Page URL "https://1234567890.smarthr.jp/". ex. 1234567890. And if you use Sandbox environment, Set UseSandbox=true at the connection property.

Example Connection string

Profile=C:\profiles\SmartHR.apip;UseSandbox=false;ProfileSettings='APIKey=your_api_token;TenantId=1234567890;'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.