APIを使ってSmartHRとLINE WORKSを連携する ―第1回 APIとは?
shradminこんにちは。
テクバン株式会社でSmartHRという
クラウド製品の連携開発を行っている担当者です。
日々の業務で、目的や用途に応じて社内のシステムやクラウド製品を
いくつも並行して活用する際に、
・こちらのシステムで更新した情報を別のシステムへ連携したい
・業務フローの進捗状況を確認するのに、そのシステムへ毎度アクセスするのは面倒だ
このようなお悩みを抱いたことはありませんか？
テクバンでは、クラウド人事労務ソフトとして国内シェアNo.1を誇るSmartHRと
主にビジネスに用いられるクラウド製品をAPIという技術を利用して連携する開発を行っています。
機能の異なる各製品同士を連携することで、
各製品間の登録データや機能をやり取りできるようになり、
現在お使いの業務システムをより便利に活用することができます。
たとえば、入退社手続きや年末調整などの人事労務手続きによって更新された
SmartHRの従業員情報を他システムへ渡したり、ほかの業務システムへ取り込める形式で
ファイル出力したりすることができます。
さらに、これから連携方法をご紹介するLINE WORKS※のような
ビジネス向けのチャットツールと連携すると、人事労務手続きの状況を
お使いのチャットツール上に通知できるようになり、手続き状況の認識のズレや漏れを防げます。
※SmartHRとLINE WORKSを連携すると、SmartHR上に登録されている従業員情報などが登録・更新・削除されたタイミングでLINE WORKSのBotという機能を使ってトーク上に通知を送ることができます。
このように、 業務上様々なクラウドシステムを使い分ける中で
非効率的に行われていた業務を効率化・簡略化できます。
本ブログでは、これから全5回にわたって"API"という仕組みを使ってSmartHRとLINE WORKSという
ビジネスツールを連携する方法についてご紹介していきます。
連携を構築するにあたって、まずは
✔ "API"とはどういうものなのか？
✔ "API"を使うことでどのようなことができるのか？
というところについてお話ししていきます。
目次
APIとは何だろう
皆さんは、
"API"や"Web API","API連携"
という言葉を聞いたことがありますか？"API"とは、
「Application Programming Interface (アプリケーション プログラミング インターフェース)」
の略称で、その名の通り
"アプリケーションをプログラミングするためのインターフェース※" ということなのですが
具体的には、次のようなことをいいます。
※インターフェース…「何か」と「何か」をつなぐもの。
データや指示などをやり取りするために必要な手順や形式を定めたもののこと。
システムのある機能を、その機能とは無関係なシステムから呼び出して利用したい場合、
システム内のコンピュータプログラムなどから、その機能を呼び出して利用できるようにする
必要があります。
そのために用意されている決まり事のことを"API"と呼んでいます。
また、"Web API" は、
インターネット回線を経由してやり取りできる"API"のことを指します。
クラウドサービスツールのほとんどは、この"Web API"を使ってインターネット経由で
他のツールとの連携を可能にしています。
USBが外部デバイスとパソコンを繋ぐインターフェースであるように、
"API"はシステム同士を繋げる役割を担っています。
このような"API"という仕組みを外部に向けて公開することにより、
オンライン上で様々なことができます。
たとえば、
・異なるソフトウェアやサービス間で認証機能を共有する
・チャット機能の共有
・片方から数値データを取り込み、別のプログラムでそのデータを解析する
など、1つのシステムだけではできなかったことを可能にする余地がたくさん生まれるので、
痒い所に手が届くような業務課題の解決が実現します。
"API"を使って異なるツール同士を連携することで単調な業務や複雑なワークフローを簡素化することができ、日頃の業務をより効率的に進めることができます。
出典：『インターフェース（interface）とは - IT用語辞典 e-Words』
https://e-words.jp/w/%E3%82%A4%E3%83%B3%E3%82%BF%E3%83%BC%E3%83%95%E3%82%A7%E3%83%BC%E3%82%B9.html
『API(アプリケーションプログラミングインターフェース)とは』
https://e-words.jp/w/API.html
『APIとは｜「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典』
https://wa3.i-3-i.info/word12428.html
『ウェブ API (Web API)とは｜「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典』
https://wa3.i-3-i.info/word12429.html
『今さら聞けないIT用語：やたらと耳にするけど「API」って何？』
https://data.wingarc.com/what-is-api-16084
SmartHR APIについて
クラウド人事労務ソフトSmartHRでは、
主にビジネスに用いられる多種多様なシステムと連携できるように
APIが公開されています。
● API連携できる主な項目
| 従業員情報 | 家族情報 | 部署情報 |
|---|---|---|
| 登録 | 登録 | 登録 |
| 更新, 部分更新 | 部分更新 | 部分更新 |
| 削除 | 削除 | 削除 |
| 取得, リスト取得 | 取得, リスト取得 | 取得, リスト取得 |
・従業員情報
氏名, 生年月日, 住所, 連絡先 など、従業員一人一人の情報を
登録、更新・部分更新、削除、取得・リスト取得(リストとして全取得) することができます。
・家族情報
SmartHRに登録されている従業員のご家族の氏名, 生年月日, 住所, 連絡先などの情報を
登録、部分更新、削除、取得(リストとして全取得) することができます。
・部署情報
SmartHRに登録されている従業員が所属する部署名などの情報を
登録、部分更新、削除、取得(リストとして全取得) することができます。
SmartHR APIの活用方法
このようなAPIを使用することで、
様々なシステムやアプリケーションと連携することができます。
たとえば、SmartHRと以下のようなシステムと連携することで次のようなことが実現できます。
・データ連携(採用管理サービス, 勤怠管理サービス)
…SmartHRに登録した従業員情報を勤怠管理システムへ連携したり、
採用者(内定者)の情報(氏名,生年月日,連絡先etc)をSmartHRへ自動的に連携する
・通知連携(チャットツール)
…SmartHR上で行われた手続きをチャットツール上(トークルームetc)に通知する
なおテクバンでは、現在以下の製品との連携開発を行っております。
チャットツールとの連携
チャット上に手続きの進捗などを通知することができる通知連携ですが、
現在、SmartHRと通知連携できるチャットツールは
主に3種類あります。
| Slack | Chatwork | Teams |
| ビジネス向け メッセージングアプリケーション | 国内利用者数No.1 ビジネスチャットツール | office365に搭載されてる ビジネスチャットツール |
| 連携方法 | 連携方法 | 連携方法 |
これらのほかにも"API"を使用すれば、
国内有料ビジネスチャットとして3年連続国内シェアNo.1の
LINE WORKSとも通知連携することができます。
ここからは、全5回にわたって
これら2つのツールをAPI連携して、
SmartHR上で行われた手続きによって登録・更新・削除された従業員情報を
LINE WORKSのトークBot内に通知する方法
をご紹介していきたいと思います。
連携する各ツールと連携時のイメージ
まずは、今回連携する各ツールについて簡単にご紹介します。
SmartHR
人事・労務の手続きをWeb上で行える、クラウド人事労務ソフトです。
LINE WORKS
SNSコミュニケーションアプリ『LINE』の機能・UIを踏襲した、
ビジネス用コミュニケーションツールです。
これらを次のような流れで連携していきます。
① 従業員登録・更新・削除・インポートトリガー 作動
② LINE WORKSのServer Tokenを取得
③ LINE WORKSのServer Tokenを受け取る
④ 従業員登録・更新・削除・インポート通知メッセージを送信
上の図のような連携の流れをイメージしながら、
LINE WORKSのチャット上にメッセージを通知するための"Bot"を作成していきます。
第2回からは、このBotの作成手順について詳しくご紹介していきます。
>> APIを使ってSmartHRとLINE WORKSを連携する ―第2回 認証キーの設定
関連記事
>> APIを使ってSmartHRとLINE WORKSを連携する ―第2回 認証キーの設定
>> APIを使ってSmartHRとLINE WORKSを連携する―第3回 Botサーバの用意
>> APIを使ってSmartHRとLINE WORKSを連携する ―第4回 通知用のBotを作成し、公開する
>> APIを使ってSmartHRとLINE WORKSを連携する ―第5回 Webhookを設定し、動かしてみる
