API連携ガイド

root ip クラウド APIで何ができる？

root ip クラウド APIを使用し、お客様が独自に開発したプログラムと連携させることで、主に「自動化」「反復処理」「定期実行」「他システムとの連携」が可能になります。具体的には以下のようなことができます。

① 煩雑な作業の「自動化」

毎回同じ手順で行っている決まりきった作業をワンアクションで実行し、常に同じ結果を得られるように自動化できます。

例：特定条件での検索とCSV出力
これまで手動で行っていた「ログイン」「検索条件の入力」「CSV出力」「ファイル名の変更」「特定フォルダへの保存」といった一連の流れをプログラムで自動化できます。

② 大量データの「反復処理」

同じ作業の繰り返しや、大量データの更新処理を効率的に行えます。

例：発明者の異動処理
人事データを読み取って更新対象の発明者を比較抽出し、一気に情報を更新するといった大量の反復作業を自動化できます。一度作成すれば、次回の異動時にも再利用できます。

③ 忘れがちな作業の「定期実行」

特定の時刻や一定期間ごとに繰り返す作業を自動化し、実行漏れを防ぐことができます。

例：日次レポートの作成
毎日繰り返すスケジュール登録やレポートの作成などを自動化し、単純な定期作業から解放されます。

④ 社内の他システムとの連携

APIを通じて、Salesforce、kintone、Microsoft 365 など、社内で利用している他システムとroot ipのデータ連携が可能になります。

APIで可能な操作

参照・検索：ブラウザから閲覧できるほぼ全てのデータの検索・取得や、保存済みの検索条件に応じたCSVデータの発行が可能です。

追加・更新・削除：ブラウザから操作できるデータの基礎的な追加・編集・削除が可能です（※新規の案件作成、特許庁HTMLの添付、CSVインポートは対象外です）。

APIトークンの発行手順

APIトークンを発行できるのは、全権ユーザ・API読取・API書込権限をお持ちのお客様のみです。

1. root ip クラウドにログインします。
   
2. 画面上部の固定メニューバー（またはプロフィールアイコン）から、個人メニュー ＞「（お客様のお名前）ユーザ情報」へ進みます。
   
3. ページ下部の「APIトークン設定」へ進み、「APIトークン発行」ボタンをクリックします。
   
4. 「APIトークンを発行しますか？」のポップアップで「OK」をクリックします。
   
5. APIトークンが発行されます。伏字欄の右端にある目のアイコンで表示、「コピー」ボタンでクリップボードにコピーできます。
6. 削除する場合は「削除」ボタンを押します。
   
7. 「APIトークンを削除します。この操作は取り消せません。よろしいですか？」のポップアップで「OK」を押します。
   
8. APIトークン未発行状態になれば、正常に削除されています。
   

開発リファレンスとサンプルコードの入手

実際にAPI開発を始める際は、以下の2つのファイルを手元にダウンロードしておくとスムーズです。いずれも 固定メニューバーの「マニュアル」 から入手できます。

① OpenAPI定義ファイル（YAML）

「マニュアル ＞ APIリファレンス」を開き、画面右上の青いボタン「OpenAPI定義ファイル」をクリックすると、YAML形式のファイルがダウンロードされます。
これはroot ipのAPI仕様（認証方法・エンドポイント・パラメータなど）を機械可読な形式でまとめたもので、後述のAI開発ツールに読み込ませることで、仕様に沿ったプログラムを自動生成できます。

② Pythonサンプルコード（GitHub）

「マニュアル ＞ API開発サンプルコード(GitHub)」を開くと、root ipが公開しているサンプルリポジトリ（rootip_api_python_sample）が表示されます。
緑色の「Code」ボタン → 「Download ZIP」から一式をダウンロードし、展開してご利用ください。

AI開発ツールを使ったAPI開発

近年はAIの進化により、プログラミングに不慣れな方でもAI開発ツールを使ってAPI連携プログラムを作成しやすくなっています。
代表的なツールには次のようなものがあります（どれを使っても問題ありません）。

• Codex（コーデックス）：ChatGPT系の開発ツール
• Claude Code（クロードコード）：Claudeの提供元がリリースしている開発ツール
• Cursor（カーソル）：複数のAIモデルを組み合わせて開発できるツール

