HRMOS CORE API (1.0.0)

特記がない場合、すべてのリクエストボディの最大サイズは 10MB です。超過した場合は 413 Payload Too Large エラーが返却されます。

当ドキュメントにおけるRate Limitは、ご利用中のすべてのお客様に対して 2025/4/1 より適用されます

HRMOS CORE API v3では、以下の単位でRate Limitを設けています。

API全体部分は、HRMOS CORE API v3全体へのアクセスで計算されます。

Rate Limitは、 直近60秒間のrequest数の積算 から計算されます。これにはerrorとなったリクエストも含まれます。（Rate Limitにヒットした後のリクエストも積算対象です）

例： APIv3を 15 request/secondで60秒実行した場合
15 * 60 = 900 = 最後の300前後はRate Limit。 積算が600を下回るのは 300 / 15 = 20秒以上経過後 となる

リクエストが定められたRate Limitに抵触した場合、 429 のステータスコードでエラーレスポンスが返却されます。bodyはありません。

カスタム通知 Webhookの仕様について

Webhookの設定はカスタム通知の設定より行えます。

設定したURLにPOSTでJSON形式のデータが送信されます。

Webhookリクエストには200番台のレスポンスを返却してください。
200番台以外の場合、200番台が返却されるまで最低1分間隔で最大3回リトライを実施します。
リクエストのタイムアウトは最長で1分間です。
1分を超える処理を行う場合、202 Accepted等のレスポンスを返却してバックグラウンド処理をしてください。

User-AgentはHRMOS/1.0として送信します。

{
    "id": "string",
    "type": "string",
    "triggeredAt": "string",
    "token": "string",
    "companyId": "string",
    "data": "object"
}

id string
Webhookのリクエスト毎に異なる識別子

type string
トリガーの種類
取り得る値は下記です。

triggeredAt string
トリガーされた時刻
RFC 3339 フォーマットの文字列

token string
設定で指定したトークン
HRMOSからのリクエストであることを確認するためのトークンです。
WebhookリクエストのIPアドレスは実行毎に変化するため送信元の制限を行いたい場合、トークンを使用してください。

companyId stirng
HRMOS COREにおける貴社の識別子

data object
トリガーの情報
トリガーの種類によって、内容が異なります。
詳細は下記となります。

PEOPLE_CREATED

people object
トリガー対象社員

例

{
    "id": "9999999999999999",
    "type": "PEOPLE_CREATED",
    "triggeredAt": "2023-01-01T01:01:01.000000Z",
    "token": "example",
    "companyId": "9999999999999999",
    "data": {
      "people": {
        "id": "9999999999999999",
        "code": "example"
      }
    }
}

PEOPLE_UPDATED

people object
トリガー対象社員

categoryCode string
更新されたセクションのcategoryCode

sectionCode string
更新されたセクションのsectionCode

例

{
    "id": "9999999999999999",
    "type": "PEOPLE_UPDATED",
    "triggeredAt": "2023-01-01T01:01:01.000000Z",
    "token": "example",
    "companyId": "9999999999999999",
    "data": {
      "people": {
        "id": "9999999999999999",
        "code": "example"
      },
      "categoryCode": "business",
      "sectionCode": "basic"
    }
}

RELATIVE_DATE_REACHED

people object
トリガー対象社員

categoryCode string
指定の日付フィールドのcategoryCode

sectionCode string
指定の日付フィールドのsectionCode

fieldCode string
指定の日付フィールドのfieldCode

specifiedDate string
指定の日付フィールドのデータ
YYYY-MM-DD フォーマットの文字列

例

{
    "id": "9999999999999999",
    "type": "RELATIVE_DATE_REACHED",
    "triggeredAt": "2023-01-01T01:01:01.000000Z",
    "token": "example",
    "companyId": "9999999999999999",
    "data": {
      "people": {
        "id": "9999999999999999",
        "code": "example"
      },
      "categoryCode": "business",
      "sectionCode": "employmentPeriod",
      "fieldCode": "activate_at",
      "specifiedDate": "2022-12-01"
    }
}

RELATIVE_TRANSFER_DATE_REACHED / BELONGING_SAVED

people object
トリガー対象社員

transferDate string
人事異動の日付
YYYY-MM-DD フォーマットの文字列

post object
主務のデータ

additionalPosts array of object
兼務のデータ

例

{
    "id": "9999999999999999",
    "type": "RELATIVE_TRANSFER_DATE_REACHED",
    "triggeredAt": "2023-01-01T01:01:01.000000Z",
    "token": "example",
    "companyId": "9999999999999999",
    "data": {
      "people": {
        "id": "9999999999999999",
        "code": "example"
      },
      "transferDate": "2022-12-01",
      "post": {
        "department": {
          "id": "9999999999999999",
          "code": "example"
        },
        "position": {
          "id": "9999999999999999", 
          "code": "example"
        }
      },
      "additionalPosts": [
        {
          "department": {
            "id": "9999999999999999",
            "code": "example"
          },
          "position": {
            "id": "9999999999999999",
            "code": "example"
          }
        }
      ]
    }
}