他のソフトウェアにデータを読み取らせる

API Studio：一度に1つの画面を公開し、キーを発行し、それをアドレスに固定し、AIエージェント用のMCPサーバーとして同じ公開を行います。

遅かれ早かれ、TRANXACTの外部の何らかのシステムがあなたのデータを必要とするでしょう。例えば、レポート作成ツール、パートナー企業のシステム、価格表を必要とするウェブサイト、あなたのビジネスに関する質問を受けたAIエージェントなどです。プラットフォームの下にあるAPI Studioでは、どのシステムへのデータ提供を許可するかを、画面ごと、列ごとに設定できます。

誰かが公開するまでは、外部から何もアクセスできません。すべてを開く設定も、すべてにアクセスできる鍵もありません。新規デプロイメントにはAPIインターフェースが一切なく、それが正しい開始状態であり、有効化されるのを待っている状態ではありません。

4つの決定事項は、順に

何	決定事項	普段は誰が作るのか
暴露	その画面が会社から完全に削除される可能性があるかどうか、どの列、どの行が削除される可能性があるか、そして何かが書き戻される可能性があるかどうか。	データの所有者は誰であれ
クライアント	そのソフトウェアが存在すること、その名称、問い合わせ先、そしてそれがあなたのどのユーザーとして動作するのか。	統合を実行するのは誰であれ
助成金	このクライアントがこれらの動詞を使って、その露出度に到達できる可能性がある。	統合を実行するのは誰であれ
許可された住所	キーが提示される場所（ブラウザの発信元、ホスト、単一のサーバーアドレス、またはネットワーク）など。	統合を実行するのは誰であれ

このプラットフォームでは、この目的のために3つの役割が用意されており、意図的にそれぞれが独立しています。APIパブリッシャーは、何が公開できるかを決定しますが、キーを発行することはできません。APIレジストラはキーを発行しますが、公開を作成することはできません。APIレビュー担当者はすべてを読み取りますが、何も変更しません。給与テーブルを公開し、それを読み取るキーを自分自身に発行するという一連の操作は、1人の担当者が行う完全な非公開のエクスポートパスであり、すべてのステップが通常の管理変更のように見えます。

画面を公開する

プラットフォーム → API Studio を開き、画面を選択します。リストには、コンソールに存在するすべての画面が表示されます。これは製品自体から読み取られたもので、今回のリリースで追加された画面も含まれています。
送信する可能性のある列にチェックを入れてください。チェックが入っていない項目は、リストにも、個々のレコードにも、書き込み結果にも一切含まれません。そもそも、意図的に何もチェックを入れないでください。
動詞を決めましょう。読み取りはデフォルトで有効になっています。作成、変更、削除はそれぞれ別の決定事項です。なぜなら、相手のシステムにアイテムマスターを読み取らせることと、相手のシステムにアイテムマスターを削除させることは、同じ文ではないからです。
必要に応じて、表示行を制限できます。例えば、投稿済みの請求書のみ、今年分のみなどです。これは、すべてのリスト画面で使用されているフィルターと同じもので、サーバー側で呼び出しごとに適用され、発信者が送信する内容によって制限範囲が広がることはありません。
保存しておきましょう。これは下書きです。下書きは何も生み出しません。本当に必要だと感じた時に、形にしましょう。
キーを誰かに渡す前に「プレビュー」を押してください。パートナーが受け取る内容と、保留される列数が正確に表示されます。

ソフトウェアの登録

クライアントとは、ソフトウェアの記録です。そのソフトウェアの名前、機能、問い合わせ先、そして最も重要なのは、どのユーザーとして動作するかという情報が含まれます。キーが行うすべての呼び出しは、そのユーザーとして行われます。ユーザーが実行できない操作は、キーも実行できません。

それは画面上で最も重要なフィールドであり、だからこそ、露出によってアクセス権限が制限されることはあっても、決して拡大されることはないのです。キーは、その目的のために作成され、必要な最小限の役割を持つユーザーに向けるべきであり、都合が良いからといって実際の管理者に向けるべきではありません。

キー自体は発行時に一度だけ表示され、その後は二度と表示されません。新しいキーを発行すると、古いキーは即座に無効になります。キーはクライアントを削除せずに取り消すことができるため、レジスタには誰がいつアクセスできたかが記録されます。

