APIドキュメント|ProcessMind
ProcessMind APIリファレンス:エンドポイント・認証・統合ガイド
このガイドでは、ProcessMind サービスのAPIコール事例とベストプラクティスを紹介します。データの取得・登録やワークフロー自動化など、API連携方法を理解することが重要です。
詳細なエンドポイント仕様やリクエスト/レスポンス形式はAPIリファレンスをご覧ください。
追加の例やクライアントライブラリはAPIドキュメント(GitHub)へ。
全APIリクエストは下記のURLへ送信します:
https://api.processmind.com 全てのAPIリクエストには x-api-key ヘッダーでAPIキーが必要です:
x-api-key: your-api-key-here APIキーはProcessMindのアカウント設定から取得できます。APIキー取得方法を参照してください。
ProcessMind API でできること:
ProcessMind API でよく利用される操作の実践例を紹介します。
データテーブルにファイルをアップロードする前に、署名付きURLを取得します:
const presignedUrl = await getPresignedUploadUrl({
apiKey,
tenantId: "tenant-123",
datatableId: "table-456"
});
console.log(presignedUrl); // https://s3.amazonaws.com/…?X-Amz-Signature=… テナント内のすべてのデータセットを取得:
const datasets = await getDatasets({
apiKey,
tenantId: "tenant-123"
});
console.log(datasets); テナントの詳細情報を取得する:
const tenantInfo = await getTenant({
apiKey,
tenantId: "tenant-123"
});
console.log(tenantInfo); テナント内に新しいプロセスを作成する:
const process = await createProcess({
apiKey,
tenantId: "tenant-123",
displayName: "Order to Cash"
});
console.log(process.id); // 後続処理でこのIDを利用 プロセスの定義となるBPMNファイルをアップロード:
const fs = require("fs");
const bpmnXml = fs.readFileSync("./my-process.bpmn", "utf8");
await uploadBpmn({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
bpmnXml
}); 分析のためデータテーブルをプロセスに紐付ける:
const mapping = await createProcessMapping({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
dataTableId: "datatable-789",
displayName: "Sales Data 2024",
showByDefault: true
}); テナントへユーザーを追加する例:
const result = await addTenantUser({
apiKey,
tenantId: "tenant-123",
id: "user-456",
email: "colleague@example.com",
isAdminInTenant: false,
isActiveInTenant: true,
sendInvitationEmail: true
}); ProcessMind でファイルをアップロードする一般的な流れ:
getPresignedUploadUrl 呼び出しで署名付きURLを取得fetchを使ったシンプルな例:
async function uploadFile({ apiKey, tenantId, datatableId, file }) {
// ステップ1: 署名付きURLを取得
const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
// ステップ2: PUTでファイルをアップロード
await fetch(uploadUrl, {
method: "PUT",
headers: {
"Content-Type": file.type
},
body: file
});
} info
複数の言語でそのまま使えるコピペ可能なサンプルをご紹介します。
2回のcurlコマンドでProcessMindへファイルをアップロードする最小限のBashスクリプト例です(各値は適宜置換してください)。
presigned URLを使ってローカルCSVファイルをProcessMindへアップロードします。
手順:
設定:
https://api.processmind.com ですpresigned URLを使いローカルCSVファイルをリモートAPIにアップロードします。
手順:
設定:
info
API利用のご質問やサポートが必要な場合は、サポートチームまでお問い合わせいただくか、開発者コミュニティフォーラムをご活用ください。
当サイトでは、閲覧体験の向上、コンテンツのパーソナライズ、トラフィックの分析のためにCookieを使用しています。「すべて許可」をクリックすると、Cookieの使用に同意いただいたことになります。