はじめに

Workatoにおいて、標準のコネクタが提供されていない、あるいはコミュニティライブラリでもコネクタが提供されていないアプリケーションとAPI連携を行うには、汎用的なコネクタとして用意されている「HTTPコネクタ」を利用するか、Connector SDKを利用してカスタムコネクタを独自に開発する必要があります。

これまでカスタムコネクタ開発には、RubyおよびWorkatoカスタムコネクタに対する理解が必要で敷居が高いものでしたが、最近ではOpenAPI 3.0形式（OpenAPI 3.0 Specification）のファイルのインポートによるカスタムコネクタの自動生成に対応するようになり、OpenAPI 3.0形式のファイルが用意されていれば、ほぼノーコードかつ一瞬でカスタムコネクタを作成できるようになりました。

以下では、OpenAPI 3.0形式のファイルを利用したカスタムコネクタの作成手順について説明します。

手順

１．Workatoのワークスペース上で「Tools」－「Connector SDK」をクリックします。

２．「New connector」をクリックします。

３．「Import OpenAPI specification」を選択します。

４．「Upload」ファイルを選択のうえファイルアップロードするか、「From URL」を選択のうえOpenAPI 3.0形式のyamlまたはjsonファイルのURLを指定します。

例えば、アラームボックス（ https://alarmbox.jp/ ）のAPIを利用したい場合は、アラームボックスのAPIリファレンス（ https://alarmbox.github.io/alarmbox_api_docs/refs/ ）上にある「openapi.yaml」のURLをコピーし、そのURLをWorkatoへ貼付します。

５．設定完了後「Next」をクリックします。

６．画面をスクロールし、認証タイプと、追加したいアクションを選択し、「Go to Editor」をクリックします。

７．コードの自動生成が開始します。

８．コードの自動生成が完了すると、次の画面に遷移します。「Release latest version」をクリックすると、カスタムコネクタがワークスペース上にリリースされます。

９．メッセージ（任意の値）を入力し、「Release」をクリックします。

１０．以下のメッセージが表示されれば、レシピで作成したカスタムコネクタを利用可能な状態となります。

１１．レシピを作成し、カスタムコネクタが利用可能であることを確認します。

最後に

Import OpenAPI specificationは2022/11時点でベータ版であるため、全てのOpenAPI 3.0形式のファイルに対応できない場合があります。
また、アプリケーションによっては用意されているOpenAPI 3.0形式のファイルが不完全な場合もあり、そのままでは動作せず、インポート後に修正が必要となる場合があります。
以上の点をあらかじめ理解の上、本機能をご活用ください。

参考