キーが使用できる場所

許可されたアドレスがないキーは、何も到達できません。アドレスが指定されていないということは、まだ到達できない状態であり、どこからも到達できない状態であると解釈されます。なぜなら、世界中のどのラップトップからでも動作する漏洩したキーが、リスクのすべてだからです。エントリの種類は、ブラウザの発信元、参照ホスト、単一のアドレス、またはCIDR形式のネットワークの4種類です。

クライアントはどこからでも利用可能としてマークすることができ、実際に送信先アドレスが移動するパートナーなど、それが正しい場合もあります。これはデフォルト設定ではなく、警告を伴う意図的な切り替えです。

統合する人に何を送るべきか

スタジオは4つのアドレスを表示します。ベースアドレスは/api/v1で、キーはAuthorization: Bearerヘッダーに含まれ、/api/v1/resourcesにはこのキーでアクセスできるリソースが一覧表示され、/api/v1/openapi.jsonはOpenAPI 3.1ドキュメントと同じです。

どちらも、それらを要求するキーから生成されます。パートナーに、呼び出し不可能なエンドポイントを40個もリストアップしたドキュメントが渡されることは決してありません。パートナーに渡されるドキュメントには、呼び出し可能なエンドポイントのみが正確に記述されており、それ以外の情報は一切含まれていません。また、リクエストハンドラーがチェックするのと同じ行から構築されているため、拒否されるパスを記述することもできません。

AIエージェント用の同じデータ

アドレス /api/v1/mcp はモデルコンテキストプロトコルサーバーです。このサーバーに接続するエージェントには、キーが実行できる各操作に対応するツールのみが提供されます。つまり、誰も公開していないデータに対するツールも、誰も許可していない動詞に対するツールもありません。これは開発者向けではなくモデル向けに記述された同一の公開情報であるため、両者がずれることはありません。

MCPの手順はクライアント側に記述してください。モデルに対して、これらのツールがサンドボックスではなく実際の台帳にアクセスすることを指示できるのはここだけであり、ここでいう「注文」が販売注文ではなく購入注文を意味することを指定できるのもここだけです。

すべての通話で何が起こるか

公開された呼び出しは、データベースへのショートカットではありません。認証され、公開範囲と権限がチェックされた後、プラットフォーム独自のAPIを介して実行ユーザーとして実行されます。これはコンソールが使用するのと同じ経路です。会社スコープ、事業部門スコープ、場所の制限、閉鎖期間、投稿ルール、カスタムフィールド、カスタムロジック、編集可能性、監査証跡など、すべて同じコードが実行されるため、適用されます。

すべての呼び出しは、許可または拒否された理由とともに記録されます。そのログは「プラットフォーム」→「API Studio」→「API呼び出しログ」にあり、誰も許可していないアドレスから提示されたキーは、そこで生成される最も興味深い行です。

うまくいかない場合

パートナーが見るもの	それはどういう意味か
そのAPIキーは認識されません	鍵が間違っているか、あるいはその後新しい鍵が発行された可能性があります。
このAPIキーには許可されたアドレスがありません	現時点では、それがどこから使用されるのかは誰も述べていない。
このAPIキーはここから使用することはできません	これは、実際にデータが届いた発信元と住所を示します。通常、パートナー企業がサーバーを移転しています。
Xとしてここに掲載されるものはありません	名前が間違っているか、このキーに公開権限が付与されていないか、あるいはまだ草稿段階である。
このキーではXを作成できない可能性があります	その露出や許可では、その動詞は許可されません。
X を閲覧する権限がありません	助成金は問題ありませんが、実行ユーザーの設定は問題があります。スタジオはパートナーがこれらの問題を見つける前に、これらの情報を一覧表示します。

クライアントリストには、ステータスだけでなく準備状況を示す列も表示されます。なぜなら、クライアントがアクティブでキーを保持していても、実行できるユーザーがいなかったり、アドレスが許可されていなかったり、何も許可されていなかったりする可能性があるからです。アクティブと表示されているのに、すべての呼び出しが拒否されるというのは、まさに午後の過ごし方です。