こんにちは!リードエンジニアの杉本です。
TēPsは、API を介して EC モール、受注管理システム、Google スプレッドシートやチャットツールなど、日々の業務で利用するさまざまなサービスや機能を自由に組み合わせ、プログラミングの知識や経験がなくても、自社独自の業務を自動化できるiPaaS です。
そんなTēPs はAmazon セラーセントラルやYahoo! ショッピング、ShopifyといったEC 系のコネクタが多数提供されていましたが、CData Connect Server 向けのコネクターを提供しています。本記事ではこのCData Connect Server のコネクタを使ってBitbucket のデータをkintone に連携する手順を解説します。
CData Connect Server は、Bitbucket データのクラウド to クラウドの仮想OData インターフェースを提供し、TēPs からリアルタイムにBitbucket データへ連携することができます。
ホスティングについて
TēPs からCData Connect Server に接続するには、利用するConnect Server インスタンスをネットワーク経由での接続が可能なサーバーにホスティングして、URL での接続を設定する必要があります。CData Connect がローカルでホスティングされており、localhost アドレス(localhost:8080 など)またはローカルネットワークのIP アドレス(192.168.1.x など)からしか接続できない場合、TēPs はCData Connect Server に接続することができません。
クラウドホスティングでの利用をご希望の方は、AWS Marketplace やGCP Marketplace で設定済みのインスタンスを提供しています。
Bitbucket の仮想OData API エンドポイントを作成
まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。
- CData Connect Server にログインして、「DATA MODEL」をクリックします。
- 利用できるデータソースアイコンから"Bitbucket" を選択します。
-
Bitbucket に接続するために必要なプロパティを入力します。
ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。
Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。
- Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
- Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。
Bitbucketでの認証
BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。
特定の認証ニーズ(デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン)に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。
カスタムOAuthアプリケーションの作成
Bitbucketアカウントから、以下のステップを実行します。
- 設定(歯車アイコン)に移動し、ワークスペース設定を選択します。
- アプリと機能セクションで、OAuthコンシューマーを選択します。
- コンシューマーを追加をクリックします。
- カスタムアプリケーションの名前と説明を入力します。
- コールバックURLを設定します。
- デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
- Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
- クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
- OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
- 新しいカスタムアプリケーションを保存するには、保存をクリックします。
- アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
-
「Test Connection」をクリックします。
-
「USERS」 -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
-
API タブをクリックして OData API エンドポイントが生成されていることを確認します。
コネクションとOData エンドポイントを設定したら、TēPs からBitbucket データに接続できます。
フレーズを作成
それではTēPs 側で連携用のフレーズ(一連の処理をまとめたもの)を作成していきましょう。
- フレーズ一覧画面で「+」ボタンをクリックし
- 任意の名前のフレーズを作成します。今回は定期的に実行するフレーズとして構成していきます。
CData Connect Server の接続を追加する
フレーズを作成したら処理を追加していきます。
- 最初にBitbucket からデータを取得するので「+」ボタンから「CData Connect Cloud」→「OData テーブルを検索」を指定します。ちなみに「OData テーブルレコードを取得」はキーを元に1レコードだけ取得する処理になります。
- 「OData テーブルを検索」を追加したらコネクションを追加します。
- 以下の画面でCData Connect Server のメールアドレスとパスワードを指定して「アカウントを追加」をクリックしましょう。
- コネクションを設定するとOData テーブルが選択できるようになります。一覧から先程追加したテーブルを指定しましょう。
- ちなみに「OData テーブルを検索」は様々な条件でデータが取得できます。
ループ処理の追加
次に取得したテーブルデータをループする処理を追加します。
- 新しい処理から「フロー」→「ループ」を選択します。
- ループを追加したら、シーケンスで「OData テーブルを検索」からループする対象のリストを選びましょう。
kintone への登録処理を作成
最後にループの中でkintone への登録処理を作成します。
- 新しい処理として「キントーン」→「レコードを登録」を追加します。
- キントーンへのコネクションを追加します。
- 「サブドメイン」「アプリID」「APIトークン」を指定してコネクションを作成します。
- コネクションを作成すると、以下のようにkintone のアプリに存在する項目が表示されるので、CData Connect Server の項目をマッピングしていきましょう。
フレーズの実行
これでフレーズの作成は完了です。それでは画面右上の再生ボタンからフレーズを実行してみましょう。
- 画面右上の再生ボタンをクリックします。
- 以下のようにメッセージが表示されるので内容を確認して「実行」をクリックします。
- 以下のように実行ログが表示されていき、無事kintone にデータが登録できました!
このように、CData Connect Serverを経由することで、API 側の複雑な仕様を意識せずにTēPs 各種クラウドサービスと連携できます。他にも多くのデータソースに対応するCData Connect Server の詳細をこちらからご覧ください。