FastComments.com

FastComments Java SDK


Ово је званични Java SDK за FastComments.

Званични Java SDK за FastComments API

Репозиторијум

Погледајте на GitHub


Инсталација Internal Link

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 клијент
    implementation "com.fastcomments:client:0.0.2"

    // Core библиотека (укључује SSO)
    implementation "com.fastcomments:core:0.0.2"

    // PubSub библиотека (за уживо догађаје)
    implementation "com.fastcomments:pubsub:0.0.2"
}

Library Contents

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

Public vs Secured APIs

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

Брзи почетак Internal Link

Коришћење аутентификованих 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 клијента
        ApiClient apiClient = new ApiClient();

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

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

Јавни ендпоинти не захтевају аутентификацију:

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") пре креирања DefaultApi инстанце.
  2. Погрешна API класа: Користите DefaultApi за серверске аутентификоване захтеве, PublicApi за клијентске/јавне захтеве.
  3. Null API кључ: SDK ће тихо прескочити аутентификацију ако је API кључ null, што доводи до 401 грешака.

Напомене Internal Link

Идентификатори емитовања

Видећете да треба да проследите broadcastId у неким API позивима. Када примите догађаје, добићете овај ID назад, па ћете знати да игноришете догађај ако планирате оптимистично применити измене на клијенту (што ћете вероватно и желети јер пружа најбоље корисничко искуство). Проследите овде UUID. ID треба да буде довољно јединствен да се не појави два пута у току једне сесије прегледача.

Потребна помоћ?

Ако наиђете на било какве проблеме или имате питања у вези са Java SDK-ом, молимо вас:

Допринеси

Допринеси су добродошли! Посетите GitHub репозиторијум за смернице о доприносу.