SOAP API に関する FAQ

最初のファイルプルーフを作成する方法を教えてください。

次の 3 つの簡単な手順を実行します。

手順 1：Post リクエスト経由でファイルを https://soap.proofhq.com/upload.php に送信して、ファイルを Workfront Proof にアップロードしますファイルハッシュが返されます。このファイルハッシュは非常に重要です。この段階ではアカウントには何も表示されないことに注意してください。これまでに行ったことはファイルを送信しただけで、そのファイルをどう扱うかについては指示されていません。

手順 2：まだセッション ID がない場合は、doLogin() または getSessionID() メソッドを使用して取得してください。ユーザーのメールアドレスとパスワードを使用して「ログイン」するには前者を使用し、ユーザーのメールアドレスと認証トークンがある場合は後者の方法を使用します。

手順 3： 次に、プルーフを作成します。createProof() メソッドを使用し、少なくとも必須フィールドは送信します（現在は 5 つしかありません）。「手順 1」で返されたファイルハッシュに Hash パラメーターを設定してください。これにより、プルーフの作成時に使用するファイルを決定できるようになります。

アカウントにログインすると、プルーフが表示されます。

初めての web スナップショット プルーフを作成する方法を教えてください。

次の 2 つの簡単な手順を実行します。

手順 1：まだセッション ID がない場合は、doLogin() または getSessionID() メソッドを使用して取得してください。ユーザーのメールアドレスとパスワードを使用して「ログイン」するには前者を使用し、ユーザーのメールアドレスと認証トークンがある場合は後者の方法を使用します。

**手順 2：**次に、プルーフを作成します。createProof() メソッドを使用し、少なくとも必須フィールドは送信します（現在は 5 つしかありません）。Hash パラメーターを「web」に設定し、SourceName パラメーターを、取得する web ページの URL に設定してください。

アカウントにログインすると、プルーフが表示されます。

プルーフとバージョンの違いは何ですか？

Workfront Proof では、バージョンは単一のプルーフとして表示されます。Web UI で特定のバージョンをクリックすると、そのバージョンの詳細が表示されます。実際には、各バージョンは個別のプルーフであり、web UI はこれらを一緒に表示していています。

API の観点からすると、各バージョンは個別のプルーフで、プルーフは ID で相互にリンクされます。

createProof() は常にプルーフの バージョン 1 を作成します。例えば、このプルーフに対して返された ID が「100」であるとします。

createProofVersion() を使用する際は、常に前のバージョンの ID を送信します。プルーフ「100」に​ バージョン 2 を作成する場合は、ParentFileID パラメーターに「100」を渡します。これにより、このプルーフをセットのバージョン 2 にすべきだとシステムに伝えられます。このメソッドは一意のプルーフ ID を返します。この例では、これが「101」であるとします。

3 番目のバージョン、つまり​ バージョン 3 が必要な場合は、createProofVersion() を再度呼び出し、今度は ParentFileID に「101」を渡します。これにより、バージョンのリンクされたリストが適切に作成されるようになります。