Product UpdatesStatus PageAutomation Institute
日本語
Get a trial

# コネクター認定

コネクターの認定を受けると、コミュニティコネクターに Workato の「緑色のスタンプ」が押されます。これによって、自分が作成したコネクターが Workato プラットフォームで注目されるようになります。Workato は認定を与える前にコネクターの 安全性 、 機能性 、 使い安さ を保証するための審査を行います。

# 認定のメリット

コネクターをリストに登録することによって得られる通常のメリットに加えて、認定済みコネクターには次のような特典があります。

  1. コミュニティ内で「Workato 認定済み」バッジが表示される
  2. コミュニティでの参照および検索結果の上位に表示される
  3. コネクターに対する認知度が高まる

# 審査基準

認定に向けてコネクターを提出する際は、安全性、機能性、使いやすさの基準を満たしていることを確認してください。認定プロセスには技術的な審査も含まれ、Workato チームから改善のためのフィードバックが提供される場合もあります。審査が完了すると、コネクターには「Workato 認定済み」のバッジが授与されます。

# 1.安全性

申請者または申請者が代表する企業は、以下の条件を満たしている必要があります。

申請するコネクターは、以下の条件を満たしている必要があります。

  • コミュニティライブラリに登録されていること。方法は、コミュニティライブラリにコネクターを投稿する方法に関するページをご覧ください。
  • コードに機密の資格情報が一切含まれていないこと
  • 対象のアプリの API 以外のどのようなエンドポイントに対しても一切 HTTP 要求を実行しないこと

# 2.機能性

申請するコネクターには実用的なユースケースが必要です。認定を受けるには、コネクターに加えて、その使用方法を示す一連のレシピも提出してください。

# 3.使いやすさ

使いやすさのガイドラインに沿うために、コネクターは以下の条件を満たしている必要があります。

  • わかりやすく、簡単にインストールできること
  • connection ハッシュ、test キー、トリガー、アクションの動作に関する Workato の一般的コードスタイルのガイドラインに従っていること
  • (任意) コネクターが目的どおりに機能することを確認する使用性試験を実施済みであること

詳細は、使いやすさのチェックリストをご覧ください。

# 認定の申し込み

コミュニティコネクターの認定を希望する場合は、 [email protected] までメールをお送りください。

件名には [Certification] に続けてコネクター名を入力します。メール本文には、以下の情報を記載します。

  1. コネクターのプライベート共有のリンク
  2. アプリケーション用の一連のサンドボックス資格情報
  3. 技術的な問合せ先のメールアドレス
  4. パートナーシップに関する問合せ先のメールアドレス
  5. コネクターが威力を発揮するユースケースを実際の動作で示す一連のレシピへのリンク

(任意) コネクターコードへのアクセス権の提供

審査チームがコードベースにアクセスできるようにすると審査が迅速に行われ、認定プロセスが加速されます。

開発に SDK Gem を使用し、コードを GitHub に保存している場合、Workato のチームをリポジトリにゲストとして招待することで、簡単にコードへのアクセス権を提供できます。

# メールの書き方の例

Acme-studios コネクターの認定申し込みのメールの例を示します。

Subject: [Certification] Acme-studios connector
Body:
Hi Workato Collaborators!

I'd like to submit my connector for certification. Here are the following details:
1. Connector link - https://app.workato.com/custom_adapters/43456/details?token=bcae13Bd
2. Sandbox Credentials
    - Login URL: https://wwww.acme-studios.com/login
    - Username: [email protected]
    - Password: g\]tBtX"W.%9x{-V
    - API key: ?C4VLu\%zhb{#t'd
3. Technical contact: [email protected]
4. Partnership contact: [email protected]
5. Recipe use case - Digital Asset Bidirectional sync between acme and box
    - Recipe 1 - https://app.workato.com/recipes/1736013?st=d094d9
    - Recipe 2 - https://app.workato.com/recipes/1735608?st=9f3e95

# 使いやすさのチェックリスト

以下に、コネクターが使用性チェックに合格し、すぐにインストールできるようにするために確認すべきチェックリストの項目を示します。

これらの項目は、すべてを網羅しているわけではありません。Workato のカスタムコネクターのベストプラクティスに関するページを参照することを、強くお勧めします。

  • レシピの機能性とユーザーエクスペリエンス :
    • コネクターのタイトルに接続先のアプリケーションが正確に反映されていること
    • コネクターに、その機能と使用手順を示した説明が付されていること。コネクターの説明は、カスタムコネクターコンソールの [share] タブに表示されます
    • コネクターがコミュニティのリストに登録され承認済みであること
    • コネクターの使用方法を実際の動作で示す一連のレシピを提供していること
  • コネクターコードに対する一般的なスタイルガイドライン
    • アクション、トリガー、object_definition、メソッド、pick_list、変数の命名規則にスネークケースを使用していること
    • 文字列連結 ("string" + "string") ではなく、文字列補間 (#{}) を使用していること
    • シンタックスエラーがないこと
    • 未使用の変数、メソッド、pick_list、object_definition がないこと
    • puts ステートメントが含まれていないこと
  • connection ハッシュについては、以下の条件を満たしている必要があります。
    • すべての秘密パラメータが control_type password によって隠されていること
    • 最適の認証タイプを使用していること。基本認証や API キー認証よりも OAuth2 を推奨します
    • 接続に必要な入力の収集方法について適切なヒントが提供されていること。その他の詳細情報はコネクターの説明に記載できます
    • 機密性を有する資格情報がコネクターコードにハードコードされていないこと
    • 接続の有効性を保つために、関連するトークンの更新論理を使用していること
  • test キーについては、以下の条件を満たしている必要があります。
    • テスト Lambda が最低限のデータを返す有効なエンドポイントを使用していること。言い換えれば、/profile/me のようなエンドポイントまたは応答が1レコードに限られる検索を要求します。
  • トリガーについては、以下の条件を満たしている必要があります。
    • コネクターが 形容詞 - 名詞 の命名規則に従っていること。例 : 「New/updated customer」
    • コネクターに内容を説明する、有用なサブタイトルが付されていること。例 : 「Triggers whenever a customer is created or updated (顧客が作成または更新されたときに発生するトリガー)」
    • 説明が適切なフォーマットに従っていること。例 : 「New/updated customer in Acme-studios」
    • ヘルプテキストが設定され、トリガーの使用方法に関する手引きが提供されること
    • 関連する入力と出力のフィールドが用意されていること
    • ポーリングトリガーを使用する場合、トリガーがページネーションに対応していること。ポーリングトリガーは、現在の期間内に他にも使用可能なレコードが存在するかどうかを can_poll_more を使用して検出します
    • Webhook トリガーを使用する場合、静的 Webhook ではなく動的 Webhook を使用していること。Webhook トリガーは、設定方法に関して明確な手順を示します
  • アクションについては、以下の条件を満たしている必要があります。
    • コネクターが 形容詞 - 名詞 の命名規則に従っていること。例 : 「Create/update customer」
    • コネクターに内容を説明する、有用なサブタイトルが付されていること。例 : 「Creates or updates a customer (顧客を作成または更新する)」
    • 説明が適切なフォーマットに従っていること。例 : 「Create/update customer in Acme-studios」
    • ヘルプテキストが設定され、アクションの使用方法に関する手引きが提供されること
    • 関連する入力と出力のフィールドが用意されていること
    • アクションの API エンドポイントがアクションの目的を正確に反映していること
  • 使いやすさと安定性 [任意ですが推奨されます]
    • コネクターのユニットテストの完全なスイートを作成して、保守すること


Last updated: 2023/10/4 18:53:59

On this page