FastComments Java SDK

תן לסוכן הקידוד שלך את ההקשר של FastComments שהוא צריך - וידג'טים, תצורה, Secure SSO, ה‑REST API, וה‑SDKs:

npx skills add fastcomments/skills

עובד עם Claude Code, Codex, Cursor, Copilot, Gemini, וכל סוכן אחר שה-skills CLI תומך בו.

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>

לאחר מכן הוסיפו את יחסי התלות הדרושים:

<dependencies>
    <!-- לקוח API -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>3.1.1</version>
    </dependency>
    
    <!-- ספריית הליבה (כולל SSO) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>core</artifactId>
        <version>3.1.1</version>
    </dependency>
    
    <!-- ספריית PubSub (עבור אירועים חיים) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>3.1.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:3.1.1"
    
    // ספריית הליבה (כולל SSO)
    implementation "com.fastcomments:core:3.1.1"
    
    // ספריית PubSub (עבור אירועים חיים)
    implementation "com.fastcomments:pubsub:3.1.1"
}

תוכן הספרייה

ספרייה זו מכילה שלושה מודולים: לקוח ה-API שנוצר אוטומטית, ספריית הליבה של Java המכילה כלים שנכתבו באופן ידני כדי להקל על העבודה עם ה-API, ומודול ה-pubsub שהוא ספרייה להרשמה לעדכוני שינויים (change feeds).

• תיעוד ספריית לקוח ה-API
• תיעוד ספריית הליבה, כולל דוגמאות SSO
• תיעוד ספריית PubSub

APIs ציבוריים מול APIs מאובטחים

בלקוח ה-API קיימות שלוש מחלקות: DefaultApi, PublicApi, ו-ModerationApi. ה-DefaultApi מכיל שיטות הדורשות את מפתח ה-API שלכם, וה-PublicApi מכיל שיטות שניתן לקרוא להן ישירות מדפדפן/מכשיר נייד/כדומה ללא אימות.

ה-ModerationApi מספק חבילה נרחבת של APIs לניהול (moderation) חי ומהיר. כל שיטה של ModerationApi מקבלת פרמטר sso ויכולה לבצע אימות באמצעות SSO או באמצעות עוגיית סשן של FastComments.com.

שימוש ב-APIs מאומתים (DefaultApi)

חשוב: עליך להגדיר את מפתח ה-API ב-ApiClient לפני ביצוע בקשות מאומתות. אם לא תעשה זאת, הבקשות ייכשלו עם שגיאת 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();

        // REQUIRED: Set your API key (get this from your FastComments dashboard)
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // צור את מופע ה-API עם הלקוח שהוגדר
        DefaultApi api = new DefaultApi(apiClient);

        // עכשיו אתה יכול לבצע קריאות API מאומתות
        try {
            // Example: Add an SSO user
            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: אימות הבקשה נכשל
        }
    }
}

שימוש ב-APIs ציבוריים (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();
}

שימוש ב-APIs למודרציה (ModerationApi)

ה-ModerationApi מפעיל את דשבורד המודרטור. כל פעולה מקבלת פרמטר sso שמזהה את המודרטור שאומת דרך SSO ועבורו הבקשה מתבצעת:

import com.fastcomments.api.ModerationApi;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.model.*;

ModerationApi moderationApi = new ModerationApi();

try {
    // רשימת תגובות שממתינות למודרציה
    ModerationAPIGetCommentsResponse response = moderationApi.getApiComments()
        .sso("YOUR_SSO_TOKEN")
        .execute();
    System.out.println(response);
} catch (ApiException e) {
    e.printStackTrace();
}

בעיות נפוצות

1. 401 "missing-api-key" error: ודא שאתה קורא ל-apiClient.setApiKey("YOUR_KEY") לפני יצירת מופע ה-DefaultApi.
2. Wrong API class: השתמש ב-DefaultApi לבקשות מאומתות בצד השרת, וב-PublicApi לבקשות בצד הלקוח/ציבוריות.
3. Null API key: ה-SDK ידלג על האימות בשקט אם מפתח ה-API הוא null, מה שיוביל לשגיאות 401.

מזהי שידור

תשימו לב שעליכם להעביר broadcastId בחלק מקריאות ה־API. כשאתם מקבלים אירועים, תקבלו חזרה את המזהה הזה, כך שתדעו להתעלם מהאירוע אם אתם מתכננים להחיל שינויים בצד הלקוח באופן אופטימיסטי (מה שסביר שתרצו לעשות מאחר שזה מציע את חוויית המשתמש הטובה ביותר). העבירו כאן UUID. המזהה צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים באותו סשן בדפדפן.