IT連携マップシステムどうしのデータ連携・接続仕様のまとめ

2 分で読む

API 連携は何から調べるかでは、調べる順番を 8 ステップに置きました。API が在ると分かった次に効くのが、機械が読める仕様書が配られているかです。

「APIはあります」と言われて安心したあと、開発会社から「仕様書をもらってください」と言われて詰まったことはないでしょうか。

APIがあることと、その設計図が読める形で配られていることは別の話です。そして設計図が無いと、作る前に見積もりが立ちません。

その設計図の書き方の標準が OpenAPI です。日本の業務システム56件について、設計図をどう配っているかを1件ずつ調べました。

結論から書きます。

機械が読める設計図(OpenAPI / Swagger のファイル)を配っているのは、56件中10件。約6分の1です。

ここでは、①OpenAPIとは何かを規格の一文で示し、②56件の内訳を出し、③検討時に何が変わるのかを書きます。


OpenAPI とは何か

OpenAPI が何かは上のカードのページに置きました。このページは、56 件がその設計図をどう配っているかと、検討で何が変わるかです。

何が「機械可読」なのか

ここが一番大事なところです。人が読むHTMLのドキュメントと、OpenAPIのファイルは、書いてある内容が同じでも扱いが違います。

つまりOpenAPIファイルがあると、「このAPIで何ができるのか」を、人が読む前に把握できます。

実際、ここでの数字も同じ方法で作りました。たとえばkintoneの公式OpenAPIは128パス(Apache-2.0ライセンスでGitHub公開)、freee会計は96パス・151オペレーション(MITライセンス)と、ファイルを機械的に数えた値です。HTMLしか無ければ、この数字は出せません。

kintone API 仕様 freee会計 API 仕様


読者の行動:3つ見るだけ

設計図はあるか・誰でも読めるか・何が扱えるかの3つを確認するチェックリストの図
設計図はあるか・誰でも読めるか・何が扱えるかの3つを確認するチェックリストの図

検討中のシステムについて、開発者向けページを開いて、次の3つを順に見てください。

1. OpenAPI / Swagger のファイルへのリンクがあるか

.json か .yaml のダウンロードリンク、あるいはGitHubへのリンクを探します。あれば最良です。

2. HTMLのドキュメントだけか

エンドポイントの一覧ページがあるかを見ます。一覧が無いドキュメントは、全体像が掴めません(Jotform がこの例です)。

3. 申込やNDAが要るか

「APIのご利用には申込が必要です」と書かれていたら、見積もりの前に申込を出す必要があります。ここを見落とすと手戻りになります。


まとめ

  • 機械が読める設計図を配っているのは、56件中10件(17.9%)
  • 人が読むドキュメントのみが22件(39.3%)、仕様書そのものが確認できないのが18件(32.1%)
  • 申込・NDA(秘密保持契約) が要るのが5件。見積もり前に読めません
  • 設計図の有無が一番効くのは見積もりの段階
  • 分母が違うので国際比較はできません

「APIはありますか」の次に聞くべきなのは、こうなります。

「API仕様書は公開されていますか。OpenAPI などのファイルで配布されていますか。 それとも申込が必要ですか。」


ここから先は調査の詳細です(約 8 分)。上のカードだけで決められます。調べた 1 件ずつの記録は IT連携マップ に、出典 URL と調査日つきで公開しています。

調査の詳細

このページの答えは、以下の調べで出しました。対象・確認時期・出典を並べます。

56件の内訳

設計図の出し方の内訳。OpenAPIファイルの配布は10件(17.9%)であることを示す横棒グラフ
設計図の出し方の内訳。OpenAPIファイルの配布は10件(17.9%)であることを示す横棒グラフ

編集部が56件の「API仕様」欄を1件ずつ読み、設計図の出し方を5つに分類しました。

設計図の出し方 件数 割合
OpenAPI / Swagger のファイルを配布(機械可読) 10 17.9%
機械可読だが OpenAPI ではない(JSON Schema 等) 1 1.8%
人が読むドキュメントのみ(HTML・PDF・Word 等) 22 39.3%
申込・NDA・規約同意を経て開示(一般公開ではない) 5 8.9%
仕様書そのものが無い/公開を確認できない 18 32.1%
合計 56 100%

OpenAPI ファイルを配っている10件

システム 確認できた内容
kintone OpenAPI 3.1.0・128パス(公式GitHub、Apache-2.0) kintone API 仕様
freee会計 OpenAPI 3.0.1・96パス / 151オペレーション(公式GitHub、MIT) freee会計 API 仕様
freee人事労務 OpenAPI 3.0.1・68パス / 109オペレーション / 177スキーマ freee人事労務 API 仕様
ジンジャー OpenAPI 3.1.0・177パス / 155タグ ジンジャー API 仕様
SmartHR Swagger 2.0・60パス / 120オペレーション(無認証で取得可) SmartHR API 仕様
マネーフォワード クラウド経費 Swagger 2.0・88パス / 117オペレーション / 106定義 マネーフォワード クラウド経費 API 仕様
board OpenAPI 3.1.0・53パス / 89オペレーション / 139スキーマ board API 仕様
ジョブカン会計 OpenAPI 3.0準拠・8パス、いずれもGETのみ ジョブカン会計 API 仕様
invox OpenAPI 仕様がダウンロード可(ドキュメント 1.35.0) invox API 仕様
jGrants OpenAPI 3.1.0(jgrants-api.yaml・39.0KB・2024年10月7日公開) jGrants API 仕様

