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>

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

<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

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

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"
}

Library Contents

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

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

Public vs Secured APIs

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

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

Important: עליך להגדיר את ה-API key ב-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) {
        // צור וקנפג את ApiClient
        ApiClient apiClient = new ApiClient();

        // REQUIRED: קבע את ה-API key שלך (קבל אותו מלוח הבקרה של FastComments)
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // צור את מופע ה-API עם ה-ApiClient שהוגדר
        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 key חסר או לא תקף
            // - 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();
}

בעיות נפוצות

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

מזהי שידור

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