Skip to content
ドキュメントのセクション

API ドキュメント

RF・電子回路の計算ツール 255 種とシミュレーションツール 13 種を、REST でスクリプト、ノートブック、アプリケーションに組み込めます。計算ツールは 1 つのエンドポイントですべて実行でき、シミュレーターは投入してポーリングするジョブとして動きます。どの結果にも計算方法が示されます。

ベース URL は https://rftools.io/api/py/v1 です。キーは X-API-Key ヘッダーで送信します。無料のキーで月 5 回呼び出せます。ダッシュボードで取得してください。

最初のリクエスト

計算ツールのスラッグと入力を /calculate に POST します。レスポンスには、すべての出力が名前ごとに、警告とともに含まれ、さらに式、エンジンのバージョン、入力が計算ツールの対象範囲内だったかを示す来歴オブジェクトが付きます。この説明の横にあるコードは、4 つの言語で書いた呼び出しと、それに対して API が返すレスポンスです。

エンドポイント

公開されているすべてのエンドポイント
エンドポイント内容計上
POST /api/py/v1/calculate計算ツールを 1 つ、その入力で実行します。1 回
POST /api/py/v1/calculate/batch1 リクエストで最大 50 件の計算を実行します。計算した項目ごとに 1 回
POST /api/py/v1/calculate/solve出力を目標値にする入力値を求め、その値でのフォワード計算の結果とともに返します。1 回
GET /api/py/v1/usageその月の利用枠、使用量と残りをキーごとに返します。?days=N を付けると直近 N 日それぞれの呼び出し回数が加わります。計上されない
GET /api/py/v1/jobs/typesすべてのシミュレーションジョブタイプと、そのプラン、時間上限、制限、アップロード。計上されない
GET /api/py/v1/jobs/types/{job_type}1 つのジョブタイプのパラメーター契約(JSON Schema)。計上されない
POST /api/py/v1/jobs/estimateジョブを投入せずに、その費用と所要時間を見積もります。計上されない
POST /api/py/v1/uploadジョブの入力ファイル用の署名付きフォーム。計上されない
POST /api/py/v1/jobsシミュレーションジョブを投入します。キー使用時に 1 回
GET /api/py/v1/jobs/{job_id}ジョブのステータスと進捗、完了後は結果へのリンク。計上されない
GET /api/py/v1/jobsアカウントのすべてのキーで投入した、呼び出し元の最近のジョブ。計上されない
POST /api/py/v1/apikeysログイン中のアカウントのキーを作成します。計上されない
POST /api/py/v1/oauth/device/codeデバイス認可を開始します:利用者が承認するコードを発行します。計上されない
POST /api/py/v1/oauth/device/token利用者がコードを承認した後に、キーを受け取ります。計上されない
GET /api/py/healthサービスの状態。計上されない

シミュレーションのジョブタイプ

13 種のシミュレーターが非同期ジョブとして動きます。投入し、ポーリングし、結果を読み取ります。各ジョブタイプはパラメーター契約を公開しています。シミュレーションジョブをご覧ください。

次に読むページ

機械可読なリファレンス

組み込みを始めますか?

キーを取得すれば、1 分以内にリクエストを送れます。API プランでは月 10,000 回、キー使用時は毎分 120 リクエスト、計算ツール 255 種すべてを利用できます。

または、ダッシュボードで無料のキー(月 5 回)を取得できます。クレジットカードは不要です。