FastComments Java SDK

Maven

將 Repsy 儲存庫新增到您專案的 POM 檔案：

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

Then add the dependencies you need:

<dependencies>
    <!-- API 用戶端 -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>1.3.1</version>
    </dependency>

    <!-- 核心函式庫（包含 SSO） -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>core</artifactId>
        <version>1.3.1</version>
    </dependency>

    <!-- PubSub 函式庫（用於即時事件） -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>1.3.1</version>
    </dependency>
</dependencies>

Gradle

將 Repsy 儲存庫新增到您的 build.gradle 檔案：

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

dependencies {
    // API 用戶端
    implementation "com.fastcomments:client:1.3.1"

    // 核心函式庫（包含 SSO）
    implementation "com.fastcomments:core:1.3.1"

    // PubSub 函式庫（用於即時事件）
    implementation "com.fastcomments:pubsub:1.3.1"
}

Library Contents

This library contains three modules. The generated API client, the core Java library which contains hand-written utilities to make working with the API easier, and the pubsub module which is a library for subscribing to change feeds.

• API 用戶端函式庫文件
• 核心函式庫文件，包含 SSO 範例
• PubSub 函式庫文件

公開與受保護的 API

對於 API 用戶端，有兩個類別，DefaultApi 和 PublicApi。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" error：請確保在建立 DefaultApi 實例之前呼叫 apiClient.setApiKey("YOUR_KEY")。
2. Wrong API class：對於伺服器端的已驗證請求使用 DefaultApi，對於用戶端/公開請求使用 PublicApi。
3. Null API key：若 API 金鑰為 null，SDK 會靜默地跳過驗證，導致 401 錯誤。

廣播 ID

你會看到在某些 API 呼叫中要傳入一個 broadcastId。當你收到事件時，你會拿回這個 ID，所以如果你打算在客戶端樂觀地套用變更（你很可能會這樣做，因為它提供了最佳體驗），就知道要忽略該事件。這裡傳入一個 UUID。該 ID 應該夠唯一，不會在同一個瀏覽器工作階段中出現兩次。