FastComments SDK של Java

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 Client -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>2.0.0</version>
    </dependency>
    
    <!-- Core Library (includes SSO) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>core</artifactId>
        <version>2.0.0</version>
    </dependency>
    
    <!-- PubSub Library (for live events) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>2.0.0</version>
    </dependency>
</dependencies>

Gradle

הוסף את מאגר Repsy לקובץ build.gradle שלך:

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

dependencies {
    // API Client
    implementation "com.fastcomments:client:2.0.0"
    
    // Core Library (includes SSO)
    implementation "com.fastcomments:core:2.0.0"
    
    // PubSub Library (for live events)
    implementation "com.fastcomments:pubsub:2.0.0"
}

Library Contents

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

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

Public vs Secured APIs

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

ה-ModerationApi מפעיל את לוח הבקרה של המודרטור. הוא כולל שיטות למתן מענה על תגובות (רשימה, ספירה, חיפוש, לוגים וייצוא), פעולות Moderation (הסרה/שחזור, דגל, הגדרת מצב לסקירה/דואר-זבל/אישור, הצבעות, ופתיחה/סגירה של שרשור), איסורים (איסור מכתיבת תגובות, ביטול איסור, תקצירים לפני איסור, מצב האיסור והעדפות, וספירת משתמשים מנועים), ותגים ואמון (הענקה/הסרה של תג, תגיות ידניות, קבלת/הגדרת גורם אמון, ופרופיל פנימי של משתמש). כל שיטה ב-ModerationApi מקבלת פרמטר sso כך שהקריאה יכולה להתבצע בשם מודרטור שהאומת באמצעות SSO.

שימוש ב-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. המזהה צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים באותו סשן בדפדפן.