行政システムである jGrants が入っているのは注目に値します。項目ごとに説明と取りうる値が書かれ、業種・地域・利用目的は選択肢まで明記されています。

jGrants API 仕様

もう1件、マネーフォワード クラウド給与は OpenAPI ではありませんが、リソース定義を JSON Schema(JSON Hyper-Schema) で提供しています。機械可読という意味では同じ効果があるため、別分類にしました。

マネーフォワード クラウド給与 API 仕様

「人が読むドキュメントのみ」が22件

一番多い層です。ドキュメントはあります。ただしファイルは配られていません。

  • マネーフォワード クラウド会計:OpenAPIの配布なし、HTMLドキュメントのみ
  • Garoon:開発者サイトのHTMLドキュメント(エンドポイントごとのページ)。同じサイボウズでも kintone はGitHubでOpenAPIを公開しているのに、Garoon には見当たりません
  • KING OF TIME:HTML形式の公開仕様書(API Blueprint系)。メソッド+パスの組を41件確認
  • Zoho CRM:HTMLドキュメント(6 種類)。英語のみ
  • Yahoo!ショッピング ストアクリエイターPro:11 種類のAPIがHTMLとPDFで公開、サンプルコードはPHP
  • Jotform:ドキュメントはあるがエンドポイントの一覧が無い

この層は「調べられるが、手間がかかる」という位置づけです。人がページを開いて数える必要があります。

マネーフォワード クラウド会計 API 仕様 KING OF TIME API 仕様 Zoho CRM API 仕様 Yahoo!ショッピング API 仕様

「申込・NDA を経て開示」が5件

eLTAX / PCdesk、ジョブカン勤怠管理、formrun、MOVO Berth、楽楽精算 の5件です。

このうち 3 件は、読む前に何が要るかを提供元自身が書いています。eLTAX / PCdesk は、仕様の開示を希望する場合は地方税共同機構へ申し込むよう案内しています。eLTAX / PCdesk API 仕様 ジョブカン勤怠管理は、有料プランの契約とNDA の締結を条件に開発者向けに公開すると書いています。ジョブカン勤怠管理 API 仕様 formrun は、API キーの取得と仕様書へのアクセスの前に規約への同意を求めています。formrun API 仕様

見積もりを取る前に仕様が読めない、という状態です。手戻りのリスクがここにあります。


なぜこの分類を手でやったのか

数え方について、正直に書いておきます。

最初、編集部はキーワード照合でこれを数えようとしました。調査記録の記述に「OpenAPI」という語が入っていれば配布あり、という判定です。

これは間違いです。 実際に32.1%という値が出て、正しい17.9%のほぼ倍になりました。

原因は単純で、調査記録の記述には「OpenAPIファイルの配布は確認できていない」という文が入っているからです。語だけを見ると、無いと言っているのに有ると数えてしまいます。

実際に取り違えたのは Garoon、Misoca、マネーフォワード クラウド会計 でした。いずれも「OpenAPIの配布は確認できていない」と書かれているシステムです。

そこで56件すべてを人が読んで分類し直しました。 判断の元にした記述と出典URLは全件公開しています。読者が検算できる形にしてあります。


設計図があると、検討で何が変わるか

設計図が配られていると、見積もりの前提・確認用の画面・雛形の自動生成・変更の追いやすさが変わることを示した図
設計図が配られていると、見積もりの前提・確認用の画面・雛形の自動生成・変更の追いやすさが変わることを示した図

「機械可読だと便利」では業務の判断になりません。検討のどの段階で、何が変わるのかを書きます。

段階 OpenAPIファイルあり HTMLのみ 申込制
できることの把握 ファイルを開けば一覧できる ページを人が読む 読めない
見積もり 対象と操作が確定した状態で出せる 概算になる 前提が置けない
開発 クライアントを自動生成できる 手で書く —
仕様変更の検知 新旧ファイルの差分で分かる お知らせを読む —

一番効くのは見積もりの段階です。

「顧客情報を連携したい」という要件に対して、OpenAPIファイルがあれば「顧客オブジェクトはこの項目を持っていて、登録と更新ができる」とその場で確定します。HTMLしかなければ、開発会社が読む工数がかかります。申込制なら、申込が通るまで見積もりが出せません。

APIが扱う「もの」の件数

設計図があると、APIが扱う対象(オブジェクト)を機械的に数えられます。編集部は公開済み28システムについて、合計747件のオブジェクト定義を採取しました。

