Carely APIについて
はじめに
2020/09にCarelyのAPIを公開しました。
まず第一弾として人事情報のAPIを公開しています。
APIドキュメントへ詳細は記載していますが、本記事では使い方のご紹介をしたいと思います。
Carely APIで何ができるか?
最初にCarely APIで可能なことについてですが現時点では人事情報に関わるデータの取得、登録が可能です。
具体的には従業員情報の照会、変更、新規登録や登録グループ、部署、事業場などの情報の照会が可能です。
今後、残業時間やその他の機能についても順次開発していく予定です。
Carely APIを使った利用例
Carely APIを使って従業員情報の更新、登録をおこなうプログラムを公開しました。
READMEにも記載しているのですがスプレッドシートで管理している従業員情報をSlackのアプリ経由で @CarelyApi check
で変更情報を通知したり @CarelyApi run
で従業員情報を登録するプログラムです。
処理自体はAWS Lambda上で実行することを想定で作成しています。
実際にiCARE社内でも使っており、今までスプレッドシートからCSVをExportしてCarelyへImport(もしくは手入力)としていたところがSlackからサッと実行できるようになっております。
slackでの実行画面のサンプルは以下のような感じです。
APIで従業員情報の取得や更新する箇所のプログラムを参考のためURLを記載しておきます。
従業員情報の取得:
https://github.com/icare-jp-oss/carely-api-client-for-lambda-ruby/blob/master/app/graphql/graphql_query.rb
その他手順
Carely APIを使うためのアクセストークンを取得する手順についてはAPIドキュメントの「アクセストークンの取得方法」へ記載しています。
またCarely APIの利用例で使っているSlackとAWS Lambdaの連携手順やgoogle スプレッドシートをAPIで操作する手順もQiitaへ記事を投稿しているので興味のある方はご覧ください!
最後に
Carelyに興味があるよって方はお問い合わせよりご連絡ください。
今後も残業時間やその他機能のAPIを開発予定ですので是非使ってみて下さい!