APIドキュメント

Shifton APIとの接続と作業

そのShifton APIは、プラットフォームのすべての主要機能—スケジュール管理から外部HR, 給与計算、および分析システム.
への統合までにアクセスできます。APIを使用することで、プロセスを自動化し、Shiftonを貴社の内部サービスと接続できます。


APIドキュメント

私たちは二つのバージョンのドキュメントをサポートしています。


開始するには

APIキーを取得する

Shiftonプラットフォームの会社設定でAPIキー.
を生成します。認証はヘッダー経由で行われます。

Authorization: Bearer {your_api_key}

最初のリクエストを送信する

例えば、従業員のリストを取得するには:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

例の応答:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

APIをワークフローに統合する

  • 自動的にシフトを作成および変更する

  • 休暇と病気休暇のリクエストを管理する

  • 給与計算システムにデータをエクスポートする

  • カスタムダッシュボードとレポートを作成する


コアAPI機能

  • 従業員 – 追加、編集、役割の管理

  • スケジュール – シフトを作成、調整し、作業を計画

  • 休暇&欠勤 – 休暇申請及び病欠申請の管理

  • レポート – 時間、給与、出席データのエクスポート


エラーコード

Shifton APIは標準的なHTTPステータスコード:

  • 200 — リクエスト成功

  • 201 — オブジェクトが正常に作成されました

  • 400 — 無効なパラメータ

  • 401 — 認証エラー(無効なAPIキー)

  • 403 — アクセス拒否

  • 404 — リソースが見つかりません

  • 500 — サーバーエラー


使用のヒント

  • 常に新しいAPIバージョン を新しい統合に使用してください

  • Postman」や「curl」を使ってテストします

  • ブロックされないようにレート制限を守ります

  • 古いドキュメントに依存している統合を更新します


この投稿を共有する