基本の流れ

1. 「3. 開発リファレンスとサンプルコードの入手」でダウンロードした OpenAPI定義ファイル（YAML） と Pythonサンプルコード を、AI開発ツールに読み込ませます。
2. やりたいことを日本語でそのまま指示します（例：「root ipのAPIのサンプルプログラムを作成したいです。APIを動かすために必要な情報と、どこに書けばよいか教えてください」）。
3. AIが必要な設定項目（ユーザID・システムURL・APIトークンなど）や、それらを記入するテンプレートファイル（secrets.py など）を案内してくれます。
4. 案内に従って、お手元でテンプレートに認証情報を記入し、「サンプルプログラムを動かしたい」と指示すると、AIが実行手順まで作成してくれます。エラーが出た場合も、そのエラー内容をそのままAIに伝えると修正方法を提案してくれます。

安全に開発するための5つのポイント

AI開発ツールは便利な一方で、セキュリティ上の注意も必要です。以下の5つの考え方を知っておくと、より安全に開発を進められます。
これらの注意事項は、前述のサンプルコードに同梱された「セキュリティガイド」にも記載されており、多くのAI開発ツールはこれを自動的に参照します。

ポイント	内容
① 合鍵は書かない	APIトークンなどの認証情報はコード本体に直接書かず、専用の設定ファイル（テンプレート）に分離します。プログラムを他の人へ共有する際は、必ず認証情報を空にした状態で渡し、自分のトークンを含んだまま共有しないでください。
② 隔離された部屋で	Docker／devcontainer などの仮想的な開発環境に作業を閉じ込めると、PC内の重要データ（Cドライブ等）にAIツールがアクセスできなくなり、安全に開発できます。サンプルコードには、この設定ファイルが含まれています。
③ 壊さない仕組み	誤操作による事故を防ぐため、削除（DELETE）は行わない、更新前に必ず確認する、一度に処理する件数を絞る、といった配慮をします。また、いきなり本番環境ではなく、テスト環境（サンドボックス）で試すことをおすすめします。
④ 偽物を避ける	プログラムが利用する外部部品（ライブラリ）には、著名なものに名前を似せた偽物や、乗っ取られたものが紛れ込むこと（サプライチェーン攻撃）があります。root ipのサンプルでは、動作確認済みのバージョンを固定する仕組み（ハッシュ固定）を採用しています。
⑤ AI時代の新常識	外部から渡す仕様やデータの中に、人間には見えにくい形でAIへの不正な命令（プロンプト汚染）が仕込まれている場合があります。AIはすべての指示を必ず守るわけではないため、最終的には人による確認（レビュー）が欠かせません。

APIの利用料金とリクエスト制限

利用料金

root ip クラウド APIの基本的な利用において、追加料金は不要です。root ipの主機能の一部として、今後も追加料金なしで提供される予定です。

リクエスト制限（レートリミット）

システムを安定的に稼働させるため、以下の制限・利用条件が設けられています。

項目	内容
リクエスト回数の上限	1分間に20リクエストまで（ユーザ単位）。例：2ユーザがそれぞれ20回／分、合計40回／分の利用も可能です。上限超過時は HTTP ステータス「429（リクエスト過多）」エラーとなります。
トークン発行数	1人の全権ユーザにつき1トークンのみ発行可能です。
検索APIの page limit	上限は「100」です（2026年4月時点で上限引き上げ予定なし）。レートリミットに抵触しない範囲で逐次呼び出すことで全データの取得が可能です。

APIのレスポンスヘッダには、以下の情報が通知されます。独自開発プログラム内でこれらを参照することで、リクエスト過多のエラーを防ぐハンドリングが可能です。

• X-RateLimit-Limit：期間あたりのリクエスト可能数
• X-RateLimit-Remaining：リセット時刻までにリクエスト可能な残数
• X-RateLimit-Reset：次回制限がリセットされる時間

Information ／ 今後の変更や有償化の可能性について

