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

Садржај библиотеке

Ова библиотека садржи три модула. Генерисани API клијент, основна Java библиотека која садржи ручно написане помоћне класе да би рад са API-јем био једноставнији, и модул pubsub који је библиотека за претплату на фидове промена.

• Документација API клијент библиотеке
• Документација основне библиотеке, укључујући примјере SSO
• Документација PubSub библиотеке

Јавни и заштићени API-ји

За API клијента постоје три класе, DefaultApi, PublicApi, и ModerationApi. DefaultApi садржи методе које захтијевају ваш API кључ, а PublicApi садржи методе које се могу позвати директно из прегледача/мобилног уређаја/итд. без аутентификације.

ModerationApi покреће контролну таблу модератора. Садржи методе за модерацију коментара (листање, бројање, претрага, логови и извоз), акције модерације (уклони/врати, означи, подеси статус за преглед/спам/одобрење, гласови, и поновно отварање/затварање теме), забране (забрана коментисања, поништавање забране, сажеци предзабране, статус и преференције забране, и бројање забрањених корисника), и значке и повјерење (додијели/уклони значку, ручне значке, добити/поставити фактор повјерења, и унутрашњи профил корисника). Сваки метод ModerationApi прихвата параметар sso тако да се позив може извршити у име модератора аутентификованог преко SSO.

Коришћење аутентификованих API-ја (DefaultApi)

Важнo: Морате да подесите ваш 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) {
        // Направите и конфигуришите ApiClient
        ApiClient apiClient = new ApiClient();

        // ОБАВЕЗНО: Поставите ваш API кључ (добијете га са FastComments контролне табле)
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // Направите инстанцу API-ја са конфигурисаним ApiClient-ом
        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)

Јавни endpoint-и не захтијевају аутентификацију:

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

Коришћење модерацијских API-ја (ModerationApi)

ModerationApi покреће модераторску контролну таблу. Свaka метода прихвата параметар 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 позивима. Када примите догађаје, добићете овај ID назад, па ћете знати да игноришете догађај ако планирате оптимистично применити измене на клијенту (што ћете вероватно и желети јер пружа најбоље корисничко искуство). Проследите овде UUID. ID треба да буде довољно јединствен да се не појави два пута у току једне сесије прегледача.