FastComments Java SDK

Maven

Add the Repsy repository to your project's 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>
    <!-- Klient API -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>1.3.1</version>
    </dependency>

    <!-- Biblioteka Core (zawiera SSO) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>core</artifactId>
        <version>1.3.1</version>
    </dependency>

    <!-- Biblioteka PubSub (dla zdarzeń na żywo) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>1.3.1</version>
    </dependency>
</dependencies>

Gradle

Add the Repsy repository to your build.gradle file:

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

dependencies {
    // Klient API
    implementation "com.fastcomments:client:1.3.1"

    // Biblioteka Core (zawiera SSO)
    implementation "com.fastcomments:core:1.3.1"

    // Biblioteka PubSub (dla zdarzeń na żywo)
    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.

• Dokumentacja biblioteki klienta API
• Dokumentacja biblioteki Core, w tym przykłady SSO
• Dokumentacja biblioteki PubSub

API publiczne vs zabezpieczone

For the API client, there are two classes, DefaultApi and PublicApi. The DefaultApi contains methods that require your API key, and PublicApi contains api calls that can be made directly from a browser/mobile device/etc without authentication.

Korzystanie z uwierzytelnionych interfejsów API (DefaultApi)

Ważne: Musisz ustawić swój klucz API na ApiClient przed wykonywaniem uwierzytelnionych żądań. Jeśli tego nie zrobisz, żądania zakończą się błędem 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) {
        // Create and configure the API client
        ApiClient apiClient = new ApiClient();

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

        // Create the API instance with the configured client
        DefaultApi api = new DefaultApi(apiClient);

        // Now you can make authenticated API calls
        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());
            // Common errors:
            // - 401: API key is missing or invalid
            // - 400: Request validation failed
        }
    }
}

Korzystanie z publicznych interfejsów API (PublicApi)

Publiczne endpointy nie wymagają uwierzytelnienia:

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();
}

Częste problemy

1. 401 "missing-api-key" error: Upewnij się, że wywołujesz apiClient.setApiKey("YOUR_KEY") przed utworzeniem instancji DefaultApi.
2. Wrong API class: Użyj DefaultApi do uwierzytelnionych żądań po stronie serwera, PublicApi do żądań po stronie klienta/publicznych.
3. Null API key: SDK automatycznie pominie uwierzytelnianie, jeśli klucz API ma wartość null, co spowoduje błędy 401.

Identyfikatory broadcastów

Zobaczysz, że w niektórych wywołaniach API powinieneś przekazać broadcastId. Kiedy otrzymasz zdarzenia, otrzymasz z powrotem ten identyfikator, dzięki czemu będziesz wiedział, aby zignorować zdarzenie jeśli planujesz optymistycznie zastosować zmiany po stronie klienta (czego prawdopodobnie zechcesz zrobić, ponieważ daje to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, by nie pojawił się dwukrotnie w sesji przeglądarki.