メインコンテンツへ移動

3Dプリンターフリート向けのREST APIです。HTTPS経由でJSONを使用し、1つのヘッダーで認証します。

SimplyPrintの3DプリンターAPI

独自のソフトウェアからSimplyPrintを操作できます。ERPからジョブをキューに追加したり、カスタムダッシュボードを作成したり、既存のワークフローやZapier、n8n、MakeとSimplyPrintを連携したりできます。パネルで行えるすべての操作にJSONエンドポイントからアクセスできます。エンドポイントは文書化され、バージョン管理されており、安定しています。Prusa、Bambu Lab、Creality、Anycubic、Elegooのプリンターや、OctoPrintまたはKlipperに対応するプリンターでも同じように動作します。

無料で始める 詳細情報と使い方
機能の画像

同じプリンター群とデータに、独自のコードからアクセスできます。

APIでは、パネルと同じ操作を利用できます。キューへの追加、プリンターの状態取得、ファイルのアップロード、フィラメントの確認、ジョブ履歴の取得、一括操作が可能です。アカウントごとに1つのAPIキーとベースURLで開発を始められます。

1回のAPI呼び出しでプリントを開始

コードからエクストルーダーを動かすまでの最短手順です。/queue/AddItemにファイルIDをPOSTし、1台以上のプリンターを指定するだけで、あとはSimplyPrintが処理します。内部ではパネルと同じマッチング、承認、振り分けのロジックが動作するため、手動でプリントを開始した場合と同じプリンターでプリントが始まります。

curl -X POST "https://api.simplyprint.io/{companyId}/queue/AddItem" \
  -H "X-API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "fileId": "abc123",
    "amount": 1,
    "for_printers": "42,43",
    "position": "top"
  }'
成功時のレスポンス:
{
  "status": true,
  "message": null,
  "approval_status": "not_required",
  "id": 90817,
  "queue_position": 1
}
URL内の{companyId}はバージョンではなくアカウントIDです。サインイン後のパネルのURLで確認できます。特定のプリンターを指定するにはfor_printersを設定します。省略するとSimplyPrintが対応するプリンターを選択します。キューの先頭に移動するにはposition: "top"を設定します。

すべてのエンドポイントを見る

プリンターフリート全体をコードから操作

プリンター、プリントキュー、ファイル、フィラメント、ジョブ、統計、Webhook、カスタムフィールドなど、プリンター管理のあらゆる領域を網羅する100以上のRESTエンドポイントがあります。機能を絞ったサブセットではなく、パネルにページがある機能にはAPIエンドポイントも用意されています。ユーザー、学校、メンテナンス、タグ、スライサープロファイル、G-codeマクロにも対応しています。

  • キュー:/queue/AddItemからのアイテム追加、承認待ちの一覧表示、プリンターの割り当て、順序の変更、承認または却下
  • プリンター:状態の確認、G-codeの送信、軸の移動、ファンとモーターの制御、原点復帰、一時停止、再開、キャンセル
  • ファイルとジョブ:アップロード、移動、履歴の取得、アーカイブ、原価見積もりの取得
  • フィラメント:在庫の確認、プリンターへの割り当て、重量の調整、乾燥済みの記録、ブランドと色の管理
  • 組織とユーザー:メンバー、権限、カスタムフィールド、タグ、学校のクラスを管理

すべてのエンドポイントを見る

状態を取得。コマンドを送信。認証ヘッダーは共通。

1回の呼び出しですべてのプリンターを一覧表示できます。レスポンスには、パネルに表示されるものと同じプリンターオブジェクトが含まれます。ステータス、現在のジョブ、温度、装着中のフィラメントなどの情報を確認できます。

curl "https://api.simplyprint.io/{companyId}/printers/Get" \
  -H "X-API-KEY: your_api_key_here"
実行中のプリントの一時停止、単発のG-codeの送信、軸の移動が可能です。いずれもリアルタイムのエンドポイントで、JSONを入力し、JSONを返す同じ形式です。
curl -X POST "https://api.simplyprint.io/{companyId}/printers/actions/Pause" \
  -H "X-API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "pid": 42 }'
curl -X POST "https://api.simplyprint.io/{companyId}/printers/actions/SendGcode" \
  -H "X-API-KEY: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "pid": 42, "gcode": "G28 X Y" }'

