Catalyst Java SDKのサードパーティアプリケーションへの統合

Catalyst環境外にデプロイされたアプリケーションで、Catalyst Java SDKのメソッドを統合して使用できます。たとえば、Flaskバックエンド（Catalyst外で実行）を使用してVercelにホストされたReactアプリがCatalyst Cloud Scale Stratusにドキュメントをアップロードしたり、Amazon Web Services EC2上で実行されているデータパイプラインがCatalyst Cloud Scale ZCQLクエリを使用してCatalyst Cloud Scale Data Storeに顧客データをプッシュしたりできます。それぞれのJava SDK操作を使用して実行します。

これらは、外部アプリケーションがCatalystプラットフォーム内にデプロイされることなく、Catalystコンポーネントと安全に連携できる一般的なユースケースのほんの一例です。

外部アプリケーションにCatalyst Java SDKを統合するためのコードスニペットを提供しています。ただし、アプリケーションにコードを実装する前に、以下の前提条件を確認してください。

SDK統合の前提条件

外部アプリケーションにCatalyst Java SDKを統合するには、以下の情報が必要です：

• Project ID:

Catalystプロジェクトの一意の識別子です。

• ZAID (Zoho Account ID):

プロジェクトをCatalyst環境（開発または本番）にリンクするためにCatalystが割り当てる一意のポータル識別子です。

• Environment:

Catalystプロジェクトのターゲット環境（開発または本番）です。

• OAuth Credentials:

Catalystのセルフクライアントポータルを介して外部アプリケーションを認証・認可し、Catalystコンポーネントにアクセスするために必要です。以下が必要になります：

1. Client ID
2. Client Secret
3. Refresh Token

これらの値を取得した後、Java SDKをアプリケーションに統合できます。

統合手順

それでは、これらの各値を取得し、コードスニペットに設定する方法を見ていきましょう。

以下の手順に従ってください：

1. Catalystコンソールでプロジェクトを作成する： コンソールでCatalystプロジェクトを新規作成できます。このヘルプページに記載されている手順を使用してください。

2. Project IDを取得する： プロジェクトを作成したら、Project IDを控えておく必要があります。Project IDはプロジェクト作成時に自動的に生成されるプロジェクトの一意のIDです。

Catalystコンソールの右上隅にある設定アイコンをクリックして確認できます。

設定画面で、Project Settingsに移動し、Generalを選択します。以下のスクリーンショットに示すように、このセクションからProject IDを確認して控えることができます。

3. ZAIDを取得する：

このセクションで提供されるコードスニペットに、プロジェクトのZAIDを含める必要があります。ZAIDは、プロジェクトを必要なCatalyst環境（開発または本番）にリンクするためにCatalystが割り当てる一意のポータル識別子です。

ZAIDを取得するには、Catalyst CloudScale Authenticationコンポーネントの設定が必須です。ただし、アプリケーションの認証フローに使用するかどうかは任意です。ZAIDを取得するには：

i. コンソールでCatalyst CloudScaleサービスに移動し、Security & Identityの下でAuthenticationを選択します。

ii. Native Catalyst Authenticationを設定する必要があります。これにより、Catalystが認証プロセス全体を管理し、追加のコーディングやインフラストラクチャ管理が不要になります。

iii. Set Upをクリックします。

iv. Hosted authenticationタイプを選択します。これにより、アプリケーションの専用ページにログイン要素をホストできます。コンソールから認証を設定・デザインでき、Catalystがアプリケーション用にレンダリングし、すべてのバックエンド要件を処理します。

v. Public Signupオプションを有効にして、ログインコンポーネントにサインアップ機能を表示し、新しいユーザーがアプリケーションに登録してアクセスできるようにする必要があります。詳細なセットアップガイドについては、Hosted Authenticationヘルプページを参照してください。

vi. 確認画面で、Yes, proceedをクリックします。

vii. 以下にリストされているサポートされているソーシャルログインオプションのいずれかを有効にし、選択したプロバイダーから対応するZAID値を取得できます。

