`/apiv2/webhooks/doc`

/apiv2/webhooks/doc API エンドポイントを使用すると、Docwize にプログラムから新しいドキュメントを作成できます。メタデータの登録、ファイルの添付、オプションで workflow の開始に使用できます。

概要

エンドポイント: POST /apiv2/webhooks/doc

/apiv2/webhooks/doc エンドポイントの設計目的:

システムに新しいドキュメントレコードを登録する。
ドキュメントファイルを即時アップロード、または後で使用するためのアップロード URL を取得する。
作成時にオプションで workflow またはカスタムフィールドを関連付ける。

認証

すべてのリクエストに有効な Bearer トークンが必要です。

Authorization: Bearer <ACCESS_TOKEN>

トークンは発行会社に対して検証され、アクティブで取り消されていない必要があります。

リクエスト形式

メソッド: POST

コンテンツタイプ: multipart/form-data

フォームフィールド

フィールド	型	必須	説明
`payload`	JSON 文字列	✅	ドキュメントのすべてのメタデータとオプションが含まれます。
`file`	バイナリ	❌	即時アップロードするオプションのファイル。

ペイロード構造

例:

{
  "document": {
    "DocumentDetails": {
      "Description": "Monthly Financial Report",
      "Date": "2025-01-31T00:00:00",
      "Reference_Number": "INV-2025-001"
    },
    "FolderIds": ["Finance->Reports->2025"],
    "CCs": ["finance-team@example.com"],
    "deduplicate": true
  },
  "file_extension": ".pdf",
  "workflow": {
    "PortalWorkflowTemplateID": 42,
    "Subject": "Approve Financial Report"
  },
  "user_id": 12
}

主要フィールド

`DocumentDetails`

以下のようなコアドキュメントプロパティ:

Description — ドキュメント名またはタイトル。
Date — ドキュメントに関連付けられた日付。
Reference_Number — 外部または内部の一意識別子。

`FolderIds`

Docwize の送信先フォルダパスのリスト（例: Projects->Alpha->Design）。

`deduplicate`

指定したフォルダ内に同じ説明のドキュメントがすでに存在する場合に、重複したドキュメントの作成を防ぎます。

`workflow`

（オプション）ドキュメント作成直後に workflow を開始します。

ファイルの取り扱い

ファイルを即時アップロードするか、後で使用するためのアップロードリンクをリクエストするかを選択できます。

オプション 1 — 即時アップロード

リクエストと共にファイルを直接送信します:

curl -X POST https://portal.docwize.com/apiv2/webhooks/doc \
  -H "Authorization: Bearer <TOKEN>" \
  -F 'payload={"document": {...}}' \
  -F 'file=@document.pdf'

レスポンス:

{"document_id": 1201}

オプション 2 — 遅延アップロード

file を省略すると、エンドポイントは事前署名済みアップロード URL を返します:

{
  "document_id": 1202,
  "upload_url": "https://s3.amazonaws.com/...",
  "image_name": "1202_report.pdf"
}

標準の HTTP PUT リクエストを使用してファイルをアップロードできます:

curl -X PUT "<upload_url>" --upload-file ./document.pdf

ファイルのアップロードが完了したら、以下を呼び出します:

POST /doc/upload-complete/{doc_id}/{image_name}

これによりアップロードが完了したことが確認され、ドキュメントが確定されます。