ただし件数の多い順に優劣を付けることはできません。 粒度が製品ごとに違うからです。ある製品が「請求書」を1オブジェクトとして持ち、別の製品が「請求書ヘッダ」「請求書明細」に分けていれば、後者のほうが件数は多くなります。多いほうが優れているわけではありません。


パスの数を、優劣として読まないでください

上の表に「128パス」「96パス / 151オペレーション」といった数字が並んでいます。この数字の意味を書いておきます。

  • パス = 窓口の住所の数(/companies /deals のような単位)
  • オペレーション = その住所に対してできる操作の数(同じ住所に「取得」と「登録」があれば2)
  • スキーマ/定義 = やり取りするデータの形の定義数

つまりオペレーションがパスより多いのは自然です。1つの窓口で複数の操作ができるからです。

そして数が多い=機能が豊富、とは限りません。 設計の粒度の問題です。1つの窓口に操作をまとめる設計と、窓口を細かく分ける設計では、同じ機能でも数が変わります。

実務で効くのは、数ではなく次の2つです。

  1. 自分が動かしたい対象が、そのパスの一覧にあるか
  2. その対象に対して、POST(登録)や PUT(更新)があるか

ジョブカン会計の「8パス、いずれもGETのみ」が、この2つを一度に示す例です。パス数が少ないことより、GETしかないことのほうが効きます。

boardの「139スキーマ・日本語ラベル付きフィールド455件」も見ておく価値があります。フィールドに日本語のラベルが付いているということは、仕様書を読む人が項目の意味を推測しなくて済む、ということです。これは変換の作業量を直接減らします。

設計図が無くても、作れないわけではありません

念のため書いておきます。人が読むドキュメントしかない22件でも、連携は作れます。

違うのは作る前に確定できることの量です。

設計図あり 人が読むドキュメントのみ
作れるか ○ ○
窓口の数を数えられるか ○ 人が数える
契約前に試せるか ツールで試せることがある ドキュメントを読んで想像する
見積もりの前提 置ける 置いて、外れたら追加費用

ここでは「設計図が無いベンダーは劣っている」と言っているのではありません。 稟議を通す前に、どちらなのかを知っておくと見積もりの幅が読める、という話です。


国際比較は成り立ちません

「日本はOpenAPIの普及が遅れている」と書きたくなるところですが、書けません。

比べようとすると、こうなります。

出どころ 何を数えた値か 分母
ここ 日本の業務システム56件のうち、OpenAPIファイルを配布 56(編集部が選んだ)
開発者アンケート 「OpenAPIを使っている」と回答した開発者の割合 回答者数
公開APIディレクトリ 登録されているAPI仕様の数 登録されたものだけ

3つとも分母が違います。 17.9%と、他所の何%かを並べても、意味のある比較になりません。だから「日本は遅れている」とも「進んでいる」とも書きません。


ここでの調査範囲について

  • 対象は、編集部が一次調査を終えて公開している56システムです。日本の業務システム全体ではありません。「17.9%」は56件に対する割合であって、日本全体の値ではありません。
  • 「17.9%しかAPIが無い」ではありません。 APIの有無と、設計図の配り方は別の話です。APIの公開状況は別の記事で扱っています。
  • 確認時期は2026年7月28日〜8月19日です。
  • 分類は編集部が手で割り当てました。 キーワード照合では逆に読むためです(「なぜこの分類を手でやったのか」)。
  • OpenAPI は ISO や JIS の規格ではありません。「業界標準」という書き方は避けています。

規格の出典は OpenAPI Specification、OpenAPI Initiative です。各システムの「API仕様」欄は RenkeiMap で1件ずつ、出典URLと調査日つきで公開しています。

この記事に登場するシステム(23)

GaroonJotformKING OF TIMEMOVO BerthMisocaSmartHRYahoo!ショッピングZoho CRMboardeLTAX / PCdeskformrunfreee人事労務freee会計invoxjGrantskintoneジョブカン会計ジョブカン勤怠管理ジンジャーマネーフォワード クラウド会計マネーフォワード クラウド経費マネーフォワード クラウド給与楽楽精算

← 調査記事の一覧へ 比較する

「設計図(OpenAPI)は配られているか — 3 つ見るだけ」について、分からないところを聞いてください
この画面のヒント
「設計図(OpenAPI)は配られているか — 3 つ見るだけ」について、分からないところを聞いてください
編集部はベンダーからの掲載料・送客料・成果報酬を一切受け取りません。判定は編集部の調査記録にある一次資料から、機械で組み立てています。 チャット(HINT)の相談内容の扱いはプライバシーポリシーに書いています。
一覧: システム一覧 連携ツール(連携サービス)一覧 AI・自動化ツール一覧 稼働状況・障害情報
記載の誤り・掲載についてのご連絡 → 訂正・掲載のご依頼(無料・無条件・全社同一) 運営者情報