REST、JSON、ヘッダー1つだけ

すべてのエンドポイントはHTTPSを使用し、JSONで入出力します。認証に必要なヘッダーはX-API-KEY: your_key_hereの1つだけです。レスポンスには常に真偽値のstatusが含まれ、必要に応じてmessageも含まれるため、すべての呼び出しで同じ形式のエラー処理ができます。

ベースURLはhttps://api.simplyprint.io/{companyId}/{endpoint}です。{companyId}はAPIのバージョンではなく、アカウントIDです。SDKは不要です。cURL、Postmanなど、既存のHTTPクライアントを利用できます。

Weshape
導入事例

WeshapeがAPIで~50 printersを運用する方法を見る

One of the most impactful features in SimplyPrint has been the API access, which has been implemented and expanded in the time we've been with SimplyPrint. We sometimes have unique challenges, and the API gives us an effective way to make it fit our exact use-case.
- Weshape, Kolind, Denmark
Weshapeの事例を読む

特定のプリンターブランド向けに開発する場合

SimplyPrintはハードウェアのメーカーを問いません。ブランド別のAPIページでは、それぞれの環境で重要なエンドポイント、コードサンプル、固有の注意点を紹介しています。Prusa、Bambu Lab、OctoPrintのホストを対象とする連携コードを作成する場合は、こちらから始めてください。

Prusa MK4、MK4S、MK3.9、MK3.5、Mini+、XL、CORE Oneをコードから操作できます。PrusaLinkに対応しています。

Bambu Lab X1C、P1S、P1P、A1、A1 Mini、H2Dをコードから操作できます。AMSにも対応しています。

OctoPrint REST連携から移行しますか?同じ形式でクラウド上にホストされるため、新たにサーバーを構築する必要はありません。

2つのプラン:Basic APIとEnhanced API

APIアクセスには2つのレベルがあり、プランによって利用できるレベルが異なります。Basicでは読み取りと限定的な書き込みが可能です。Enhancedではファイルのアップロード、キューの変更、プリントの開始、G-codeの送信が可能になります。

フレーム フレーム

基本API

プリンターの状態、キュー、ジョブ、履歴、フィラメント、タグを読み取ります。

拡張API

すべての読み取りと書き込みに対応:アップロード、プリント開始、G-code送信、一括操作。

各エンドポイントのcURL付きライブAPIドキュメント

各エンドポイントには専用のドキュメントページがあり、リクエストの形式、パラメーター表、コピーして使えるcURLの例、右側に実際の成功レスポンスが表示されます。ペイロードの形式を推測する必要はありません。ドキュメントが仕様そのものです。

プリントジョブ

POST /{id}/jobs/GetPaginatedPrintJobs - 進行中または完了したジョブをページ単位で取得します。プリンター、ユーザー、ステータス、日付で絞り込めます。

プリンター情報

POST /{id}/printers/Get - 1台または複数のプリンターを、状態、フィラメント、ハードウェア仕様、メンテナンスフラグとともに取得します。

ファイルのアップロード(拡張版)

POST files.simplyprint.io/{id}/files/Upload - 100 MBまでは単一リクエストで、それを超える場合はマルチパートでアップロードします。

APIキー認証

ヘッダーは1つ(X-API-KEY)、ベースURLも1つです。アカウント設定からキーを取得してください。

OAuth2フロー

パートナーアプリ向け:各顧客が標準の認可とトークン交換を通じて自身のアカウントを接続します。

パートナー連携向けOAuth2

SimplyPrintの顧客向けにサードパーティー製アプリを開発する場合は、OAuth2を使うことで、各顧客が同意画面から自身のアカウントを接続できます。共有APIキーやシークレットのコピー&ペーストは不要です。これは公式のCura連携と同じフローで、Zapier、n8n、Make、Activepiecesなどのプラットフォーム向けパートナー連携にも提供しています。

  • 認可URL: https://simplyprint.io/panel/oauth2/authorize
  • トークン交換: https://simplyprint.io/api/0/oauth2/Token(0は意図的な指定です。交換はアカウントに限定されません)
  • 連携されたアカウントの確認:交換後、ベアラートークンを使って/account/GetUserを呼び出すと、ユーザーが選択したアカウントを確認できます。
  • 以降の呼び出し:標準の/api/{companyId}/{endpoint}パスをBearerトークンとともに使用します。
