FastComments Java SDK

Maven

Repsy deposunu projenizin POM dosyasına ekleyin:

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

Ardından ihtiyacınız olan bağımlılıkları ekleyin:

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

    <!-- Çekirdek Kütüphane (SSO içerir) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>core</artifactId>
        <version>1.3.1</version>
    </dependency>

    <!-- PubSub Kütüphanesi (canlı etkinlikler için) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>1.3.1</version>
    </dependency>
</dependencies>

Gradle

Repsy deposunu build.gradle dosyanıza ekleyin:

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

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

    // Çekirdek Kütüphane (SSO içerir)
    implementation "com.fastcomments:core:1.3.1"

    // PubSub Kütüphanesi (canlı etkinlikler için)
    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.

• API Client Library Docs
• Core Library Docs, Including SSO Examples
• PubSub Library Docs

Public vs Secured APIs

API istemcisi için iki sınıf vardır: DefaultApi ve PublicApi. DefaultApi API anahtarınızı gerektiren yöntemleri içerir ve PublicApi kimlik doğrulama olmadan doğrudan bir tarayıcı/telefon/vesaire üzerinden yapılabilecek API çağrılarını içerir.

Kimlik Doğrulamalı API'leri Kullanma (DefaultApi)

Önemli: Kimlik doğrulamalı istekler yapmadan önce ApiClient üzerinde API anahtarınızı ayarlamalısınız. Eğer yapmazsanız, istekler 401 hatası ile başarısız olur.

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 istemcisini oluşturun ve yapılandırın
        ApiClient apiClient = new ApiClient();

        // GEREKLİ: API anahtarınızı ayarlayın (bunu FastComments kontrol panelinizden alın)
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // Yapılandırılmış istemci ile API örneğini oluşturun
        DefaultApi api = new DefaultApi(apiClient);

        // Artık kimlik doğrulamalı API çağrıları yapabilirsiniz
        try {
            // Örnek: Bir SSO kullanıcısı ekleyin
            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());
            // Yaygın hatalar:
            // - 401: API anahtarı eksik veya geçersiz
            // - 400: İstek doğrulaması başarısız oldu
        }
    }
}

Public API'leri Kullanma (PublicApi)

Herkese açık uç noktalar kimlik doğrulama gerektirmez:

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

Yaygın Sorunlar

1. 401 "missing-api-key" hatası: DefaultApi örneğini oluşturmadan önce apiClient.setApiKey("YOUR_KEY") çağırdığınızdan emin olun.
2. Yanlış API sınıfı: Sunucu tarafı kimlik doğrulamalı istekler için DefaultApi'yi, istemci tarafı/genel istekler için PublicApi'yi kullanın.
3. Null API anahtarı: API anahtarı null ise SDK kimlik doğrulamasını sessizce atlayacaktır; bu da 401 hatalarına yol açar.

Broadcast Kimlikleri

Bazı API çağrılarında bir broadcastId geçirmeniz gerektiğini göreceksiniz. Olayları aldığınızda bu ID size geri dönecek, böylece istemci tarafında değişiklikleri iyimserce uygulamayı planlıyorsanız olayı görmezden geleceğinizi bilirsiniz (muhtemelen en iyi deneyimi sağladığı için bunu yapmak isteyeceksiniz). Burada bir UUID gönderin. ID, bir tarayıcı oturumunda iki kez tekrar etmeyecek kadar benzersiz olmalıdır.