上記のリクエスト制限は、システム全体の利用状況に応じて随時変更される可能性があります。
標準の制限枠を超えてレートリミットの緩和（上限引き上げ）を希望される場合は、有償対応となる可能性がございます。

APIソフトウェア開発について

• 本APIを利用したソフトウェアの開発につきましては、root ipでは対応しておりません。
• ご要望がある場合は、開発対応が可能な業者のご紹介が可能です。

エラーが発生した時の対処法

API実行時にエラーが発生した場合、まずはレスポンスボディに含まれる情報を確認して対処します。レスポンスボディには以下の情報が含まれています。

• displayMessage：日本語のエラー事由が記載されています。原因に合わせてプログラムやリクエスト内容を修正してください。
• requestId：リクエストごとに割り振られる固有のIDです。サポートへ問い合わせる際に利用します。

また、返却されるHTTPステータスコードからエラーの大まかな原因を特定できます。

コード	意味
4XX系（クライアントエラー：リクエスト側に問題がある場合）
400	リクエスト内容が不正
401	未認証（トークンの設定漏れなど）
403	アクセス不可
404	対象のリソースが存在しない
429	リクエスト過多（1分間に20リクエストの制限を超過した場合など）
5XX系（サーバエラー：システム側に問題が発生している場合）
5XX	サーバ側で問題が発生しています。

API活用例・参考資料

API連携説明会（2023年5月18日）

• 資料（PDF）：API連携_アップデート説明会_当日資料
• 動画：API連携説明会（2023年5月18日）動画

活用事例ウェビナー（2024年9月24日）

「【root ipクラウド】API連携実例紹介ウェビナー ～パラマウントベッド株式会社様による開発秘話紹介・API連携デモ～」の動画を公開しています。

• 動画：【root ipクラウド】API連携実例紹介ウェビナー ～パラマウントベッド株式会社様による開発秘話紹介・API連携デモ～

実装サンプル：アクション担当者を一括変更する

Python ＋ 電子証明書（SSL通信）＋ Flask による簡易管理画面を使って、アクションの担当者をAPI経由で一括変更する手順を公開しています。

【API活用例】アクション担当者を一括変更する

Ｑ＆Ａ

• APIの各エンドポイントの仕様書には、「全検索項目」で指定できる要素が含まれていないように思われるが、全検索項目を行う方法を教えてほしい

  APIにおいて「全検索項目」と同等の絞り込みを行う場合、単一のエンドポイントで完結するAPIは公開されておらず、
  案件情報取得APIやアクションAPI等、複数のエンドポイントを組み合わせて、必要な条件でデータを取得・加工いただく形となります。

  また、root ipの画面上では、詳細検索や検索条件保存の機能により、複数条件を組み合わせた検索を実行・再利用することが可能です。

  よく使用される条件については、これらの機能をご活用いただくこともご検討ください。

  なお恐縮ではございますが、具体的なAPIの活用方法に関するお問い合わせにつきましては、
  弊社事務局のサポート範囲外となっており、詳細な実装方法についてはご案内いたしかねます。
  有償でのサポートは可能でございますので、ご希望の場合はご相談いただけますと幸いです。

  【参考】
  ■詳細検索（検索式の設定・保存）
  https://manual-firm.rootip-cloud.net/?page_id=2970

  ■通常検索条件の保存機能
  https://manual-firm.rootip-cloud.net/?p=12933

• 【API】API連携を行うことについて、１APIトークン/１全権ユーザのID設定やレートリミットの制限以外の、その他の制限はありますか？

  APIリファレンスに記載された利用方法内であれば、トークン数とレートリミット以外の制限は特にございません。

• 【API】外注によるシステム開発は許容していますか？弊社内でのプログラム開発のみに制限はされていますか？

  外注による開発を行っていただいて構いません。

  ただし利用規約に定められている通り、システムにアクセスできるのはIDを持つユーザのみであるため、開発業者様にも貴社がユーザIDを発行する必要がございます。
  また同ユーザは貴社の管理下のユーザとなるため、貴社のその他ユーザと同等の義務と権限を有するものです。
  API開発に必要な全権ユーザはすべての操作が可能となる非常に強い権限となりますので、アカウントのお取り扱いには十分ご留意ください。