OpenAPI とは何か — 人が読む説明書と、機械が読む設計図の違い
「API はあります」と言われて安心したあと、開発会社から「仕様書をもらってください」と言われて詰まることがあります。API があることと、その設計図が読める形で配られていることは別の話です。
人が読む説明書と、機械が読む設計図
OpenAPI Specification は、HTTP API のインターフェースを記述するための標準です。仕様書の冒頭にはこう書かれています。
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs.
言い換えると、「この API には、どんな窓口があって、何を渡すと何が返るのか」を、決められた書式で書いたファイルです。拡張子は .json か .yaml。以前は Swagger という名前で、いまも Swagger 2.0 形式のファイルが現役で使われています。
| 人が読む HTML | OpenAPI ファイル | |
|---|---|---|
| 人が読む | できる | できる(読みにくいが) |
| プログラムが読む | できない | できる |
| 一覧を機械的に数える | 人が数える | 自動で数えられる |
| クライアントを自動生成する | できない | できる |
| 変更点を差分で見る | 目視 | ファイル比較で分かる |
つまり OpenAPI ファイルがあると、「この API で何ができるのか」を、人が読む前に把握できます。 作る前に見積もりが立ち、仕様が変わったときはファイルの差分で追えます。どのシステムが設計図を配っているか(OpenAPI/Swagger/人が読む文書だけ)は RenkeiMap の調査記録 の API 仕様の欄に出典つきで置いてあります。
調査記録で確かめる
例として、経理・会計のカテゴリで見ます。設計図が配られているか・どの方式か・どの形式かの 3 列です。
比較項目:
| システム | 業務ワークフロー円滑度 | |
|---|---|---|
| API 仕様 | API 仕様の公開のしかた | |
| バクラク | API仕様書公開iPaaS 仕様書は別に定める。開いた範囲には見当たらない ベンダー公表 規約は API の仕様を「別途定めるAPI仕様書」のとおりとしているが、その仕様書へのリンクや公開のページは、開いた範囲には見当たらなかった。あわせて、仕様の一部は仕様書に書かれていない場合があり、書かれていないことで生じた損害には責任を負わないとも定めている。API がつなぐ相手として想定されているのは ETL・iPaaS の事業者や SaaS 管理ツールの事業者で、規約ではこれらを第三者アプリと呼んでいる。 | 編集部がまだ確認していません |
| board | OpenAPI 3.1.0 の仕様書 board_openapi.json を配布(バージョン1.9.0・53 paths/89 operations/139 schemas・サーバー https://api.the-board.jp/v1) / Webhook・サンドボックスは spec 上に存在しない(全文検索0件・確認) ベンダー公表board_openapi.…()ほか 1 件
board APIドキュメント(2026-08-01 確認) 編集部確認 ℹ️日本語ラベル付きフィールド455件(顧客ID・姓・名・敬称・部署等)。取得物は map/research/board/board_openapi.json に保存済み。
採取元: board_openapi.json(保存済み仕様書)・board_openapi.json(info 節)
調査日 | OpenAPI 仕様書 編集部確認 |
| e-Tax | 仕様書を一般公開CAB形式でダウンロードWord・Excel 形式OpenAPI 定義なし 仕様書を一般公開しており、ログインなしで CAB形式でダウンロードできる。中身は Word・Excel 形式の文書で、機械可読な OpenAPI 定義なし。API仕様書は「e-Tax仕様書一覧」の1項目として配布される。 ベンダー公表e-Tax仕様書一覧()ほか 2 件
e-Tax仕様書一覧 ベンダー公表 ℹ️一覧には「データ形式等に関する仕様書」「受付システムインターフェイスに関する仕様書」「API仕様書」「送受信モジュールインターフェイス仕様書」「電子署名モジュールインターフェイス仕様書」「CSV変換モジュールインターフェイス仕様書」などが並ぶ。ダウンロードコーナーの利用をもって注意事項に同意したものとみなされる旨が明記されている。
採取元: 国税電子申告・納税システムAPIの概要・各仕様書(e-Tax仕様書)・e-Tax仕様書一覧(ダウンロード方法)・e-Tax仕様書一覧(項番2)
調査日 | 編集部がまだ確認していません |
| eLTAX / PCdesk | CSVレイアウト地方税共同機構ポータルセンタインターフェイス仕様書 開発者向け仕様書(税務ソフト仕様書・XML構造仕様・ポータルセンタインターフェイス仕様書等)は地方税共同機構への申込制で開示。給与支払報告書等の CSVレイアウト仕様書は仕様書・様式集のページで一般公開。 | 編集部がまだ確認していません |
| freee会計 | OpenAPI 3.0.1・96 paths / 151 operations(公式 GitHub、MIT ライセンス)。 | |
| freee申告 | freee申告向けの公開 API が無いため(開発者ポータルの API 一覧・リファレンスを確認、申告向けは掲載なし)、その API 仕様も存在しない。freee会計 API 等の仕様は各システムを参照 freee申告向けの公開 API が無いため(開発者ポータルの API 一覧・リファレンスを確認、申告向けは掲載なし)、その API 仕様も存在しない。freee会計 API 等の仕様は各システムを参照 調査日 | 編集部がまだ確認していません |
| invox | OpenAPI1.35.050メガバイト OpenAPI 仕様がダウンロードでき、ドキュメントのバージョン表記は 1.35.0。リクエストの最大サイズは 50メガバイトに制限される。 | OpenAPI 仕様書 編集部確認 |
| ジョブカン会計 | OpenAPI 公開読み取り専用CSV ダウンロード OpenAPI 3.0 準拠の仕様書がログイン不要で公開されている(バージョン 1.0.1)。エンドポイントは 8 本で、いずれも GET のみ。会計データ・年度一覧の取得と、仕訳日記帳・試算表を CSV でダウンロードするための予約/進捗/取得の3段構えで、書き込み系の操作は無い。 編集部確認ジョブカン会計API 仕様書…()
ジョブカン会計API 仕様書(公開ドキュメント) 編集部確認 ℹ️8 本・全て GET は、編集部が保存済みドキュメントに埋め込まれた OpenAPI 定義(jobcan_ac_openapi.json として抽出保存)の paths を機械的に数えた値。内訳は /account/v1/datas、/account/v1/years、/account/v1/journal_dl(+/reports/{id}/status・/download)、/account/v1/report_dl(+/reports/{id}/status・/download)。サーバは本番 api.jobcan.jp とサンドボックス public-sandbox.api.jobcan.jp の2つが宣言されている。
採取元: ジョブカン会計API 仕様書(概要)・ジョブカン会計API 仕様書(表題とバージョン)・ジョブカン会計API 仕様書(file_type)
調査日 | OpenAPI 仕様書 編集部確認 別に仕様書ファイルを配ってはおらず、そのページの中に操作の定義が埋まっている。 |
| Misoca | API v3 のドキュメントを公式サイトで公開(HTML)。OpenAPI ファイルの配布は本バッチでは確認できていない。 編集部確認Misoca API ドキュ…()
Misoca API ドキュメント 編集部確認 ℹ️数え方: doc.misoca.jp のトップとドキュメント目次を閲覧し、OpenAPI / Swagger ファイルの配布リンクを探した(2026-08-09)。 調査日 | OpenAPI 仕様書 編集部確認 |
| マネーフォワード クラウド会計 | 開発者サイト(developers.biz.moneyforward.com)には OpenAPI ファイルの配布が無く HTML ドキュメントのみ。ただしクラウド会計 API の仕様書そのものは別ホストで yaml として配られており、我々も保存している。 / 開発者サイトで公開されている API リファレンスは認可サーバー API が中心で、公開範囲は薄い(確認時点)。 ベンダー公表開発者サイト APIリファレ…()ほか 2 件
API 共通仕様 編集部確認 ℹ️OpenAPI/Swagger ファイルの配布が無いこと(HTML ドキュメントのみ)は 2026-08-04 の再取得でも確認(API共通仕様・APIリファレンスページに spec ファイルへのリンクなし)。開発者サイトの APIリファレンス一覧(/docs/api)に掲載されているのは認可サーバー API のみで、クラウド会計 API 本体の参照先はサポートサイト内ガイドへの外部リンク(2026-08-04 確認)。
採取元: 開発者サイト APIリファレンスページ・開発者サイト APIリファレンスページ(掲載一覧)・開発者サイト トップ(公開中の API 一覧)・API 共通仕様(リクエスト/レスポンス形式)
調査日 | OpenAPI 仕様書 編集部確認 |
| マネーフォワード クラウド経費 | Swagger 2.0(OpenAPI 3 ではない)・88 paths / 117 operations / 106 definitions・info.version「1」(確認、raw/api_index.json に保存)。 / タグ(業務ドメイン語彙)30件・切り捨てなし:office/ex_transaction/ex_report/expense_report/general_report/suspense_payment_reports/invoice_report/ex_report_unit/expense_report_unit/invoice_report_unit/suspense_payment_report_unit/office_member/ex_office_member_setting/dept/project/position/e_doc/ex_item/excise/ex_invoice_transaction/ex_transaction_reserve/workflow/office_member_workflow/user_defined_master/user_defined_master_item/ex_daily_pay_type/ex_daily_pay/active_ex_daily_pay_type/active_ex_items/attendants。 編集部確認クラウド経費API Swag…()
クラウド経費API Swagger 定義(2026-08-02 取得) 編集部確認 ℹ️同社のクラウド会計は OpenAPI ファイルの配布がないのに対し、経費は spec 実体(/api/index.json)を直接取得できる。
採取元: クラウド経費API Swagger 定義(冒頭)・クラウド経費API Swagger 定義(info.description)・クラウド経費API Swagger 定義(info.version)
調査日 | OpenAPI 仕様書 編集部確認 |
| マネーフォワード クラウド請求書 | RESTJSONmfc/invoice/data.read REST 形式・JSON。エンドポイントは /api/v3/ 系で、スコープは mfc/invoice/data.read(参照)と mfc/invoice/data.write(更新)の 2 種。 | |
| 楽楽精算 | 仕訳データの自動出力CSV自動取込 エンドポイント一覧のような仕様書は公開されていない(契約者向け)。公開ページから読み取れる仕様の輪郭は二機能だけ——「仕訳データの自動出力」(楽楽精算→会計ソフト)と「CSV自動取込」(他システム→楽楽精算の各マスタ)。取り込み先に指定できるマスタは、社員/部門/役職/支払先/プロジェクト/汎用/承認フローの設定手順(簡易設定)/レート管理の各マスタと明記されている。 ベンダー公表API連携オプション ご利用…()
API連携オプション ご利用検討中の方へ(できること) ベンダー公表 ℹ️確認先: raw/successnavi_api_option_20260801.html(「API連携オプション」でできること・ご利用検討時によくある質問)と raw/function_collaboration_20260801.html を全文確認。リクエスト形式・エンドポイント・レスポンス定義を記した公開仕様は保存物に無い(2026-08-10 確認)。
採取元: API連携オプション ご利用検討中の方へ・API連携オプション ご利用検討中の方へ(インポート可能なマスタ)
調査日 | 編集部がまだ確認していません |
| TKC FX2クラウド | ― つなぎ方をまとめた資料は存在するが、置き場所は契約者がログインして使うシステムの中で、公開されているページからは読めない。外から見えるのは、その資料を参照するようにという案内だけ。 | 編集部がまだ確認していません |
| TOKIUM | ―仕様書開発者向け API 連携ができるとは書かれているのに、その仕様書にあたる資料は開いた範囲のどこにも無い。開発者向けのサイトも、エンドポイントの一覧も、リファレンスへの入口も見つからなかった。ヘルプセンターの記事の多くは会員向けなので、契約した先に仕様が置かれている可能性はあるが、外からは確かめられない。 編集部まとめ出典()
API 仕様書は、開いた範囲には見当たらない TOKIUM経費精算 確認したもの: https://www.keihi.com/expense/、https://www.keihi.com/cooperation/、https://www.keihi.com/invoice/、https://www.keihi.com/denshichobo/、https://www.keihi.com/contract/、https://support.keihi.com/ja、https://support.keihi.com/ai-agent、https://corp.tokium.jp/security_whitepaper/、https://www.keihi.com/ 調査日 | 編集部がまだ確認していません |
| 弥生(会計/青色申告 オンライン/Next) | 公開API仕様書なし。代替のデータ連携仕様として、帳簿・伝票等のエクスポート(テキストファイル出力)とインポートの記述形式が公式サポートページで公開されている / エクスポートは[ファイル]→[エクスポート]で画面表示内容をテキスト出力(表計算ソフトで利用可・他の事業所データにインポート可) ベンダー公表データのエクスポート(公式サ…()ほか 1 件
データのエクスポート(公式サポート) ベンダー公表 ℹ️クラウドの弥生会計 Next のインポート仕様(page_id=29611・確認パース済=../yayoi/yayoi_next_import_columns.json)では、CSV/テキスト形式・仕訳27項目・識別フラグ(2000/2111/2110/2100/2101)・制限値(500MB超のファイル不可・明細5,000行超不可・1仕訳の明細100行超不可)まで公開されている。デスクトップ版の仕様は別ページ(page_id=18586等)。
採取元: データのエクスポート(公式サポート)・インポートデータの記述形式(弥生会計 Next・公式サポート)・インポートデータの記述形式(識別フラグの値仕様)
調査日 | 編集部がまだ確認していません |
◎ 条件なしで当てはまる ○ 条件つき・一部 △ 限定・要申請・無いと明記 × 当てはまらないと明記 ? 編集部がまだ確認していません ― 提供元が公開していない(編集部が調べた) — 記号は編集部の札から機械で付けています。物差しは項目ごとに違い、列の見出しがその項目の意味です。札の意味と根拠は各セルの要約を押すと出ます。
材料の調査日(最新): 2026-09-03