# 1) Send the user to the consent screen
https://simplyprint.io/panel/oauth2/authorize
  ?response_type=code
  &client_id=YOUR_CLIENT_ID
  &redirect_uri=https://your-app.example.com/callback
  &scope=printers.read+queue.write+files.read
  &state=<random>

# 2) Exchange the returned code for an access token
curl -X POST "https://simplyprint.io/api/0/oauth2/Token" \
  -d "grant_type=authorization_code" \
  -d "code=AUTH_CODE_FROM_CALLBACK" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=YOUR_CLIENT_SECRET" \
  -d "redirect_uri=https://your-app.example.com/callback"

# 3) Discover the bound company, then call API as that company
curl "https://simplyprint.io/api/0/account/GetUser" \
  -H "Authorization: Bearer ACCESS_TOKEN"
承認されたOAuth2クライアントは、OAuth2クライアント申請フォームを通じて発行されます。リダイレクトURI、申請するスコープ、アプリの機能をまとめた1段落の説明を送信してください。

OAuth2クライアントアクセスをリクエスト

プラン別のAPIレート制限と機能

Free、Basic、Cloud Slicer、Filament ManagerプランではAPIを利用できません。Pro以上ではBasic API、Print Farm以上ではEnhanced API(ファイルのアップロードと書き込み操作)を利用できます。

機能 / 制限 無料 基本 Pro プリントファーム エンタープライズ 学校 クラウドスライサー フィラメントマネージャー
1分あたりのAPIリクエスト数
直近1分間の制限です。この時間内の一時的な集中は問題ありません。上限に達すると短いタイムアウトが返され、1分が経過すると制限がリセットされます。
- - 60 180 600 180 - -
基本APIアクセス
プリンターの状態、キュー、ジョブ、履歴、フィラメント、タグを読み取ります。Pro以上のプランで利用できます。
拡張API(読み書きの全機能)
ファイルのアップロード、プリントを開始するキューの変更、G-codeの直接送信、一括書き込み操作が利用可能になります。プリントファームプラン以上が対象です。
Zapier、n8n、Make、Activepieces
OAuth2ベースの公式ピースを使って接続します。書き込み機能はアカウントのAPIプランに従います。
MCP経由のAIエージェント
Claude、Claude CodeなどのMCP対応AIクライアントを接続し、自然言語でプリンター群を操作できます。

プランについて詳しく確認しますか?

料金と機能の比較をすべて表示
機能の画像

APIとWebhookを連携してイベントをプッシュ通知

REST APIはプル方式です。リクエストに対してSimplyPrintが応答します。Webhooksと組み合わせるとプッシュ方式も使えます。プリントの開始、ジョブの完了、フィラメント切れ、プリントキューの項目の承認などのイベントをSimplyPrintがエンドポイントにPOSTするため、ポーリングは不要です。両方を使うことで、あらゆる連携パターンに対応できます。

Webhooksはプリントファーム以上のプランに含まれ、パネル内部と同じイベントモデルを使用します。

Webhooks機能を見る

APIキーを30秒で取得

パネルにログインし、アカウント設定 → APIを開いて、キーに名前を付けてコピーすれば完了です。キーはユーザーごとに発行され、アカウント内の権限に従います。そのため、連携機能はキーの所有者と同じ権限でのみ動作します。

API設定を開く
機能の画像

完全なリファレンスはapidocs.simplyprint.ioで確認できます

すべてのエンドポイント、リクエストとレスポンスの形式、エラーコード、OAuth2フロー、スコープ一覧を掲載しています。ドキュメントはAIにも対応しており、AIが一度に読み込めるllms.txtと、カタログを利用したツールの構築に使える構造化されたapi/index.jsonを用意しています。

APIリファレンスを開く

追加機能:公開されたOpen Filament Database API

