SDK Java FastComments

Maven

Ajoutez le dépôt Repsy au POM de votre projet :

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

Ensuite, ajoutez les dépendances dont vous avez besoin :

<dependencies>
    <!-- Client API -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>client</artifactId>
        <version>2.0.0</version>
    </dependency>
    
    <!-- Bibliothèque Core (inclut SSO) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>core</artifactId>
        <version>2.0.0</version>
    </dependency>
    
    <!-- Bibliothèque PubSub (pour les événements en direct) -->
    <dependency>
        <groupId>com.fastcomments</groupId>
        <artifactId>pubsub</artifactId>
        <version>2.0.0</version>
    </dependency>
</dependencies>

Gradle

Ajoutez le dépôt Repsy à votre fichier build.gradle :

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

dependencies {
    // Client API
    implementation "com.fastcomments:client:2.0.0"
    
    // Bibliothèque Core (inclut SSO)
    implementation "com.fastcomments:core:2.0.0"
    
    // Bibliothèque PubSub (pour les événements en direct)
    implementation "com.fastcomments:pubsub:2.0.0"
}

Library Contents

Cette bibliothèque contient trois modules. Le client API généré, la bibliothèque Java core qui contient des utilitaires écrits à la main pour faciliter le travail avec l'API, et le module pubsub qui est une bibliothèque pour s'abonner aux flux de modifications.

• Documentation de la bibliothèque Client API
• Documentation de la bibliothèque Core, incluant des exemples SSO
• Documentation de la bibliothèque PubSub

Public vs Secured APIs

Pour le client API, il y a trois classes, DefaultApi, PublicApi, et ModerationApi. DefaultApi contient des méthodes qui nécessitent votre clé API, et PublicApi contient des méthodes qui peuvent être appelées directement depuis un navigateur/appareil mobile/etc. sans authentification.

La ModerationApi alimente le tableau de bord des modérateurs. Elle contient des méthodes pour la modération des commentaires (liste, comptage, recherche, journaux et export), les actions de modération (supprimer/restaurer, signaler, définir l'état de révision/spam/approbation, votes, et réouverture/fermeture de fil), les bannissements (bannir d'un commentaire, annuler une interdiction, résumés pré-bannissement, statut et préférences de bannissement, et compte des utilisateurs bannis), et les badges et la confiance (attribuer/retirer un badge, badges manuels, obtenir/définir le facteur de confiance, et profil interne de l'utilisateur). Chaque méthode de ModerationApi accepte un paramètre sso afin que l'appel puisse être effectué au nom d'un modérateur authentifié via SSO.

Utilisation des API authentifiées (DefaultApi)

Important : Vous devez définir votre clé API sur ApiClient avant d'effectuer des requêtes authentifiées. Si vous ne le faites pas, les requêtes échoueront avec une erreur 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) {
        // Créez et configurez le client API
        ApiClient apiClient = new ApiClient();

        // OBLIGATOIRE : Définissez votre clé API (obtenez-la depuis votre tableau de bord FastComments)
        apiClient.setApiKey("YOUR_API_KEY_HERE");

        // Créez l'instance API avec le client configuré
        DefaultApi api = new DefaultApi(apiClient);

        // Vous pouvez maintenant effectuer des appels API authentifiés
        try {
            // Exemple : Ajouter un utilisateur 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());
            // Erreurs courantes :
            // - 401 : la clé API est manquante ou invalide
            // - 400 : la validation de la requête a échoué
        }
    }
}

Utilisation des API publiques (PublicApi)

Les points de terminaison publics ne nécessitent pas d'authentification :

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

Utilisation des API de modération (ModerationApi)

L'API ModerationApi alimente le tableau de bord des modérateurs. Chaque méthode accepte un paramètre sso identifiant le modérateur authentifié via SSO au nom duquel la requête est effectuée :

import com.fastcomments.api.ModerationApi;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.model.*;

ModerationApi moderationApi = new ModerationApi();

try {
    // Lister les commentaires en attente de modération
    ModerationAPIGetCommentsResponse response = moderationApi.getApiComments()
        .sso("YOUR_SSO_TOKEN")
        .execute();
    System.out.println(response);
} catch (ApiException e) {
    e.printStackTrace();
}

Problèmes courants

1. Erreur 401 "missing-api-key" : Assurez-vous d'appeler apiClient.setApiKey("YOUR_KEY") avant de créer l'instance DefaultApi.
2. Classe API incorrecte : Utilisez DefaultApi pour les requêtes authentifiées côté serveur, PublicApi pour les requêtes côté client/publiques.
3. Clé API nulle : Le SDK ignorera silencieusement l'authentification si la clé API est nulle, ce qui entraînera des erreurs 401.

Identifiants de diffusion

Vous verrez que vous devrez fournir un broadcastId dans certaines requêtes d'API. Lorsque vous recevez des événements, vous recevrez cet ID en retour, ainsi vous saurez ignorer l'événement si vous prévoyez d'appliquer des changements de manière optimiste sur le client (ce que vous voudrez probablement faire puisqu'il offre la meilleure expérience). Fournissez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une session de navigateur.