APIコール
ProcessMind API コールの方法
このガイドでは、ProcessMindサービスのAPIコール例とベストプラクティスを紹介します。data取得・情報送信・workflow自動化まで、API連携の基本を解説します。 詳細なAPI仕様やエンドポイント、認証方法、サンプルリクエスト、レスポンス形式や統合手順はGitHub上のAPIドキュメントをご確認ください。
認証用変数
- apiKey 全APIリクエストで、認証のためリクエストヘッダにAPIキーが必要です。APIキーはProcessMindのアカウント設定で取得できます。
- tenantId 一部エンドポイントでは、リクエストのcontext特定用にTenant IDが必要です。これは組織ごとに一意で、アカウント設定で確認できます。
- datatableId dataset利用時は、対象datatableを特定するDatatable IDが必要です。ProcessMindのdataset設定メニュー「[Get Data Table ID]」で取得できます。
直接ファイルアップロード
ProcessMindはpresigned URLによるdatatableへの直接ファイルアップロードに対応しています。この方法ならAPIキーや機密情報を公開せずに安全にアップロードできます。 Presigned URLは有効期限があるため、取得後すぐ利用しましょう。アップロード用URLはAPIエンドポイントへのGETリクエストで取得できます。 このURLはProcessMindのdataset設定メニュー「[Get upload URL]」でも取得可能です。有効期限は「1時間・1週間・1か月」から選択可能です。
API Endpoint一覧
| Method | Endpoint | 説明 |
|---|---|---|
| GET | /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl | datatableへのファイルアップロード用の一時的なpre-signed URLを返します |
| GET | /tenant/{tenantId}/datasets | 指定したtenantのdataset一覧を返します |
| GET | /tenant/{tenantId} | 指定したtenantの詳細を返します |
| GET | /tenant/{tenantId}/organization | tenantのorganization情報を返します |
API Base URL
全てのAPIリクエストは以下のBase URLに送信してください:https://api.processmind.com
Pre-signed Upload URL取得方法
エンドポイント: GET /tenant/{tenantId}/datatable/{datatableId}/uploads/presignedurl
パラメータ:
- tenantId – tenantのID(string)
- datatableId – アップロード先datatableのID(string)
- apiKey – APIキー(string)
戻り値:
PreSignedUploadUrlを含むレスポンスオブジェクトが返り、このURLにファイルを直接アップロード可能です(通常はHTTP PUT)。
サンプル(ヘルパー利用):
const presignedUrl = await getPresignedUploadUrl({
apiKey,
tenantId: "tenant-123",
datatableId: "table-456"
});
console.log(presignedUrl); // 例: https://s3.amazonaws.com/…?X-Amz-Signature=…
Dataset一覧取得方法
エンドポイント: GET /tenant/{tenantId}/datasets
パラメータ:
- tenantId – tenantのID
- apiKey – APIキー
戻り値:
指定tenantが所持するdatasetオブジェクトの配列
サンプル:
const datasets = await getDatasets({
apiKey,
tenantId: "tenant-123"
});
console.log(datasets);
Tenant情報の取得方法
エンドポイント: GET /tenant/{tenantId}
パラメータ:
- tenantId – tenantのID
- apiKey – APIキー
戻り値:
tenant名・作成日・プランなどのメタ情報を含むオブジェクト
サンプル:
const tenantInfo = await getTenant({
apiKey,
tenantId: "tenant-123"
});
console.log(tenantInfo);
Organization情報の取得方法
エンドポイント: GET /tenant/{tenantId}/organization
パラメータ:
- tenantId – tenantのID
- apiKey – APIキー
戻り値:
tenantに紐づくorganization情報(会社名・住所・連絡先など)
サンプル:
const org = await getOrganization({
apiKey,
tenantId: "tenant-123"
});
console.log(org);
ファイルアップロード方法
uploadFile関数はpre-signed URLでのファイルアップロード例です。
- getPresignedUploadUrlでpre-signed URLを取得
- 取得URLに対しPUTリクエストでファイルをアップロード
- (必要に応じて)APIへアップロード完了を通知(バックエンド仕様による)
fetch利用の簡単なサンプル:
async function uploadFile({ apiKey, tenantId, datatableId, file }) {
// Step 1: pre-signed URL取得
const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
// Step 2: PUTでファイルアップロード
await fetch(uploadUrl, {
method: "PUT",
headers: {
"Content-Type": file.type
},
body: file
});
// Step 3: 完了通知(必要に応じて)
// (バックエンド実装次第)
}
info
- Pre-signed URLは有効期限が短いので取得後すぐ利用してください。
- アップロード失敗時(例:ネットワーク障害)は改めて新しいpre-signed URLでリトライしてください。
- apiKeyは厳重に管理し、クライアント側(公開フロントエンド等)に絶対に公開しないでください。
Bash例:ファイルアップロード
2回のcurlコマンドでProcessMindへファイルをアップロードする最小限のBashスクリプト例です(各値は適宜置換してください)。
Node.js例:ローカルCSVファイルアップロード
presigned URLを使ってローカルCSVファイルをProcessMindへアップロードします。
手順:
- APIからpresignedアップロードURLを取得
- ローカルファイルを読み込み
- HTTP PUTでpresigned URLへファイルをアップロード
設定:
- uploadFileToProcessMind()の呼び出しにAPIキー、tenantId、datatableId、filePathを指定してください。
- APIのBase URLは
https://api.processmind.comです
Python例:ローカルCSVファイルアップロード
presigned URLを使いローカルCSVファイルをリモートAPIにアップロードします。
手順:
- APIからpresignedアップロードURL取得
- ローカルファイルを読み込み
- HTTP PUTでpresigned URLへファイルアップロード
設定:
- api_key、tenant_id、datatable_id、file_pathを必要に応じて設定してください。
info
APIのエンドポイント、認証方法、リクエスト例、レスポンス形式、連携手順の詳細はGitHubのAPIドキュメントをご覧ください。 ご質問やサポートが必要な場合は、サポートチームへお問い合わせ、または開発者コミュニティフォーラムをご利用ください。