📋 ハレコード API

ハレコード API の外部連携・システム実装向けリファレンスです。
認証や共通仕様は本ページ、 共通エラーレスポンス とアプリ別の詳細は各ページを参照してください。

1. 🔑 基本情報・認証仕様

1.1 共通システム仕様

• Routing Function : appRouterApi
• Target App : 呼び出すアプリをクエリパラメータ ?app={appId} で指定（例: 生産日報は productionReport ）
• データ形式 : application/json (文字コード: UTF-8 )

1.2 認証・店舗識別

本APIは、リクエストヘッダーに含まれる x-api-key を用いて認証を行います。

💡 APIキーについて
店舗IDに紐づくAPIキーを x-api-key に設定してください。APIキーと店舗の紐づけ設定は、ハレコードの管理画面から事前に行う必要があります。

1.3 共通リクエストヘッダー

x-api-key: your-secret-api-key
Content-Type: application/json

1.4 ベースURL