FastComments Java SDK

Maven

Dodajte Repsy repozitorij v POM vaše projektne datoteke:

<repositories>
    <repository>
        <id>repsy</id>
        <name>FastComments Maven Repository on Repsy</name>
        <url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
    </repository>
</repositories>

Nato dodajte odvisnosti, ki jih potrebujete:

<dependencies>
    <!-- API Client -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>1.3.1</version>
    </dependency>

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

    <!-- PubSub Library (for live events) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>1.3.1</version>
    </dependency>
</dependencies>

Gradle

Dodajte Repsy repozitorij v vašo datoteko build.gradle:

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

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

    // Core Library (includes SSO)
    implementation "com.fastcomments:core:1.3.1"

    // PubSub Library (for live events)
    implementation "com.fastcomments:pubsub:1.3.1"
}

Vsebina knjižnice

Ta knjižnica vsebuje tri module. Generirani API odjemalec, osnovna Java knjižnica, ki vsebuje ročno napisane pripomočke za lažje delo z API-jem, in modul pubsub, ki je knjižnica za naročanje na tokove sprememb.

• Dokumentacija API odjemalca
• Dokumentacija jedrne knjižnice, vključno s primeri SSO
• Dokumentacija knjižnice PubSub

Javni in zaščiteni API-ji

Za API odjemalca obstajata dve razredi, DefaultApi in PublicApi. DefaultApi vsebuje metode, ki zahtevajo vaš API ključ, medtem ko PublicApi vsebuje klice API-ja, ki jih je mogoče izvesti neposredno iz brskalnika/na mobilni napravi/itd. brez overjanja.

Uporaba avtenticiranih API-jev (DefaultApi)

Pomembno: Pred izvajanjem avtenticiranih zahtev morate nastaviti svoj API ključ na ApiClient. Če tega ne storite, bodo zahtevki neuspešni s 401 napako.

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) {
        // Ustvarite in konfigurirajte API odjemalca
        ApiClient apiClient = new ApiClient();

        // OBVEZNO: Nastavite svoj API ključ (pridobite ga na nadzorni plošči FastComments)
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // Ustvarite instanco API-ja s konfiguriranim odjemalcem
        DefaultApi api = new DefaultApi(apiClient);

        // Zdaj lahko izvajate avtenticirane klice API-ja
        try {
            // Primer: Dodajanje SSO uporabnika
            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());
            // Pogoste napake:
            // - 401: API ključ manjka ali je neveljaven
            // - 400: Preverjanje zahtevka ni uspelo
        }
    }
}

Uporaba javnih API-jev (PublicApi)

Javne končne točke ne zahtevajo overjanja:

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

Pogoste težave

1. 401 "missing-api-key" error: Prepričajte se, da pokličete apiClient.setApiKey("YOUR_KEY") pred ustvarjanjem instance DefaultApi.
2. Napačen razred API-ja: Uporabite DefaultApi za strežniške avtenticirane zahteve, PublicApi za odjemalske/javne zahteve.
3. Null API key: SDK bo tiho preskočil avtentikacijo, če je API ključ null, kar bo povzročilo 401 napake.

ID-ji oddaj

Videli boste, da v nekaterih klicih API morate posredovati broadcastId. Ko prejmete dogodke, boste prejeli ta ID nazaj, tako boste vedeli, da lahko dogodek prezrete, če nameravate optimistično uporabiti spremembe na odjemalcu (kar boste verjetno želeli storiti, saj zagotavlja najboljšo uporabniško izkušnjo). Posredujte tukaj UUID. ID naj bo dovolj edinstven, da se v eni seji brskalnika ne pojavi dvakrat.