SimplyPrint APIに加え、3Dプリント用フィラメントのブランド、素材、色、サイズ、販売店をまとめたオープンソースのカタログ、Open Filament Databaseも運営しています。MITライセンスで提供され、完全にオープンなJSON APIを備えています。キー、認証、利用制限プランは不要で、ブランド、素材、色のデータをアプリ、スライサー、ストア、スプール管理ツールに直接取り込めます。このデータはSimplyPrintのフィラメントプリセットにも使われています。

エンドポイント: api.openfilamentdatabase.org、詳細なドキュメント: openfilamentdatabase.org/docs。

Open Filament Databaseについて

よくある質問

アカウント設定 → API。各キーはユーザーに紐付けられ、アカウント内の権限を引き継ぎます。Pro以上のプランでAPIを利用できます。FreeとBasicプランではAPIを利用できません。
Proでは1分あたり60リクエスト、Print FarmとSchoolでは180リクエスト、Enterpriseでは600リクエストです。Free、Basic、Cloud Slicer、Filament ManagerプランではAPIを利用できません。制限に達すると短時間のタイムアウトが発生し、1分間の枠が切り替わると制限がリセットされます。1秒間に数件多くリクエストを送っても問題ありません。
APIキーは、アカウントとの独自連携に使えます。ヘッダー1つで済む最もシンプルな方法です。他のSimplyPrintの利用者が自分のアカウントに接続する製品を開発する場合は、OAuth2を使用します。各利用者が同意画面で認可するため、認証情報を見ることはありません。承認されたOAuth2クライアントは、OAuth2クライアント申請フォームを通じてSimplyPrintが発行します。
はい。SimplyPrintはPrusaプリンター(MK4、MK4S、XL、Mini+、MK3.5、MK3.9、CORE One)にファームウェア側の連携で、Bambu Labプリンター(X1C、P1S、P1P、A1、A1 Mini、H2D)に直接接続で、OctoPrint対応機器にプラグインで接続します。API上ではすべて同じプリンターオブジェクトとして扱われるため、ブランドに関係なく同じコードを使用できます。各エコシステムの詳細は、ブランド別のページをご覧ください:Prusa API、Bambu Lab API、OctoPrintの代替。
はい。Webhooksはキュー、ファイル、プリンター、ジョブ、フィラメントのイベントをプッシュ通知するため、ポーリングは不要です。Print Farm以上のプランに含まれます。詳しくはwebhooksの機能ページをご覧ください。
はい。SimplyPrint MCPサーバーは、同じプリンター群の操作をClaude、Claude Code、その他のMCP対応AIクライアント向けのネイティブツールとして提供します。OAuth2を使用し、スコープでアクセスを制限します。Pro以上のプランで利用できます。MCP機能ページをご覧ください。
まだありません。APIはHTTPS経由の標準的なJSONを使用するため、最新のHTTPクライアントなら数行で利用できます。公式のCura連携と、AIエージェント向けのSimplyPrint MCPサーバーを提供しています。また、Zapier、n8n、Make、Activepiecesなどのプラットフォームでのパートナー連携向けに、リクエストに応じてOAuth2クライアントを発行しています。言語別のSDKが必要な場合は、[email protected]までお問い合わせください。
公開サンドボックスはありません。連携機能は実際のアカウントを使って開発します。開発用に別のテストアカウント(無料またはPro)を作成し、専用のAPIキーを発行して、連携先として使用できます。その後、本番用のキーに切り替えてください。本格的に連携に取り組むパートナーには、リクエストに応じて開発しやすい環境を用意できます。
ベースURLはhttps://api.simplyprint.io/{companyId}/{endpoint}です。ホストの後の数字はバージョンではなくアカウントIDです。たとえば、/api/123/account/Testはアカウント123のaccount/Testエンドポイントにアクセスします。現在、APIのバージョンはURLに含まれません。APIに機能を追加しても、既存のインターフェースの互換性は維持されます。

レスポンスの構造を破壊的に変更する、認証方式を変更する、URLを再構成するなどの大規模な変更を行う場合は、/v2などのプレフィックスを付けて提供し、既存のAPIも並行して利用できるようにします。現在、このような変更の予定はありませんが、対応方針としてお知らせします。

ブランド別APIガイド

特定のプリンターエコシステム向けに開発する場合、各ガイドでそのブランドに重要なエンドポイント、コード例、固有の注意点を確認できます。

目次