認証
すべての Partner API リクエストを、組織の API キーで認証します。
すべてのリクエストには、ベアラートークンとして API キーが含まれます。
Authorization: Bearer mor_live_7f3c1a9e…キーは〜に属します 組織、それを作成した人ではなく組織のものです。その人が退職しても引き続き機能し、組織の管理者なら誰でも一覧で確認して取り消せます。
キーを作成する
設定を開く
Morphic Studio で、組織のドロップダウン（左上の Morphic ロゴ）を開き、「設定」を選択します。
API キーへ移動
左サイドバーで、 API キー。このタブは管理者にのみ表示されます。
キーを作成
次をクリックします 新しいキー、1か月後に見ても分かる名前を付け、スコープを選択し、さらに永続させたくない場合は有効期限を設定します。
シークレットをコピー
シークレットは一度しか表示されません。Morphic はそのハッシュのみを保存するため、再表示はできません。ダイアログを閉じる前にシークレット管理ツールに保存してください。
キーを持っている人は、組織のクレジットを消費する実行を開始できます。パスワードのように扱ってください。コミットしない、ブラウザに入れない、メールやチャットで送らないでください。
スコープ
キーは、付与したスコープのみを持ちます。それらの範囲外のリクエストは次のエラーで拒否されます： access_denied.
| スコープ | 許可する内容 |
|---|---|
workflows:read | ワークフローと、そのワークフローが受け取る入力を読み取る |
runs:write | 実行の開始、および webhook エンドポイントの登録と削除 |
runs:read | 実行のステータスと完了したアセットの読み取り、および webhook エンドポイントの一覧表示 |
キーは次のようにも制限できます： 特定のワークフロー。それ以外の開始は拒否され、それ以外の実行は not found として扱われます。これは、1 つの連携に限定されたキーにとって望ましい挙動です。
環境
プレフィックスでキーがどのデプロイに属するかが分かるため、漏洩したキーも一目で判別できます。別のデプロイに提示されたキーは拒否されます。
| プレフィックス | 環境 | ベース URL |
|---|---|---|
mor_live_ | 本番 | https://api.morphic.com/v1/partner |
mor_test_ | ステージング。連携作業用で、そこでの実行には上限があり、データはあなたのものではありません | https://api.morphic.today/v1/partner |
クレジット上限
すべてのキーには、使用できるクレジットの上限があり、作成した管理者が設定します：
| 制限 | 設定済み？ | 意味 |
|---|---|---|
| 合計 | 常時 | キーが使用できるクレジットの総上限 |
| 1日あたり | 任意 | UTC 1日あたりのクレジット |
| 1か月あたり | 任意 | UTC 1か月あたりのクレジット |
1日は UTC の 1 日で、1か月は UTC の暦月です。キーのいずれかの上限を超える請求は、次のエラーで拒否されます： api_key_credit_limit_reached; エラーの error_attributes.period は、どの上限（合計, 月次 または 日次）を示します。これは、組織のクレジット不足（credits_exhausted）とは別の条件で、対処方法も異なります。管理者は組織をチャージするのではなく、Studio でキーの上限を引き上げます。キーに残り枠がない開始は、何も取得される前に拒否されます。
キーで開始された実行は、Studio のチャットに誰かが入って引き継いでも、そのキーに対して引き続きカウントされます。つまり、キーの残り予算は自動処理部分だけでなく、実行全体の予算です。
ローテーション
重なりを持たせてローテーションし、空白期間を作らないでください。新しいキーを作成してデプロイし、トラフィックが移ったことを確認してから、古いキーを取り消します。組織は最大で次の数のキーを保持できます： 認証に使えるキーを 10 個 を同時に保持できるため、誰も整理しない状態で積み上がることなくローテーションできます。
取り消しは数秒以内に効力を発揮します。すでに進行中の実行は完了し、料金も発生します。