4. セルフクライアントアプリケーションを登録する： アプリケーションのユーザーに代わってCatalystリソースにアクセスするための認証・認可を行うために、Refresh Token、Client ID、Client Secretを取得する必要があります。

上記の必要な項目を取得するには、まずAPIコンソールでアプリケーションをセルフクライアントとして登録する必要があります。

i. APIコンソールにログインし、Self-clientをクリックします。

ii. アプリケーションがCatalystで実行する必要のある操作に基づいて、セルフクライアントアプリケーションのスコープを設定します。

利用可能なスコープの詳細を参照してください。

iii. 必要なスコープを指定し、適切な説明を追加して、Createをクリックします。

iv. グラントトークンが生成されます。これは一度限りのプロセスであり、コンソールから再度取得することはできないため、コピーして安全に保管してください。

グラントトークンの生成の詳細を参照してください。

v. Client Secretタブに切り替え、Client IDとClient Secretの詳細を控えます。

vi. このヘルプページのリクエストを使用して、アクセストークンとリフレッシュトークンを生成できます。このページに記載されている手順を使用して、アクセストークンをリフレッシュすることもできます。

上記のすべての値を控えた後、以下に示すようにコードスニペットに設定し、Java SDKをアプリケーションに統合できます。以下のSpringBootコードは、Catalyst CloudScale Stratusからバケットを取得する例で示しています。

コードスニペット

package com.example.demoapp; 
import org.springframework.boot.CommandLineRunner; 
import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
import org.springframework.stereotype.Component; 
import java.util.List; 
import java.util.logging.Logger; 
import org.json.simple.JSONObject; 
import com.zc.common.ZCProject; 
import com.zc.common.ZCProjectConfig; 
import com.catalyst.config.ZCThreadLocal; 
import com.zc.api.APIConstants.ZCAuthType; 
import com.zc.api.APIConstants.ZCUserScope; 
import com.zc.auth.ZCAuth; 
import com.zc.component.USER_TYPE; 
import com.zc.component.object.ZCObject; 
import com.zc.component.object.ZCRowObject; 
import com.zc.component.object.ZCTable; 
@SpringBootApplication 
public class DemoappApplication { 
private static final Logger logger = 
Logger.getLogger(DemoappApplication.class.getName()); 
public static void main(String[] args) { 
SpringApplication.run(DemoappApplication.class, args); 
} 
@Component 
public static class DataProcessor implements CommandLineRunner { 
@Override 
public void run(String... args) { 
try { 
ZCThreadLocal.putValue("user_type", USER_TYPE.ADMIN); 
JSONObject oAuthParams = new JSONObject(); 
oAuthParams.put("client_id", CLIENT_ID); //ここにクライアントIDを入力してください
oAuthParams.put("client_secret", CLIENT_SECRET); //ここにクライアントシークレットを入力してください
oAuthParams.put("refresh_token", REFRESH_TOKEN); //ここにリフレッシュトークンを入力してください
oAuthParams.put("grant_type", "refresh_token");   
ZCAuth auth = ZCAuth.getInstance(oAuthParams); 
auth.setScope(ZCUserScope.ADMIN); 
System.out.println("Auth Object: " + auth); 
ZCProjectConfig config = ZCProjectConfig.newBuilder() 
.setProjectId(PROJECT_ID) //ここにプロジェクトIDを入力してください
.setProjectKey(ZAID) //ここにZAIDを入力してください
.setZcAuth(auth) 
.setProjectDomain("https://api.catalyst.zoho.com") 
.setEnvironment("Development") //"Development"または"Production"を設定してください
.build(); 
ZCProject project = ZCProject.initProject(config, ""); 
ZCStratus stratus = ZCStratus.getInstance(project); 
List  buckets = stratus.listBuckets(); 
} 
catch (Exception e) { 
logger.severe("Error during data processing: " + 
e.getMessage()); 
            } 
        } 
    } 
}