FastComments Java SDK

Maven

プロジェクトの POM に Repsy リポジトリを追加します:

<repositories>
    <repository>
        <id>repsy</id>
        <name>FastComments Maven Repository on Repsy</name>
        <url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
    </repository>
</repositories>

次に、必要な依存関係を追加します:

<dependencies>
    <!-- API Client -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>0.0.2</version>
    </dependency>

    <!-- Core Library (includes SSO) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>core</artifactId>
        <version>0.0.2</version>
    </dependency>

    <!-- PubSub Library (for live events) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>0.0.2</version>
    </dependency>
</dependencies>

Gradle

build.gradle ファイルに Repsy リポジトリを追加します:

repositories {
    mavenCentral()
    maven {
        url "https://repo.repsy.io/mvn/winrid/fastcomments"
    }
}

dependencies {
    // API Client
    implementation "com.fastcomments:client:0.0.2"

    // Core Library (includes SSO)
    implementation "com.fastcomments:core:0.0.2"

    // PubSub Library (for live events)
    implementation "com.fastcomments:pubsub:0.0.2"
}

ライブラリの内容

このライブラリは3つのモジュールを含みます。生成された API クライアント、API の操作を容易にする手書きのユーティリティを含むコア Java ライブラリ、および変更フィードの購読用ライブラリである pubsub モジュールです。

• API クライアント ライブラリのドキュメント
• コアライブラリのドキュメント（SSO の例を含む）
• PubSub ライブラリのドキュメント

公開APIと保護されたAPI

API クライアントには DefaultApi と PublicApi の2つのクラスがあります。DefaultApi は API キーを必要とするメソッドを含み、PublicApi は認証なしでブラウザやモバイル端末などから直接実行できる API 呼び出しを含みます。

認証済み API の使用 (DefaultApi)

重要: 認証付きリクエストを行う前に ApiClient に API キーを設定する必要があります。設定しないとリクエストは 401 エラーで失敗します。

import com.fastcomments.invoker.ApiClient;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.api.DefaultApi;
import com.fastcomments.model.*;

public class Example {
    public static void main(String[] args) {
        // API クライアントを作成して設定する
        ApiClient apiClient = new ApiClient();

        // 必須: API キーを設定してください（FastComments ダッシュボードで取得）
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // 設定済みのクライアントで API インスタンスを作成する
        DefaultApi api = new DefaultApi(apiClient);

        // これで認証された API 呼び出しが可能になります
        try {
            // 例: SSO ユーザーを追加する
            CreateAPISSOUserData userData = new CreateAPISSOUserData();
            userData.setId("user-123");
            userData.setEmail("user@example.com");
            userData.setDisplayName("John Doe");

            AddSSOUserAPIResponse response = api.addSSOUser("YOUR_TENANT_ID", userData)
                .execute();
            System.out.println("User created: " + response);

        } catch (ApiException e) {
            System.err.println("Error: " + e.getResponseBody());
            // 一般的なエラー:
            // - 401: API キーがないか無効です
            // - 400: リクエストの検証に失敗しました
        }
    }
}

パブリック API の使用 (PublicApi)

パブリックエンドポイントは認証を必要としません:

import com.fastcomments.api.PublicApi;
import com.fastcomments.invoker.ApiException;

PublicApi publicApi = new PublicApi();

try {
    var response = publicApi.getCommentsPublic("YOUR_TENANT_ID", "page-url-id")
        .execute();
    System.out.println(response);
} catch (ApiException e) {
    e.printStackTrace();
}

よくある問題

1. 401 "missing-api-key" エラー: DefaultApi インスタンスを作成する前に apiClient.setApiKey("YOUR_KEY") を呼び出していることを確認してください。
2. 誤った API クラス: サーバー側の認証付きリクエストには DefaultApi を、クライアント側/パブリックなリクエストには PublicApi を使用してください。
3. API キーが null: API キーが null の場合、SDK は認証を黙ってスキップするため、401 エラーになります。

ブロードキャスト ID

一部の API 呼び出しでは broadcastId を渡す必要があるのが分かります。イベントを受け取ると、この ID が返されるので、クライアントに楽観的に変更を適用するつもりであれば、そのイベントを無視することができます （ユーザー体験が最も良くなるため、おそらくそうするでしょう）。ここには UUID を渡してください。ID はブラウザセッション内で二度発生しない程度に十分ユニークである必要があります。