Overview

スマレジ・プラットフォームAPI Timecard仕様書 ver.1.1.0

概要

エンドポイント

サンドボックス

https://api.smaregi.dev/{contract_id}/timecard

本番

https://api.smaregi.jp/{contract_id}/timecard

Path Parameters	説明
contract_id	対象の契約ID

ページネーション

一部のAPIではデフォルトで先頭から30個のアイテムを返します。
一度に返すアイテム数は limitパラメータで指定でき、上限は100個です。
取得する対象ページは page で指定できます( 1 始まり)。
並び順はsortパラメータで指定可能です。

QUERY PARAMETER	型	値
limit	integer	1 〜 100
page	integer	1 〜
sort	string	並び順を`パラメータ名`で昇順、`パラメータ名:desc`で降順で指定できます。カンマ区切りで複数項目を指定可能です。

リクエスト例）従業員リスト、10件ずつ表示の1ページ目、並び順がstaff_nameの降順の場合

https://api.smaregi.dev/{contract_id}/timecard/staffs/?limit=10&page=1&sort=staff_name:desc

ユーザー権限

ユーザー権限は管理画面上で設定が可能です。権限の詳細は以下の通りです。

[一般ユーザーアクセス時]

– 事業所の情報を取得する場合 –

一覧取得時	詳細取得時
権限が付与されている店舗の情報のみ	権限が付与されている店舗の情報のみ

– 従業員を指定して情報を取得する場合（閲覧権限なし） –

一覧取得時	詳細取得時
ログイン中のユーザーの情報のみ	ログイン中のユーザーの情報のみ

– 従業員を指定して情報を取得する場合（閲覧権限あり） –

一覧取得時	詳細取得時
権限が付与されている店舗に所属している従業員の情報のみ	権限が付与されている店舗に所属している従業員の情報のみ

– 従業員を指定して情報を編集する場合（編集権限なし） –

自身の情報	他従業員の情報
編集可	編集不可

– 従業員を指定して情報を編集する場合（編集権限あり） –

自身の情報	他従業員の情報
編集可	編集可

– 従業員、事業所どちらの指定もない情報を編集する場合–

編集権限がない店舗が１店舗以上ある	編集権限がある店舗、もしくは未設定の店舗のみ
編集不可	編集可

ログイン中のユーザーは設定された権限に関わらず、自身の情報にアクセス・編集することが可能です。

システム管理者は全ての権限が付与されています。

Information

OpenAPI version: 3.0.2

Authentication

AppAccessToken

アプリアクセストークン

{contract_id} には対象の契約IDを指定してください。

Security scheme type: oauth2

Flow type: clientCredentials

Token URL: https://id.smaregi.dev/app/{contract_id}/token

Scopes:

timecard.attendances:write - 打刻の更新ができます
timecard.shifts:read - 勤怠の参照ができます
timecard.shifts:write - 勤怠の更新ができます
timecard.salaries:read - 給与の参照ができます
timecard.salaries:write - 給与の更新ができます
timecard.daily-reports:read - 日報/日報タグの参照ができます
timecard.daily-reports:write - 日報/日報タグの更新ができます
timecard.stores:read - 事業所の参照ができます
timecard.staffs:read - 従業員の参照ができます
timecard.staffs:write - 従業員の更新ができます
timecard.holidays:read - 休暇の参照ができます
timecard.holidays:write - 休暇の更新ができます
timecard.settings:read - 設定の参照ができます
timecard.contracts:read - 契約情報の参照ができます

UserAccessToken

ユーザーアクセストークン
管理画面で設定した、ユーザー別権限が有効になります。
スマレジ・タイムカードサポート：事業所に所属する従業員用の役割(権限)を登録する

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: https://id.smaregi.dev/authorize

Token URL: https://id.smaregi.dev/authorize/token

Refresh URL: https://id.smaregi.dev/authorize/token