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 -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>1.3.1</version>
    </dependency>

    <!-- Βιβλιοθήκη Core (περιλαμβάνει 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"

    // Βιβλιοθήκη Core (περιλαμβάνει SSO)
    implementation "com.fastcomments:core:1.3.1"

    // Βιβλιοθήκη PubSub (για ζωντανά γεγονότα)
    implementation "com.fastcomments:pubsub:1.3.1"
}

Περιεχόμενο Βιβλιοθήκης

Αυτή η βιβλιοθήκη περιέχει τρία modules. Ο παραγόμενος πελάτης API, η βασική βιβλιοθήκη Java που περιέχει χειρόγραφα βοηθητικά εργαλεία για να γίνεται ευκολότερη η εργασία με το API, και το pubsub module το οποίο είναι μια βιβλιοθήκη για εγγραφή σε ροές αλλαγών.

• Τεκμηρίωση Βιβλιοθήκης API Client
• Τεκμηρίωση Core Library, Συμπεριλαμβανομένων Παραδειγμάτων SSO
• Τεκμηρίωση Βιβλιοθήκης PubSub

Δημόσια vs Προστατευμένα API

Για τον πελάτη API, υπάρχουν δύο κλάσεις, DefaultApi και PublicApi. Η DefaultApi περιέχει μεθόδους που απαιτούν το κλειδί API σας, και η PublicApi περιέχει κλήσεις API που μπορούν να γίνουν απευθείας από ένα πρόγραμμα περιήγησης/κινητή συσκευή/κ.λπ. χωρίς αυθεντικοποίηση.

Χρήση Αυθεντικοποιημένων API (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 client
        ApiClient apiClient = new ApiClient();

        // ΑΠΑΡΑΙΤΗΤΟ: Ορίστε το κλειδί API σας (παίρνετέ το από το πίνακα ελέγχου του FastComments)
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // Δημιουργήστε το αντικείμενο API με τον ρυθμισμένο client
        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)

Τα δημόσια endpoints δεν απαιτούν αυθεντικοποίηση:

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" σφάλμα: Βεβαιωθείτε ότι καλείτε apiClient.setApiKey("YOUR_KEY") πριν δημιουργήσετε το instance του DefaultApi.
2. Λανθασμένη κλάση API: Χρησιμοποιήστε DefaultApi για server-side αιτήματα με αυθεντικοποίηση, PublicApi για client-side/δημόσια αιτήματα.
3. Κενό κλειδί API (null): Το SDK θα παραλείψει αθόρυβα την αυθεντικοποίηση αν το κλειδί API είναι null, οδηγώντας σε σφάλματα 401.

Αναγνωριστικά Broadcast

Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε μερικές κλήσεις API. Όταν λαμβάνετε γεγονότα, θα λάβετε αυτό το ID πίσω, ώστε να ξέρετε να αγνοήσετε το γεγονός εάν σκοπεύετε να εφαρμόσετε οπτιμιστικά αλλαγές στον πελάτη (που πιθανότατα θα θέλετε να κάνετε καθώς προσφέρει την καλύτερη εμπειρία). Περάστε εδώ ένα UUID. Το ID πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές στην ίδια συνεδρία του προγράμματος περιήγησης.