自社システムにAPIがあるか確かめる方法と、開発会社への聞き方

APIとは何か(30秒で)

APIは、ほかのシステムが決まった手順でデータを取り出したり登録したりするための窓口です。人が画面を開いて見る代わりに、プログラムが「この期間の売上を返して」と頼み、システムが決まった形式で答えます。

AIに業務システムのデータを聞けるようにするには、この窓口が必要です。窓口の一覧と使い方を書いた資料が「API仕様書」、窓口を使うための合言葉が「APIキー」や「トークン」です。

自分で確かめられる5つの手がかり

開発会社に聞く前に、社内で次の5点を見てください。1つでも当てはまれば、APIがある可能性が高くなります。

1. ほかのシステムと自動でデータが行き来している
   ECサイトの注文が自動で販売管理に入る、会計ソフトに売上が自動で送られる、スマホアプリから在庫が見える。こうした連携は、多くの場合APIで作られています。
2. 納品物や契約書に、それらしい資料名がある
   「API仕様書」「外部インターフェース仕様書」「連携仕様書」「IF一覧」「外部IF設計書」などの名前を探します。Excelの設計書の1シートとして入っていることもあります。
3. 管理画面に「API」「連携設定」「トークン」の項目がある
   設定メニューに、キーの発行や連携先の登録の画面があれば、APIが用意されています。
4. Webブラウザから使うシステムである
   ブラウザで開くシステムは、画面の裏でAPIを使って作られていることが多くあります。ただし、外部向けに使ってよい窓口かどうかは別の話なので、開発会社への確認が必要です。
5. 見積書や請求書に「API」「連携」の項目がある
   過去にAPIの追加開発を依頼していれば、その記録が残っています。

APIがあっても使えないケース

APIがあることと、AIから使えることは同じではありません。次のどれかに当てはまると、追加の対応が必要です。

• 社内ネットワークの中からしか呼べない:ChatGPTやClaudeはクラウドから接続先にアクセスするため、インターネットから届かないシステムにはそのままでは接続できません。
• 呼べる場所(IPアドレス)が限定されている:特定の連携先からしか受け付けない設定だと、許可の追加が必要です。
• 特定の連携専用で、鍵を新しく発行できない:EC連携のためだけに作られ、ほかの用途の鍵を発行する仕組みがない場合です。
• データを登録する窓口しかない:受注を送り込む用のAPIだけで、売上や在庫を取り出す窓口がない場合は、AIに聞く用途には使えません。

開発会社に聞く8項目

ここで聞き漏らすと、後で何度も往復することになります。次の8項目をまとめて聞いてください。

8番目は見落とされがちです。仕様書の扱いや外部からの利用は、開発会社との契約内容によって異なります。後で揉めないよう、最初に文面で確認しておきましょう。

依頼文のひな形

メールにそのまま貼って使えるよう、専門用語を減らした文面にしています。[ ]の部分を自社に合わせて書き換えてください。

最後の「特に知りたいこと」を具体的に書くと、開発会社が該当する窓口を探しやすくなり、回答が早く、正確になります。

仕様書を受け取ったら確認すること

• 版と日付:システムを改修した後の版か。古い仕様書だと、項目名や窓口が変わっていることがあります。
• 窓口の一覧:「何を渡すと、何が返ってくるか」が窓口ごとに書かれているか。
• 項目の意味:「kbn」「flg」のような略語の意味が書かれているか。区分の値(1=通常、2=返品など)の説明がないと、AIも人も誤読します。
• 認証の説明:鍵をどこに付けて送るかが書かれているか。
• 実際の例:返ってくるデータの例があると、確認が格段に楽になります。

仕様書は完璧でなくて構いません。足りない点は、実際にAPIを呼んで返ってきたデータを見ながら埋めるのが確実です。

APIがなかった場合と費用の考え方

APIがない、または必要なデータを取り出す窓口がない場合は、次の3つから選びます。

1. APIを追加開発してもらう:最も確実ですが、費用と期間がかかります。見積もりは「調査・設計」「開発」「テスト」「本番への反映」「保守」に分けてもらい、どこに工数がかかっているかを確認してください。読み取りだけの窓口を、聞きたいことに必要な分だけ作る形にすると、範囲を絞れます。
2. CSVの書き出しで代用する:画面から表を書き出してAIに渡す方法です。費用はかかりませんが、毎回の手作業になり、最新の数字ではありません。効果の見極めには十分です。
3. データベースに直接つなぐ:技術的には可能でも、おすすめしません。システムの作りを知らない接続は、負荷や誤操作の原因になり、開発会社の保守の範囲外になることがあります。

追加開発を依頼する前に、2の方法で「AIに聞いて本当に役立つ質問」を確かめておくと、作る窓口を必要最小限に絞れ、費用の無駄を減らせます。

よくある失敗

• 「APIはありますか」とだけ聞く:「あります」で終わり、使える窓口か、鍵を発行できるかがわからないまま時間が過ぎます。上の8項目でまとめて聞きましょう。
• 本番の鍵をメールの本文で受け取る:鍵はパスワードと同じ扱いです。受け渡しの方法を開発会社と決め、社内での保管場所も決めておきます。
• 何でもできる管理者の鍵をもらう:手っ取り早く見えますが、漏えいや誤操作の影響が大きくなります。
• 担当者の退職・交代で経緯がわからなくなる:回答のメールと仕様書は、社内の共有場所に残しておきます。