Web Client DAT

概要

Web Client DATはTouchDesignerからWebサーバーにHTTPリクエストを送ります。GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCHの各HTTPメソッドをサポートしています。
Basic、oauth1、oauth2などの様々な認証タイプをサポートしています。Webサーバーからのストリーミングを可能にします。WebサーバーにHTTPリクエストを送信し、そのレスポンスをDATに出力します。ストリーミングを有効にすると、ウェブ・サーバーからのデータをストリーミングすることができます。
ストリーミングを有効にする場合は、Clamp Output as Rowsを有効にしてください。これにより、DATの出力が生のテキストではなく、FIFOテーブルに変わります。最後のN行のみが表示されます(NはMaximum Linesパラメータの値)。これにより、DAT内のテキストが大きくなりすぎるのを防ぎ、結果的にcookタイムを短縮することができます。
Web Client DATは、GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCHの各リクエスト・メソッドの送信をサポートしています。また、4つの認証方法をサポートしています。ベーシック、ダイジェスト、OAuth1、OAuth2の4つの認証方式をサポートしています。
最初の入力は、リクエストで送信する追加ヘッダーです。これは、名前と値のペアで構成された2つのカラムを持つテーブルでなければなりません。例えば、以下のようになります。

Content-Type
application/json
Connection
Close

2つ目の入力は、リクエストで送信する追加オプションです。これらは、URLに付加されるクエリパラメータです。これは、名前と値のペアで構成された2つのカラムを持つテーブルにすることができます。名前と値のペアで構成された2つのカラムを持つテーブルにすることもできますし、ただのテキストにすることもでき、その場合はそのまま追加されます。

入力例:

name
joe
Connection
Close

Web Client DATはWeb DATの後継機能です。
以下の章も参照してください。Web Server DAT、SocketIO DAT、XML DAT、TCP/IP DAT、WebSocket DAT、Web DAT

パラメータ – Web Client ページ
Active / active

オペレータのオン/オフを切り替えます。

Request Method / reqmethod

HTTPリクエストメソッドを設定します。

  • GET / get
    GETメソッドは、指定されたリソースの表現を要求します。GETを使用したリクエストは、データのみを取得する必要があります。
  • POST / post
    POSTメソッドは、指定されたリソースにエンティティを送信するために使用され、多くの場合、状態の変更やサーバーへの副作用を引き起こします。
  • PUT / put
    PUTメソッドは、対象となるリソースの現在の表現をすべてリクエストのペイロードで置き換えます。
  • DELETE / delete
    DELETEメソッドは、指定したリソースを削除します。
  • HEAD / head
    HEADメソッドは、GETリクエストと同じレスポンスを要求しますが、レスポンスボディはありません。
  • OPTIONS / options
    OPTIONSメソッドは、対象となるリソースの通信オプションを記述するために使用します。
  • PATCH / patch
    PATCHメソッドは、リソースに部分的な変更を加える際に使用します。
URL / url

HTTPリクエストを送信するサーバーのURLを設定します。

Upload File / uploadfile

アップロードファイルの内容がサーバーに送信されます(必要に応じてチャンクされます)。

Request / request

リクエストの送信

Stop / stop

サーバーからのデータの流れを停止します。

Stream / stream

ストリーミングを有効にします。これは、サーバーがストリーミングをサポートしている場合のみ有効にする必要があります。

Verify Certificate (SSL) / verifycert

TLS(Transport Layer Security)の証明書検証を有効にする。

Timeout / timeout

Webサーバーからの応答がない場合のリクエストのタイムアウトを設定します。

Include Header in Output / includeheader

レスポンスの出力にヘッダーを含めます。

Asynchronous / async

非同期の送受信を可能にします(Webサーバーからの応答を待つ間、TouchDesignerがハングアップしないようにします)。

パラメータ – Authentication ページ
Authentication Type / authtype

認証の種類を設定します。

  • None / none
    認証なし
  • Basic / basic
    ベーシック認証はベース64でエンコードされたユーザー名とパスワードです。
  • Digest / digest
    ダイジェスト認証は、ベース64エンコードされたユーザー名とパスワードをハッシュ関数で暗号化したものです。ダイジェスト認証は、ベーシック認証をより安全にしたものです。
  • OAuth1 / ouath1
    OAuthのバージョン1。OAuth1では、App Key、App Secret、User OAuth Token、User OAuth Secretが必要です。これらのパラメータは、リクエストが送信されるWebサーバーのアカウントで確認できます。例えば、Twitter APIの場合、これら4つのパラメータの値は、アカウントのプロファイルに記載されています。
  • OAuth2 / ouath2
    OAuthのバージョン2。OAuth2では、まずWebサーバーにHTTPリクエストを送信し、クライアントIDとトークンを取得する必要があります。ブラウザを使って取得することができます。
Username / username

Basic/Digest認証で使用するユーザー名を設定します。

Password / pw

Basic/Digest認証で使用するパスワードを設定します。

App Key / appkey

Webサーバーから取得したOAuth1 App Key。

App Secret / appsecret

Webサーバーから取得したOAuth1 App Secret。

User OAuth Token / oauthtoken

Webサーバから取得したOAuth1ユーザートークン。

User OAuth Secret / oauthsecret

Webサーバーから取得したOAuth1ユーザーシークレット。

Client ID / clientid

Webサーバから取得したOAuth2クライアントID。

Token / token

Webサーバーから取得したOAuth2トークン。

パラメータ – Common ページ

参照:共通 Common ページ