SDKリファレンス ​

Workatoコネクターに含めることができるすべての属性の完全な一覧です。 このセクションは、コネクターのルートキーごとに構成されています:

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

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

• 入力フィールドと出力フィールドの定義
• HTTPメソッドを使用したリクエストの送信
• コネクターコードで使用可能なRubyメソッド

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

Workatoの各コネクターは、上記で詳しく説明したルートキーを含む大きなハッシュです。 以下に、要約されたコネクターの例を示します。 すべてのキーが必須ではありません。

{
  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
}