API¶

Gem Logic API を使用すると、外部システムとの統合やワークフローの自動化が可能になります。商品、販売、連絡先、修理、在庫カウント、印刷ジョブをプログラムで管理できます。

設定 ‣ API へ移動して、API キーを作成・管理してください。

認証¶

すべての API リクエストは、HTTP ヘッダー x-api-key に API キーを含める必要があります。キーは設定 ‣ API ページから作成できます。キーはいつでも無効化または削除できます。

リクエスト例:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

危険

API キーは秘密として保管してください。公開リポジトリやクライアントサイドのコードで共有しないでください。キーが漏洩した場合は、直ちに無効化し新しいキーを作成してください。

ベース URL¶

すべてのエンドポイントは、お客様のインスタンス URL の /api/ プレフィックス配下を基準とします:

https://your-instance.gem-logic.com/api/

レスポンス形式¶

すべてのレスポンスは JSON 形式で返されます。成功したリクエストは ``200``（GET の場合）または ``201``（POST の場合）のステータスコードを返します。エラーは適切なステータスコードとメッセージを返します:

200 OK — 成功した GET リクエスト
201 Created — 成功した POST リクエスト
400 Bad Request — 無効または欠落したデータ
401 Unauthorized — 無効または欠落した API キー
404 Not Found — リソースが存在しません

エンドポイント¶

販売チャネル¶

メソッド	`GET`
URL	`/api/marketplaces/`
説明	すべての販売チャネルのリストを返します。

レスポンスフィールド:

フィールド	型	説明
`id`	integer	一意識別子
`marketplace`	string	マーケットプレイス名

商品¶

商品一覧の取得

メソッド	`GET`
URL	`/api/products/{marketplace_id}`
説明	マーケットプレイスでフィルタリングされた商品を返します。marketplacesエンドポイントから取得したマーケットプレイスIDを使用してください。

レスポンスフィールド:

フィールド	型	説明
`id`	integer	一意識別子
`item_sku`	string	商品SKU
`created`	datetime	作成日
`status`	string	商品ステータス
`images`	array	商品画像のリスト (`id`、`image`)
`item_weight`	decimal	重量
`item_height`	decimal	高さ
`item_length`	decimal	長さ
`item_width`	decimal	幅

商品画像を作成する

メソッド	`POST`
URL	`/api/products/create/image/`
説明	base64エンコーディングを使用して商品画像をアップロードします。商品のSKUがまだ存在しない場合は、新しい商品が自動的に作成されます。

リクエストフィールド:

フィールド	型	必須	説明
`item_sku`	string	はい	画像を添付する商品のSKU
`image`	string (base64)	はい	Base64エンコードされた画像データ

販売¶

販売一覧を取得する

メソッド	`GET`
URL	`/api/sales/`
説明	すべての販売注文の一覧を返します。

レスポンスフィールド:

フィールド	型	説明
`order_id`	string	注文の一意の識別子

販売を作成する

メソッド	`POST`
URL	`/api/sales/create/`
説明	新しい販売注文を作成します。

連絡先¶

メソッド	`GET`
URL	`/api/contacts/`
説明	すべての連絡先の一覧を返します。

レスポンスフィールド:

フィールド	型	説明
`id`	integer	一意識別子
`complete_name`	string	氏名
`contact_type`	string	連絡先のタイプ
`email`	string	メールアドレス
`phone`	string	電話番号
`language`	string	優先言語

修理¶

修理を作成

メソッド	`POST`
URL	`/api/repairs/create/`
説明	関連する修理品目を含む新しい修理注文を作成します。販売チャネルまたは部門が指定されていない場合、利用可能な最初のものが使用されます。

リクエストフィールド:

フィールド	型	必須	説明
`client_id`	integer	いいえ	顧客/連絡先のID
`marketplace`	文字列 / 整数	いいえ	販売チャネルIDまたは名前
`division_id`	integer	いいえ	部門ID
`title`	string	いいえ	修理品目のタイトルまたは説明
`repair_info_1`	string	いいえ	追加の修理コメント
`repair_info_2`	string	いいえ	追加の修理コメント
`repair_info_3`	string	いいえ	追加の修理コメント
`quantity`	decimal	いいえ	数量(デフォルト:1)
`weight`	decimal	いいえ	品目重量
`weight_unit`	string	いいえ	重量単位
`size`	string	いいえ	品目サイズ
`color`	string	いいえ	品目カラー
`engravement`	string	いいえ	刻印テキスト
`client_reference` \| string		いいえ	顧客参照番号

レスポンス例:

{"message": "Repair created successfully.", "order_id": "R-0001"}

修理に商品を追加

メソッド	`POST`
URL	`/api/repairs/add-item/`
説明	既存の修理注文に新しい商品を追加します。

リクエストフィールド:

フィールド	型	必須	説明
`order_id`	string	必須	商品を追加する修理の注文ID
`item_sku`	string	いいえ	商品にリンクする製品SKU
`title`	string	いいえ	タイトルまたは説明
`repair_info_1`	string	いいえ	追加の修理コメント
`repair_info_2`	string	いいえ	追加の修理コメント
`repair_info_3`	string	いいえ	追加の修理コメント
`quantity`	decimal	いいえ	数量(デフォルト:1)
`weight`	decimal	いいえ	品目重量
`weight_unit`	string	いいえ	重量単位
`size`	string	いいえ	品目サイズ
`color`	string	いいえ	品目カラー
`engravement`	string	いいえ	刻印テキスト
`client_reference` \| string		いいえ	顧客参照番号
`cost`	decimal	いいえ	商品の原価

在庫棚卸¶

在庫棚卸を作成

メソッド	`POST`
URL	`/api/inventory-counts/`
説明	新しい在庫棚卸セッションを作成します。

レスポンスフィールド:

フィールド	型	説明
`id`	string	在庫棚卸ID
`created_at`	datetime	作成タイムスタンプ
`status`	string	常に `active`
`tag_count`	integer	棚卸済み製品数

在庫棚卸製品の一覧

メソッド	`GET`
URL	`/api/inventory-counts/{inventory_count_id}/products/`
説明	特定の在庫棚卸で棚卸されたすべての製品を返します。

レスポンスフィールド:

フィールド	型	説明
`id`	string	一意識別子
`created_at`	datetime	製品が棚卸された日時
`product_sku`	string	商品SKU
`product_name`	string	製品名
`quantity`	integer	カウント数量

印刷ジョブ¶

メソッド	`POST`
URL	`/api/print-pdf/`
説明	特定のプリンターの印刷キューにPDFファイルをアップロードします。ファイルは形式とセキュリティの検証が行われます。最大ファイルサイズは20 MBです。``multipart/form-data``コンテンツタイプを使用してください。

リクエストフィールド:

フィールド	型	必須	説明
`pdf`	ファイル	必須	印刷するPDFファイル(最大20 MB)
`printer_uuid`	UUID	必須	対象プリンターのUUID
`landscape`	真偽値	いいえ	横向きモードで印刷(既定値:false)

リクエスト例:

curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -F "pdf=@document.pdf" \
  -F "printer_uuid=YOUR_PRINTER_UUID"

レスポンス例:

{"status": "queued", "print_job_id": 42}

対話型APIエクスプローラー¶

Gem LogicにはSwagger UIを使用した対話型APIエクスプローラーが組み込まれています。:menuselection:`設定 --> API`ページの:guilabel:`APIドキュメント`リンクからアクセスできます。エクスプローラーを使用すると、各エンドポイントをブラウザから直接お試しいただけます。

参考

統合