お使いのInternet Explorer 11はサポートを終了いたしました。最新のブラウザにアップデートしてご覧ください。

アップデート情報

住所情報に関するAPIとWebhookを変更します


いつもSmartHRをご利用いただき、ありがとうございます。

2022年9月以降に、APIとWebhookで取得できる住所情報に対する変更を予定しております。APIまたはWebhookを使ったサービスをご利用いただいている場合、必ず以下の変更点をご確認、または開発担当者へご共有の上、ご対応をお願いいたします。

 

変更の背景

SmartHRでは開発速度をより向上させるためデータ構造の見直しを行っております。

開発速度の向上ためには、問題となりえる項目の統廃合が必要となります。本項目は、現在の利用実績と照らしあわせた際に、大きな影響がないことが確認できたため廃止を決定いたしました。

 

変更日

2022年9月以降を予定

※確定次第、本お知らせを更新いたします。

 

変更内容

これまで、APIのレスポンス、およびWebhookのペイロードに含まれていた、住所情報のidが取得できなくなります。APIのリクエストボディに関する変更はありません。

 

変更前の動き

{
  “address”: {
    “id”: “2e466ec5-ff55-42e9-8011-7209d3e73bdd”,
    “country_number”: ””,
    “zip_code”: “106-0041”,
    “pref”: “東京都”,
    “city”: “港区”,
    “street”: “麻布台4-5-6”,
    “building”: “スマートエイチアールビル 209”,
    “literal_yomi”: “トウキョウト ミナトク アザブダイ”
  }
}

変更後の動き

{
  “address”: {
    “country_number”: ””,
    “zip_code”: “106-0041”,
    “pref”: “東京都”,
    “city”: “港区”,
    “street”: “麻布台4-5-6”,
    “building”: “スマートエイチアールビル 209”,
    “literal_yomi”: “トウキョウト ミナトク アザブダイ”
  }
}

 

対象

  • API
    • GET /api/v1/crews/{id}
      • address, emergency_address, resident_card_addressのid
    • PATCH /api/v1/crews/{id}
      • address, emergency_address, resident_card_addressのid
    • PUT /api/v1/crews/{id}
      • address, emergency_address, resident_card_addressのid
    • GET /api/v1/crews
      • address, emergency_address, resident_card_addressのid
    • POST /api/v1/crews
      • address, emergency_address, resident_card_addressのid
    • GET /api/v1/crews/{crew_id}/dependents/{id}
      • addressのid
    • PATCH /api/v1/crews/{crew_id}/dependents/{id}
      • addressのid
    • GET /api/v1/crews/{crew_id}/dependents
      • addressのid
    • POST /api/v1/crews/{crew_id}/dependents
      • addressのid
    • GET /api/v1/users/{id}
      • crew以下のaddress, emergency_address, resident_card_addressのid
    • GET /api/v1/users
      • crew以下のaddress, emergency_address, resident_card_addressのid
    • GET /api/v1/companies
      • addressのid
      • owner以下のaddress, emergency_address, resident_card_addressのid
    • GET /api/v1/biz_establishments
      • soc_ins_address, lab_ins_address, salary_payer_addressのid
      • soc_ins_owner, lab_ins_owner以下のaddress, emergency_address, resident_card_addressのid
  • Webhook
    • 従業員の追加/更新/削除/インポート
      • address, emergency_address, resident_card_addressのid

SmartHR API仕様書はこちら

 

最後に

SmartHRでは、ご利用企業の声を積極的にサービス開発の参考にしていきたいと考えております。機能や画面のデザインなど、なにか気になることがございましたら、お気軽にお伝えください。

SmartHRの機能追加、改善に関する情報は「アップデート情報」や「リリースノート」にて、株式会社SmartHRの企業情報に関するニュースはFacebook・Twitterからもお知らせしています。

よろしければ「いいね!」「フォロー」をお願いします。

今後とも、SmartHRをよろしくお願いいたします。