SDK リファレンス

このリファレンスは、Workato コネクターに含めることのできる属性すべての完全なリストです。このセクションは、コネクターのルートキーごとに整理されています。ルートキーの一覧は以下の通りです。

• connection - コネクターとターゲット API との接続の確立に関わる、あらゆる側面を扱います。
• test - connection キーと連携し、接続が正常に確立されたことを確認します。
• actions - コネクターに含まれるすべてのアクションの定義が含まれます。
• triggers - コネクターに含まれるすべてのトリガーの定義が含まれます。
• object_definitions - よく使用する入力項目や出力項目を定義します。それらの項目は後で、アクションやトリガーにおいて参照します。
• pick_lists - 入力項目においてドロップダウンを生成するために使用されます。
• methods - コネクター内のどこからでも呼び出せる再利用可能なメソッドを作成します。
• secure_tunnel - オンプレミスシステムと通信するための OPA 互換のコネクターを作成するために使用します。
• webhook_keys - 静的 Webhook トリガーと組み合わせて使用します。
• streams - ファイルストリーミングを実装するために、アクションやトリガーと併せて使用します。

以上に加え、この SDK リファレンスには、以下に関する情報も含まれています。

• 入力項目と出力項目の定義
• リクエストを送信する HTTP メソッドの使用
• コネクターのコード内で使用できる Ruby メソッド

サンプルコネクターのスケルトン

Workato の各コネクターは大きな1つのハッシュであり、そこには上で説明した各種のルートキーが含まれています。以下に、簡単にまとめたコネクターの例を示します。すべてのキーが必須というわけではありません。

{
  title: 'My sample connector',

  connection: Hash,

  test: lambda do
    Boolean
  end,

  custom_action: Boolean,

  custom_action_help: Hash,

  actions: Hash,

  triggers: Hash,

  object_definitions: Hash,

  pick_lists: Hash,

  methods: Hash,

  secure_tunnel: Boolean,

  webhook_keys: lambda do
    String
  end,

  streams: Hash
}