CData Arc - 管理API で既存のフローから新たな連携フローを作成・設定する

by 色川穂高 | 2023年02月08日

 
こんにちは。CData Software Japan の色川です。
 
CData Arc ではWeb コンソールで行える操作の多くを、管理API を通じて実現することができます。

Arc が備える管理API は、Arc を管理するためにGUI の操作に縛られない柔軟な方法を提供します。Arc のWeb コンソールで実行できることの多くは、RESTful な管理API を通じて実行することができます。管理API を利用すると、連携フローの作成や実行、運用に関する操作を外部からプログラマブルに実現することが可能です。

CData Arc を業務アプリケーションのバックエンドとして利用頂くケースなど、テンプレート的に用意したフローをベースに、個別業務用のフローを機械的に作成したいケースなどもあると思います。

この記事では、管理API 活用の一例として、事前にテンプレート的な連携フローをテンプレート用のワークスペースに用意して、それをベースに新たなワークスペース/フローを生成して（copyWorkspace）、変更が必要なコネクタ設定を更新する（connectors）流れをご紹介します。

CData Arc
 

管理API

CData Arc の管理API はArc 自身をAPI を通じて操作できる機能です。

管理API は一連のAPI リソースとアクションで構成されます。これらのリソースとアクションへのAPI 呼び出しを組み合わせて、Arc 外部のスクリプトやサーバー、アプリケーションからCData Arc を管理することができます。



管理API について、詳しくはこちらをご覧ください。
CData Arc - 管理API | Version 22.0.8423

管理API を利用できるライセンス

管理API を利用するには、Professional 以上のライセンスが必要です。Professional 以上のライセンスエディションでは、管理API の他にも、エンタープライズ向けのデータ統合に活用頂ける機能を豊富に搭載しています。

CData Arc ライセンスプラン | オンライン注文

事前準備

CData 製品のダウンロードとインストール

CData Arc スタートアップガイドとナレッジベース

管理API へのアクセス（cURL）

この記事では、管理API へのリクエストにcURL を利用します。CData Arc の管理API ページではcURL 以外にもJavaScript のコードサンプルも提供しています。手元の環境ですぐに試して頂くことができます。

API 接続の有効化と認証トークンの取得

管理API を利用したいCData Arc のユーザーアカウントで、API 接続を有効化しておく必要があります。API 接続には発行される認証トークンが必要になりますので、控えておいてください。

管理API へのアクセス制御（信頼されたIP アドレス）

管理API へアクセス可能なIP アドレスを指定します。単一IP アドレス、単純な範囲指定やCIDR 表記で指定することができます。

ベースとする連携フロー

この記事では「C:\work\adminapi\customerXX にある customer.csv を取得して、kintone に連携するフロー」をテンプレートとして用意しました。

具体的な手順

それでは用意した「ワークスペース・フローをベースにワークスペース・フローを生成」し「コピーしたフローでの読み込み先ディレクトリを変更（更新）」してみます。

/api.rsc/copyWorkspace

最初に「既存のワークスペースをコピーして新たなワークスペース・フローを生成」します。

「/api.rsc/copyWorkspace」は、既存のワークスペースをコピーして新たなワークスペースを生成するアクションAPI です。既存のワークスペースに含まれるコネクタは、指定のサフィックスを付与した形で新たに生成されます。

事前準備で用意したフローを含むワークスペースをコピーして、新たなワークスペース・フローを生成します。

Windows 版cURL で実行する場合は以下のように指定します。

curl http://localhost:8001/api.rsc/copyWorkspace --header "x-cdata-authtoken: 管理API を実行するユーザーの認証トークン" -X POST -H "Content-Type: application/json" -d "{ \"WorkspaceId\": \"コピー元のワークスペース名\", \"NewWorkspaceId\": \"コピー先のワークスペース名\", \"ConnectorIdSuffix": \"コピーされたコネクタに接尾語として付与する名前\" }"

指定されたパラメータで新たなワークスペースが構成されていることが確認できます。

/api.rsc/connectors

「/api.rsc/connectors」は、コネクタに関する情報を、取得・作成・更新・削除できるリソースAPI です。



ワークスペース・フローをコピーしたら、最初に「コピーしたフローでのMapping のソースと宛先を変更（更新）」しておきます。XMLMap のソーススキーマと宛先スキーマをコピーしたコネクタのスキーマに更新しておきます。

curl http://localhost:8001/api.rsc/connectors --header "x-cdata-authtoken: 管理API を実行するユーザーの認証トークン" -X PUT -H "Content-Type: application/json" -d "{ \"ConnectorId\": \"更新対象のコネクタID\", \"ConnectorType\": \"更新対象のコネクタタイプ（XMLMap）\", \"source\": \"コピーしたフローでのソーススキーマ\", \"destination\": \"コピーしたフローでの宛先スキーマ\" }"

XMLMap のスキーマが更新されていることが確認できます。

最後に「コピーしたフローでの読み込み先ディレクトリを変更（更新）」します。



この記事では、テンプレート的なワークスペースから新たに生成したフローに含まれるFile コネクタの読み込み先（path パラメータ）を「C:\work\adminadpi\customer01」に更新し、オートメーション設定の受信（automationreceive パラメータ）を有効化します。

curl http://localhost:8001/api.rsc/connectors --header "x-cdata-authtoken: 管理API を実行するユーザーの認証トークン" -X PUT -H "Content-Type: application/json" -d "{ \"ConnectorId\": \"更新対象のコネクタID\", \"ConnectorType\": \"更新対象のコネクタタイプ（File）\", \"path\": \"C:\work\adminapi\customer01\", \"automationreceive\": \"true\" }"

指定されたパラメータで、File コネクタの構成が更新されていることが確認できます。

これで、既存のフローから新たな連携フローを作成・設定することができました。

管理API へのアクセス（ログ）

管理API へのアクセスは、Web コンソールのステータスページ「アクセスログ」で確認することができます。

おわりに

この記事では、CData Arc の管理API 利用の一例として、既存のフローから新たな連携フローを作成・設定する方法をご紹介しました。

CData Arc をRESTful なAPI を通じて管理できる「管理API」はArc の大きな特長の1つです。送受信のトリガーはもちろん、ワークスペースやフローの構成、処理したファイルのメタデータやログデータの取得など、Web コンソールで行えるほとんどを管理API から実行することができます。管理API を上手く利用すれば、Arc への構成や設定そのものを自動化することが可能です。

CData Arc はシンプルで拡張性の高いコアフレームワークに、豊富なMFT・EDI・エンタープライズコネクタを備えたパワフルな製品です。軽量な構成と透明性の高いアーキテクチャを採用しているのも大きな特長です。
 

関連コンテンツ