Skip to main content
ORCA
MES
JP

Open APIキーの発行・管理

OPEN APIの説明手順です。

必要に応じてORCAチームが連携をサポートします。

発行前の確認

  • 法人master accountでORCAにログインします。
  • Proモデル以上の契約が必要です。
  • keyは発行user情報で検証され、選択式または追加scopeはありません。

ORCAでkeyを発行

  1. 連携管理 → Open APIキー管理を開きます。
  2. Key作成を選択し、識別名と必要に応じて有効期限を入力します。
  3. 作成直後に表示される原文keyをコピーします。以降はAPIキー管理の詳細から再度コピーできます。
ORCA APIキー作成modal。キー名と有効期限(任意)を入力した画面ORCA APIキー作成直後のmodal。原文キーとコピーボタンがある画面ORCA APIキー詳細modal。原文キーを表示しコピーできる画面

ORCA OPEN API key management →

保管ルール

  • Browser、mobile app、公開repository、注文DBに保存しません。
  • Authorization headerと原文keyをlogに残しません。
  • 漏洩の疑いがある場合は新規発行後に既存keyを廃棄します。

照会・廃棄

一覧では名前、prefix、状態、作成日、有効期限、最終使用日のみ確認できます。

原文keyは詳細から再度コピーでき、廃棄後は直ちに認証できません。

廃棄済みkeyは一覧から削除できます。有効なkeyは先に廃棄してください。

発行できない場合は、ORCA運用担当者がMaster Adminの入店社外部連携管理で権限とkey状態を確認します。

ORCA APIキー管理画面。名前、prefix、状態、作成日、最終使用、有効期限が一覧表示された画面

Next: Sales-order integration →