目次

API概要

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

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

  1. 煩雑な作業の「自動化」 毎回同じ手順で行っている決まりきった作業をワンアクションで実行し、常に同じ結果を得られるように自動化できます
    例：特定の条件での検索とCSV出力 これまで手動で行っていた「ログイン」「検索条件の入力」「CSV出力」「ファイル名の変更」「特定のフォルダへの保存」といった一連の流れをプログラムで自動化できます。
  2. 大量データの「反復処理」 同じ作業の繰り返しや、大量のデータの更新処理を効率的に行えます
    例：発明者の異動処理 人事データを読み取って更新対象の発明者を比較抽出し、一気に情報を更新するといった大量の反復作業を自動化できます。一度作成すれば、次回の異動時にも再利用できます。
  3. 忘れがちな作業の「定期実行」 特定の時刻や一定期間ごとに繰り返す作業を自動化し、実行漏れを防ぐことができます
    例：日次レポートの作成 毎日繰り返すスケジュール登録やレポートの作成などを自動化し、単純な定期作業から解放されます。
  4. 社内の他システムとの連携 APIを通じて、Salesforce、kintone、Microsoft 365など、社内で利用している他のシステムとroot ipのデータ連携が可能になります
    具体的な機能について APIを通じて、root ip内のデータに対して以下のような操作が可能です（2023年10月時点の予定機能を含みます）。
    参照・検索: ブラウザから閲覧できるほぼ全てのデータの検索・取得や、保存済の検索条件に応じたCSVデータの発行が可能です。
    追加・更新・削除: ブラウザから操作できるデータの基礎的な追加、編集、削除が可能です（※ただし、新規の案件作成、特許庁HTMLの添付、CSVインポートは対象外となります）。
Information

APIを実行して上記のような自動化を行うためのプログラム（シェルスクリプト、ExcelのVBA、独自アプリケーションなど）は、root ipから提供されるものではなく、お客様の社内で独自に開発していただく必要があります

APIトークンの発行手順

APIトークンの発行手順は以下の通りです。なお、APIトークンを発行できるのは全権ユーザ、API読取、API書込権限をお持ちのお客様のみとなります。
１．root ip クラウドにログインします。
２．画面上部の固定メニューバー（またはプロフィールアイコン）から、個人メニュー ＞「（お客様のお名前）ユーザ情報」へと進みます。


３．ページ下部の「APIトークン設定」へと進み、「APIトークン発行」ボタンをクリックします。


４．「APIトークンを発行しますか？」というポップアップが表示されるので、「OK」をクリックします。


５．APIトークンが発行されます。伏字欄の右端にある目のアイコンをクリックするとトークンが表示され、「コピー」ボタンでクリップボードにコピーできます。


６．APIトークンを削除する場合は「削除」ボタンを押します。


７．「APIトークンを削除します。この操作は取り消せません。よろしいですか？」とポップがでますので「OK」を押します。


８．APIトークン未発行状態になったら正常にAPIトークンが削除されました。

Warning

【重要な注意点】
セキュリティのため、APIトークンはこの画面を閉じると二度と表示できなくなります。
第三者にAPIトークンが漏洩すると、お客様がAPIを介して行えるすべての操作が可能となってしまいます。
そのため、トークンはお客様の責任において厳重に管理してください。

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

APIの利用料金

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

リクエスト制限

システムを安定的に稼働させるため、以下のようなリクエスト制限（レートリミット）や利用条件が設けられています。

・リクエスト回数の上限：「1分間に20リクエストまで」の制限が設定されています。
　　　「20 回／1 分」という API の利用制限はユーザ単位でございます。
　　　2 ユーザがそれぞれ「20 回／1 分」、合計「40 回／1 分」利用することも可能でございます。
　　　※この回数制限を超過してAPIを呼び出そうとした場合、制限超過時のエラー（HTTPステータスコード「429: リクエスト過多」）となります。
・トークン発行数の制限：APIトークンを発行できるのは、「1人の全権ユーザにつき1トークンのみ」となります。
・検索APIのpage limit：検索APIのpage limitの上限は「100」となります。2026年4月時点で上限を上げる予定はございません。
　　　　　　　　　　　レートリミットに抵触しない範囲で逐次 API を呼び出していただくことで、全データの取得が可能でございます。


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系（サーバエラー）：システム（サーバ）側に問題が発生している場合のエラーです。
エラーに関するお問い合わせは、レスポンスボディで取得したrequestIdを添えて、root ip事務局（mail@rootip.co.jp）までメールでお問い合わせください。
requestIdはリクエストごとに割り振られる固有のIDであり、システム側でエラーの詳細な状況や原因を調査・特定するために利用されます。

Information

具体的な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開発に必要な全権ユーザはすべての操作が可能となる非常に強い権限となりますので、アカウントのお取り扱いには十分ご留意ください。