Utilisation des ressources

Il convient de noter que la récupération de données depuis l'API est comptabilisée comme utilisation sur votre compte.

Chaque ressource indiquera quelle est cette utilisation dans sa propre section.

Certaines ressources coûtent plus cher à servir que d'autres. Chaque endpoint a un coût fixe de crédits par appel API. Pour certains endpoints, le nombre de crédits varie en fonction des options et des tailles de réponse.

L'utilisation de l'API peut être vérifiée sur la page Analytique de Facturation et est mise à jour toutes les quelques minutes.

Note !

Nous suggérons de lire d'abord la documentation des Pages, pour aider à limiter la confusion lors de la détermination des valeurs à passer pour urlId dans l'API Comment.

Cette API agrège des documents en les regroupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont supportées.

Le coût est variable. Chaque 500 objets analysés coûte 1 crédit API.

L'utilisation maximale de mémoire autorisée par appel API par défaut est de 64 Mo, et par défaut vous ne pouvez avoir qu'une agrégation en cours à la fois. Si vous soumettez plusieurs agrégations simultanément, elles seront mises en file d'attente et exécutées dans l'ordre de soumission. Les agrégations en attente attendront un maximum de 60 secondes, après quoi la requête expirera. Les agrégations individuelles peuvent s'exécuter jusqu'à 5 minutes.

Si vous avez des locataires gérés, vous pouvez agréger toutes les ressources des locataires enfants en un seul appel en passant le paramètre de requête parentTenantId.

Exemples

Exemple : Compter les valeurs uniques

Exemple cURL de Comptage de Valeurs Uniques

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "distinct", "field": "urlId", "alias": "urlId" },

6 { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }

7 ]

8}'

9

Réponse de Comptage de Valeurs Uniques

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "commenterEmail": {

7 "distinctCounts": {

8 "someone@somewhere.com": 1,

9 "someone2@somewhere.com": 1

10 }

11 }

12 },

13 {

14 "urlId": {

15 "distinctCounts": {

16 "some-page": 2

17 }

18 }

19 }

20 ],

21 "stats": { "scanned": 2 }

22}

23

Exemple : Compter les valeurs distinctes

Exemple cURL de Comptage de Valeurs Distinctes

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "countDistinct", "field": "urlId", "alias": "urlId" },

6 { "op": "countDistinct", "field": "commenterEmail", "alias": "commenterEmail" }

7 ]

8}'

9

Réponse :

Réponse de Comptage de Valeurs Distinctes

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "commenterEmail": { "distinctCount": 2 },

7 "urlId": { "distinctCount": 1 }

8 }

9 ],

10 "stats": { "scanned": 2 }

11}

12

Exemple : Somme des valeurs de plusieurs champs

Exemple cURL de Somme de Valeurs

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "sum", "field": "votes", "alias": "votes" },

6 { "op": "sum", "field": "votesUp", "alias": "votesUp" }

7 ]

8}'

9

Réponse :

Réponse de Somme de Valeurs

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "votes": { "numericValue": 2 },

7 "votesUp": { "numericValue": 2 }

8 }

9 ],

10 "stats": { "scanned": 2 }

11}

12

Exemple : Moyenne des valeurs de plusieurs champs

Exemple cURL de Moyenne de Valeurs

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "avg", "field": "votes", "alias": "votes" },

6 { "op": "avg", "field": "votesUp", "alias": "votesUp" }

7 ]

8}'

9

Réponse :

Réponse de Moyenne de Valeurs

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "votes": { "numericValue": 1 },

7 "votesUp": { "numericValue": 1 }

8 }

9 ],

10 "stats": { "scanned": 2 }

11}

12

Exemple : Valeurs Min/Max de plusieurs champs

Exemple cURL de Valeurs Min/Max

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "min", "field": "votes", "alias": "votes" },

6 { "op": "min", "field": "votesUp", "alias": "votesUp" },

7 { "op": "max", "field": "votes", "alias": "votes" },

8 { "op": "max", "field": "votesUp", "alias": "votesUp" }

9 ]

10}'

11

Réponse :

Réponse de Valeurs Min/Max

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "votes": { "numericValue": 0 },

7 "votesUp": { "numericValue": 0 },

8 "votes": { "numericValue": 2 },

9 "votesUp": { "numericValue": 2 }

10 }

11 ],

12 "stats": { "scanned": 2 }

13}

14

Exemple : Compter les valeurs uniques de plusieurs champs

Exemple cURL de Comptage de Valeurs Uniques

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "distinct", "field": "urlId", "alias": "urlId" },

6 { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }

7 ]

8}'

9

Réponse :

Réponse de Comptage de Valeurs Uniques

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "commenterEmail": {

7 "distinctCounts": {

8 "someone@somewhere.com": 1,

9 "someone2@somewhere.com": 1

10 }

11 },

12 "urlId": {

13 "distinctCounts": {

14 "some-page": 2

15 }

16 }

17 }

18 ],

19 "stats": { "scanned": 2 }

20}

21

Exemple : Création de requête

Exemple cURL de Création de Requête

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "groupBy": ["commenterName"],

5 "query": [

6 { "key": "approved", "value": true, "operator": "eq" },

7 { "key": "commenterName", "value": "some-username-2", "operator": "eq" }

8 ],

9 "operations": [

10 { "op": "sum", "field": "votes", "alias": "votes" }

11 ]

12}'

13

Réponse :

Réponse de Création de Requête

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "groups": { "commenterName": "some-username-2" },

7 "votes": { "numericValue": 2 }

8 }

9 ],

10 "stats": { "scanned": 1 }

11}

12

Exemple : Compter les commentaires en attente de révision

Exemple cURL de Comptage de Commentaires en Attente de Révision

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "query": [

5 { "key": "reviewed", "value": true, "operator": "not_eq" }

6 ],

7 "operations": [

8 { "op": "count", "field": "id", "alias": "count" }

9 ]

10}'

11

Réponse :

Réponse de Comptage de Commentaires en Attente de Révision

Copy

1

2{

3 "status": "success",

4 "data": [

5 { "count": { "numericValue": 2 } }

6 ],

7 "stats": { "scanned": 2 }

8}

9

Exemple : Répartition des commentaires approuvés, révisés et spam

Exemple cURL de Répartition des Commentaires

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "distinct", "field": "approved", "alias": "approved" },

6 { "op": "distinct", "field": "reviewed", "alias": "reviewed" },

7 { "op": "distinct", "field": "isSpam", "alias": "isSpam" }

8 ]

9}'

10

Réponse :

Réponse de Répartition des Commentaires

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "approved": { "distinctCounts": { "true": 2 } },

7 "reviewed": { "distinctCounts": { "false": 2 } },

8 "isSpam": { "distinctCounts": { "false": 2 } }

9 }

10 ],

11 "stats": { "scanned": 2 }

12}

13

Structures

Structure de Requête d'Agrégation

Copy

1

2export type AggregationOpType = 'sum' | 'countDistinct' | 'distinct' | 'avg' | 'min' | 'max' | 'count';

3

4/** An operation that will be applied on a field */

5export interface AggregationOperation {

6 /** The field to operate on */

7 field: string;

8 /** The type of operation */

9 op: AggregationOpType;

10 /** Optional alias for the output; if not provided, a default alias is computed */

11 alias?: string;

12 expandArray?: boolean;

13}

14

15export interface QueryPredicate {

16 key: string

17 value: string | number | boolean

18 operator: 'eq' | 'not_eq' | 'greater_than' | 'less_than' | 'contains'

19}

20

21export interface AggregationRequest {

22 query?: QueryPredicate[];

23 resourceName: string;

24 groupBy?: string[];

25 operations: AggregationOperation[];

26 sort?: {

27 field: string;

28 dir: 'asc' | 'desc';

29 };

30}

31

32type DistinctAccumulator = Record<string, number>;

33type GroupValues = Record<string, string>;

34

35export type AggregationValue = {

36 distinctCounts?: DistinctAccumulator

37 distinctCount?: number

38 numericValue?: number

39 stringValue?: string

40 groups?: GroupValues

41};

42

Structure de Réponse d'Agrégation

Copy

1

2export type AggregationItem = Record<string, AggregationValue> & { groups?: GroupValues };

3

4export interface AggregationResponse {

5 status: APIStatus,

6 data: AggregationItem[];

7 stats?: {

8 scanned: number;

9 timeMS: number;

10 };

11}

12

Les ressources suivantes peuvent être agrégées :

• AffiliateEvent
• AnonymousVote
• BannedUser
• BatchJob
• BlockedUser
• Comment
• CommentDeleted
• CommentIdToSyncOutbound
• CommentScheduled
• CommentSyncLog
• CustomConfig
• CustomEmailTemplateRenderError
• EmailToSend
• EventLogEntry
• ImportedCommentScheduled
• ModerationGroup
• Moderator
• Page
• PageReact
• PendingVote
• QuestionResult
• SSOUser
• SentEmail
• SpamEvent
• Tenant
• TenantAuditLog
• TenantBadge
• TenantDailyUsage
• TenantInvoiceHistory
• TenantPackage
• User
• UserBadge
• UserBadgeProgress
• UserNotification
• UserSubscription
• UserUsage
• Vote

Cette API utilise la pagination, fournie par les paramètres skip, before et after. Les AuditLogs sont retournés par pages de 1000, triés par when et id.

La récupération de chaque 1000 logs a un coût en crédits de 10.

Par défaut, vous recevrez une liste avec les éléments les plus récents en premier. De cette façon, vous pouvez interroger en commençant par skip=0, en paginant jusqu'à trouver le dernier enregistrement que vous avez consommé.

Alternativement, vous pouvez trier du plus ancien au plus récent, et paginer jusqu'à ce qu'il n'y ait plus d'enregistrements.

Le tri peut être effectué en définissant order sur ASC ou DESC. La valeur par défaut est ASC.

L'interrogation par date est possible via before et after en tant que timestamps avec millisecondes. before et after ne sont PAS inclusifs.

Exemple cURL AuditLog

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/audit-logs?tenantId=demo&API_KEY=DEMO_API_SECRET&skip=0&order=ASC&before=123&after=456'

4

Structure de Requête AuditLog

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 order?: 'ASC' | 'DESC'

6 skip?: number

7 before?: number

8 after?: number

9}

10

Structure de Réponse AuditLog

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'

6 /** Included on failure. **/

7 reason?: string

8 /** The logs! **/

9 auditLogs: AuditLog[]

10}

11

Cette API est utilisée pour obtenir des commentaires à afficher à un utilisateur. Par exemple, elle filtre automatiquement les commentaires non approuvés ou spam.

Pagination

La pagination peut être effectuée de deux manières, selon les exigences de performance et le cas d'utilisation :

1. Le plus rapide : Pagination Précalculée :
   1. C'est ainsi que FastComments fonctionne lorsque vous utilisez nos widgets et clients préconçus.
   2. Cliquer sur "suivant" augmente simplement le nombre de pages.
   3. Vous pouvez penser à cela comme étant récupéré par un magasin clé-valeur.
   4. De cette façon, définissez simplement un paramètre page commençant à 0 et une direction de tri comme direction.
   5. Les tailles de page peuvent être personnalisées via les règles de personnalisation.
2. Le plus flexible : Pagination Flexible :
   1. De cette façon, vous pouvez définir des paramètres limit et skip personnalisés. Ne passez pas page.
   2. La direction de tri est également supportée.
   3. limit est le total à retourner après que skip soit appliqué.
      • Exemple : définir skip = 200, limit = 100 quand taille de page = 100 et page = 2.
   4. Les commentaires enfants comptent toujours dans la pagination. Vous pouvez contourner cela en utilisant l'option asTree.
      • Vous pouvez paginer les enfants via limitChildren et skipChildren.
      • Vous pouvez limiter la profondeur des fils retournés via maxTreeDepth.

Fils de discussion

1. Lors de l'utilisation de la Pagination Précalculée, les commentaires sont regroupés par page et les commentaires dans les fils affectent la page globale.
   1. De cette façon, les fils peuvent être déterminés côté client basé sur parentId.
   2. Par exemple, avec une page avec un commentaire de premier niveau, et 29 réponses, et en définissant page=0 dans l'API - vous obtiendrez juste le commentaire de premier niveau et les 29 enfants.
   3. Image d'exemple ici illustrant plusieurs pages.
2. Lors de l'utilisation de la Pagination Flexible, vous pouvez définir un paramètre parentId.
   1. Définissez-le à null pour obtenir uniquement les commentaires de premier niveau.
   2. Ensuite pour voir les fils, appelez à nouveau l'API et passez parentId.
   3. Une solution commune est de faire un appel API pour les commentaires de premier niveau puis de faire des appels API parallèles pour obtenir les commentaires pour les enfants de chaque commentaire.
3. NOUVEAU Depuis Fév 2023! Récupérer sous forme d'arbre en utilisant &asTree=true.
   1. Vous pouvez penser à cela comme Pagination Flexible sous forme d'Arbre.
   2. Seuls les commentaires de premier niveau comptent dans la pagination.
   3. Définissez parentId=null pour démarrer l'arbre à la racine (vous devez définir parentId).
   4. Définissez skip et limit pour la pagination.
   5. Définissez asTree à true.
   6. Le coût en crédits augmente de 2x, car notre backend doit faire beaucoup plus de travail dans ce scénario.
   7. Définissez maxTreeDepth, limitChildren, et skipChildren selon vos besoins.

Les Arbres Expliqués

Lors de l'utilisation de asTree, il peut être difficile de raisonner sur la pagination. Voici un graphique pratique :

Diagramme de Pagination en Arbre

Récupérer des Commentaires dans le Contexte d'un Utilisateur

L'API /comments peut être utilisée dans deux contextes, pour différents cas d'utilisation :

• Pour retourner des commentaires triés et tagués avec des informations pour construire votre propre client.
  • Dans ce cas, définissez un paramètre de requête contextUserId.
• Pour récupérer des commentaires depuis votre backend pour des intégrations personnalisées.
  • La plateforme utilisera par défaut ceci sans contextUserId.

Commentaires avec Pagination Précalculée

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&page=0&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR'

4

Commentaires avec Pagination Flexible

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10'

4

Commentaires avec Pagination Flexible dans le Contexte Utilisateur

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id'

4

Commentaires avec Pagination Flexible dans le Contexte Utilisateur pour les Commentaires de Premier Niveau Uniquement

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null'

4

Obtenir des Commentaires sous forme d'Arbre

Il est possible d'obtenir les commentaires retournés sous forme d'arbre, avec la pagination ne comptant que les commentaires de premier niveau.

Commentaires sous forme d'Arbre dans le Contexte Utilisateur

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null&asTree=true'

4

Vous voulez obtenir uniquement les commentaires de premier niveau et les enfants immédiats ? Voici une façon :

Commentaires sous forme d'Arbre avec Profondeur Maximale

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&urlId=test&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null&asTree=true&maxTreeDepth=1&limitChildren=10'

4

Cependant, dans votre interface vous pourriez avoir besoin de savoir s'il faut afficher un bouton "afficher les réponses" sur chaque commentaire. Lors de la récupération des commentaires via un arbre, il y a une propriété hasChildren taguée sur les commentaires lorsque applicable.

Obtenir des Commentaires sous forme d'Arbre, en Recherchant par Hash Tag

Il est possible de rechercher par hashtag en utilisant l'API, à travers tout votre locataire (pas limité à une page, ou urlId).

Dans cet exemple, nous omettons urlId, et nous recherchons par plusieurs hashtags. L'API ne retournera que les commentaires qui ont tous les hashtags demandés.

Commentaires sous forme d'Arbre dans le Contexte Utilisateur, par Hash Tag

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&direction=MR&skip=20&limit=10&contextUserId=my-user-id&parentId=null&asTree=true&hashTag=TestTag&hashTag=OtherTestTag'

4

Tous les Paramètres de Requête

Structure de Requête des Commentaires

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The urlId (page url, or article id) the comments are associated with. **/

6 urlId?: string

7 /** Limit the comments returned by this user. **/

8 userId?: string

9 /** Use this to search by hashtag. To drill down to the intersection of multiple hashtags, do &hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** The sort direction. Default is MR (Most Relevant). Other options are OF (Oldest First) and NF (Newest First). **/

12 direction?: 'MR' | 'OF' | 'NF'

13 /** Precalculated Pagination: The page to fetch, starting with 0. Pass -1 for all comments (up to 250). **/

14 page?: number

15 /** Flexible Pagination: How many comments should we return? **/

16 limit?: number

17 /** Flexible Pagination: How many child comments should we return for each parent? **/

18 limitChildren?: number

19 /** Flexible Pagination: How many comments should we skip? **/

20 skip?: number

21 /** Flexible Pagination: How many child comments should we skip for each parent? **/

22 skipChildren?: number

23 /** For determining blocked and flagged comments. **/

24 contextUserId?: string

25 /** For determining blocked and flagged comments. **/

26 anonUserId?: string

27 /** For fetching child comments. **/

28 parentId?: string

29 /** For fetching as a tree. **/

30 asTree?: boolean

31 /** How far into the tree should we return data? 0 returns no children. 1 returns immediate children, etc. **/

32 maxTreeDepth?: number

33}

34

La Réponse

Structure de Réponse des Commentaires

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-date' | 'unauthorized-page' | 'invalid-pagination-request' | 'invalid-limit' | 'invalid-limit-children' | 'invalid-skip' | 'invalid-skip-children' | 'invalid-max-tree-depth'

6 /** Included on failure. **/

7 reason?: string

8 /** The comments! **/

9 comments: Comment[]

10}

11

Conseils Utiles

URL ID

Vous voudrez probablement utiliser l'API Comment avec le paramètre urlId. Vous pouvez appeler l'API Pages d'abord, pour voir à quoi ressemblent les valeurs urlId disponibles pour vous.

Actions Anonymes

Pour les commentaires anonymes, vous voudrez probablement passer anonUserId lors de la récupération des commentaires, et lors du signalement et du blocage.

(!) Ceci est requis pour de nombreux magasins d'applications car les utilisateurs doivent pouvoir signaler le contenu créé par les utilisateurs qu'ils peuvent voir, même s'ils ne sont pas connectés. Ne pas le faire peut causer le retrait de votre application dudit magasin.

Commentaires Non Retournés

Vérifiez que vos commentaires sont approuvés, et ne sont pas spam.

Cette API fournit la capacité de récupérer un commentaire unique par id.

Exemple cURL de Récupération de Commentaire par Id

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/comments/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de Récupération de Commentaire par Id

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Récupération de Commentaire par Id

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'missing-id'

6 /** Included on failure. **/

7 reason?: string

8 /** The comment! **/

9 comment?: Comment

10}

11

Ce endpoint API fournit la capacité de créer des commentaires.

Les cas d'utilisation courants sont les interfaces personnalisées, les intégrations ou les importations.

Notes :

• Cette API peut mettre à jour le widget de commentaires "en direct" si désiré (cela augmente le creditsCost de 1 à 2).
• Cette API créera automatiquement des objets utilisateur dans notre système si un email est fourni.
• Essayer d'enregistrer deux commentaires avec des emails différents, mais le même nom d'utilisateur, entraînera une erreur pour le deuxième commentaire.
• Si vous spécifiez parentId, et qu'un commentaire enfant a notificationSentForParent à false, nous enverrons des notifications pour le commentaire parent. Cela se fait toutes les heures (nous regroupons les notifications pour diminuer le nombre d'emails envoyés).
• Si vous voulez envoyer des emails de bienvenue lors de la création d'utilisateurs, ou des emails de vérification de commentaires, définissez sendEmails à true dans les paramètres de requête.
• Les commentaires créés via cette API apparaîtront dans les pages Analytique et Modération de l'application admin.
• Les "mauvais mots" sont toujours masqués dans les noms des commentateurs et le texte des commentaires si le paramètre est activé.
• Les commentaires créés via cette API peuvent toujours être vérifiés pour le spam si désiré.
• Les configurations telles que la longueur maximale des commentaires, si configurées via la page d'administration des règles de personnalisation, s'appliqueront ici.

Les données minimales requises pour soumettre qui s'afficheront dans le widget de commentaires sont les suivantes :

Exemple cURL Minimum de POST de Commentaire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "approved": true,

7 "comment": "some-comment",

8 "commenterName": "some-commenter-name",

9 "date": 1622644382148,

10 "urlId": "some-place",

11 "url": "https://exmaple.com/some-page",

12 "verified": true

13}'

14

Une requête plus réaliste pourrait ressembler à :

Exemple cURL de POST de Commentaire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true&doSpamCheck=true' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "approved": true,

7 "avatarSrc": "https://static.fastcomments.com/1605337537848-DSC_0841.JPG",

8 "comment": "some-comment",

9 "commenterName": "some-commenter-name",

10 "commenterEmail": "fordperfect@spaceship.com",

11 "date": 1622644382148,

12 "isSpam": false,

13 "locale": "en_us",

14 "notificationSentForParent": true,

15 "notificationSentForParentTenant": true,

16 "reviewed": true,

17 "urlId": "some-place",

18 "url": "https://exmaple.com/some-page",

19 "verified": true,

20 "votes": 1,

21 "votesUp": 2,

22 "votesDown": 1,

23 "ip": "123.456.789.000"

24}'

25

Structure de Requête POST de Commentaire

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** Whether the comment should appear "live" to users viewing instances of the comment widget with the same urlId. NOTE: Doubles credit cost from 1 to 2. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

Structure de Réponse POST de Commentaire

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-comment' | 'comment-too-big' | 'hash-tags-readonly' | 'mentions-readonly' | 'invalid-user' | 'unauthorized' | 'invalid-date' | 'invalid-name' | 'invalid-name-is-email' | 'banned' | 'invalid-email';

7 /** Included on failure. **/

8 reason?: string

9 /** The created comment. **/

10 comment?: Comment

11 /** The associated user, which may or may not have already existed. **/

12 user?: User

13}

14

Ce endpoint API fournit la capacité de mettre à jour un commentaire unique.

Notes :

• Cette API peut mettre à jour le widget de commentaires "en direct" si désiré (cela augmente le creditsCost de base de 1 à 2).
  • Cela peut rendre la migration des commentaires entre les pages "en direct" (changement de urlId).
  • Les migrations coûtent 2 crédits supplémentaires car les pages sont précalculées et cela est intensif en CPU.
• Contrairement à l'API de création, cette API ne créera PAS automatiquement des objets utilisateur dans notre système si un email est fourni.
• Les commentaires mis à jour via cette API peuvent toujours être vérifiés pour le spam si désiré.
• Les configurations telles que la longueur maximale des commentaires, si configurées via la page d'administration des règles de personnalisation, s'appliqueront ici.
• Pour permettre aux utilisateurs de mettre à jour leur texte de commentaire, vous pouvez simplement spécifier comment dans le corps de la requête. Nous générerons le commentHTML résultant.
  • Si vous définissez à la fois comment et commentHTML, nous ne générerons pas automatiquement le HTML.
  • Si l'utilisateur ajoute des mentions ou des hashtags dans son nouveau texte, il sera toujours traité comme l'API POST.
• Lors de la mise à jour de commenterEmail sur un commentaire, il est préférable de spécifier également userId. Sinon, vous devez vous assurer que l'utilisateur avec cet email appartient à votre locataire, sinon la requête échouera.

Exemple cURL Minimum de PATCH de Commentaire

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "comment": "some-new-comment-text"

7}'

8

Structure de Requête PATCH de Commentaire

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The user doing the update. If desired can be used to check that they can edit the comment. **/

6 contextUserId?: string

7 /** Should we check if the new comment looks like spam? **/

8 doSpamCheck?: 'true' | 'false'

9 /** Whether the comment should appear "live" to users viewing instances of the comment widget with the same urlId. NOTE: Doubles credit cost from 1 to 2. **/

10 isLive?: 'true' | 'false'

11}

12

Structure de Réponse PATCH de Commentaire

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-comment' | 'comment-too-big' | 'hash-tags-readonly' | 'mentions-readonly' | 'invalid-user' | 'unauthorized' | 'invalid-date' | 'invalid-name' | 'invalid-name-is-email' | 'banned' | 'invalid-email' | 'invalid-input' | 'missing-id' | 'not-found'

7 /** Included on failure. **/

8 reason?: string

9}

10

Ce endpoint API fournit la capacité de supprimer un commentaire.

Notes :

• Cette API peut mettre à jour le widget de commentaires "en direct" si désiré (cela augmente le creditsCost de 1 à 2).
• Cette API supprimera tous les commentaires enfants.

Exemple cURL de DELETE de Commentaire

Copy

1

2curl --request DELETE \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json'

5

Structure de Requête DELETE de Commentaire

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The user doing the update. If desired can be used to check that they can delete the comment. **/

6 contextUserId?: string

7 /** Whether the comment should be deleted "live" to users viewing instances of the comment widget with the same urlId. NOTE: Doubles credit cost from 1 to 2. **/

8 isLive?: 'true' | 'false'

9}

10

Structure de Réponse DELETE de Commentaire

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'

7 /** Included on failure. **/

8 reason?: string

9}

10

Ce endpoint API fournit la capacité de signaler un commentaire pour un utilisateur spécifique.

Notes :

• Cet appel doit toujours être effectué dans le contexte d'un utilisateur. L'utilisateur peut être un utilisateur FastComments.com, un utilisateur SSO ou un utilisateur de locataire.
• Si un seuil de signalement pour masquer est défini, le commentaire sera automatiquement masqué en direct après avoir été signalé le nombre de fois défini.
• Après qu'il soit automatiquement désapprouvé (masqué) - le commentaire ne peut être réapprouvé que par un administrateur ou un modérateur. Annuler le signalement ne réapprouvera pas le commentaire.

Exemple cURL de Signalement de Commentaire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \

4 --header 'Content-Type: application/json'

5

Pour le signalement anonyme, nous devons spécifier un anonUserId. Cela peut être un ID qui représente la session anonyme, ou un UUID aléatoire. Cela nous permet de prendre en charge le signalement et l'annulation du signalement des commentaires même si un utilisateur n'est pas connecté. De cette façon, le commentaire peut être marqué comme signalé lorsque les commentaires sont récupérés avec le même anonUserId.

Exemple cURL de Signalement de Commentaire Anonyme

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

Structure de Requête de Signalement de Commentaire

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Structure de Réponse de Signalement de Commentaire

Copy

1

2

3interface CommentFlagResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'

7 /** Included on failure. **/

8 reason?: string

9 /** Was the comment un-approved (hidden) due to being flagged too many times? **/

10 wasUnapproved?: boolean;

11}

12

Ce endpoint API fournit la capacité d'annuler le signalement d'un commentaire pour un utilisateur spécifique.

Notes :

• Cet appel doit toujours être effectué dans le contexte d'un utilisateur. L'utilisateur peut être un utilisateur FastComments.com, un utilisateur SSO ou un utilisateur de locataire.
• Après qu'un commentaire soit automatiquement désapprouvé (masqué) - le commentaire ne peut être réapprouvé que par un administrateur ou un modérateur. Annuler le signalement ne réapprouvera pas le commentaire.

Exemple cURL d'Annulation de Signalement de Commentaire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \

4 --header 'Content-Type: application/json'

5

Pour le signalement anonyme, nous devons spécifier un anonUserId. Cela peut être un ID qui représente la session anonyme, ou un UUID aléatoire.

Exemple cURL de Signalement Anonyme de Commentaire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

Structure de Requête d'Annulation de Signalement de Commentaire

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Structure de Réponse d'Annulation de Signalement de Commentaire

Copy

1

2

3interface CommentUnFlagResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'

7 /** Included on failure. **/

8 reason?: string

9}

10

Ce endpoint API fournit la capacité de bloquer un utilisateur qui a écrit un commentaire donné. Il prend en charge le blocage des commentaires écrits par les utilisateurs FastComments.com, les utilisateurs SSO et les utilisateurs de locataire.

Il prend en charge un paramètre de corps commentIdsToCheck pour vérifier si d'autres commentaires potentiellement visibles sur le client doivent être bloqués/débloqués après cette action.

Notes :

• Cet appel doit toujours être effectué dans le contexte d'un utilisateur. L'utilisateur peut être un utilisateur FastComments.com, un utilisateur SSO ou un utilisateur de locataire.
• Le userId dans la requête est l'utilisateur qui effectue le blocage. Par exemple : Utilisateur A veut bloquer Utilisateur B. Passez userId=Utilisateur A et l'id du commentaire que Utilisateur B a écrit.
• Les commentaires complètement anonymes (pas d'id utilisateur, pas d'email) ne peuvent pas être bloqués et une erreur sera retournée.

Exemple cURL de Blocage de Commentaire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/block?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \

4 --header 'Content-Type: application/json'

5

Pour le blocage anonyme, nous devons spécifier un anonUserId. Cela peut être un ID qui représente la session anonyme, ou un UUID aléatoire. Cela nous permet de prendre en charge le blocage des commentaires même si un utilisateur n'est pas connecté en récupérant les commentaires avec le même anonUserId.

Exemple cURL de Blocage de Commentaire Anonyme

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

Structure de Requête de Blocage de Commentaire

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Structure de Réponse de Blocage de Commentaire

Copy

1

2

3interface CommentBlockResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'

7 /** Included on failure. **/

8 reason?: string

9 /** If commentIdsToCheck is defined, entries in this map with true are also blocked. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Ce endpoint API fournit la capacité de débloquer un utilisateur qui a écrit un commentaire donné. Il prend en charge le déblocage des commentaires écrits par les utilisateurs FastComments.com, les utilisateurs SSO et les utilisateurs de locataire.

Il prend en charge un paramètre de corps commentIdsToCheck pour vérifier si d'autres commentaires potentiellement visibles sur le client doivent être bloqués/débloqués après cette action.

Notes :

• Cet appel doit toujours être effectué dans le contexte d'un utilisateur. L'utilisateur peut être un utilisateur FastComments.com, un utilisateur SSO ou un utilisateur de locataire.
• Le userId dans la requête est l'utilisateur qui effectue le déblocage. Par exemple : Utilisateur A veut débloquer Utilisateur B. Passez userId=Utilisateur A et l'id du commentaire que Utilisateur B a écrit.
• Les commentaires complètement anonymes (pas d'id utilisateur, pas d'email) ne peuvent pas être bloqués et une erreur sera retournée.

Exemple cURL de Déblocage de Commentaire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \

4 --header 'Content-Type: application/json'

5

Exemple cURL de Déblocage de Commentaire Anonyme

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

Structure de Requête de Déblocage de Commentaire

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Structure de Réponse de Déblocage de Commentaire

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'

7 /** Included on failure. **/

8 reason?: string

9 /** If commentIdsToCheck is defined, entries in this map with true are still blocked. If false, you might want to un-hide the comments from the user so they don't have to refresh. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Les EmailTemplates individuels peuvent être récupérés par leur id correspondant (PAS emailTemplateId).

Exemple cURL de EmailTemplate par ID

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de EmailTemplate par ID

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de EmailTemplate par ID

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'

6 /** Included on failure. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

Cette API utilise la pagination, fournie par le paramètre de requête page. Les EmailTemplates sont retournés par pages de 100, triés par createdAt puis id.

Exemple cURL de EmailTemplate

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de EmailTemplate

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The page to fetch, starting with 0. **/

6 page: number

7}

8

Structure de Réponse de EmailTemplate

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'

6 /** Included on failure. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

Ce endpoint API fournit la capacité de mettre à jour un modèle d'email en ne spécifiant que l'id et les attributs à mettre à jour.

Notez que toutes les mêmes validations pour créer un modèle s'appliquent également, par exemple :

• Le modèle doit se rendre. Ceci est vérifié à chaque mise à jour.
• Vous ne pouvez pas avoir de modèles en double pour le même domaine (sinon l'un serait silencieusement ignoré).

Exemple cURL de PATCH de EmailTemplate

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "displayName": "Some New Name",

7}'

8

Structure de Requête PATCH de EmailTemplate

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse PATCH de EmailTemplate

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'not-found' | 'unexpected-param' | 'invalid-email-template-id' | 'unauthorized' | 'domain-invalid' | 'duplicate' | 'does-not-render';

7 /** Included on failure. **/

8 reason?: string

9 /** The updated email template. **/

10 emailTemplate?: EmailTemplate

11}

12

Ce endpoint API fournit la capacité de créer des modèles d'email.

Notes :

• Vous ne pouvez pas avoir plusieurs modèles avec le même emailTemplateId avec le même domaine.
• Mais vous pouvez avoir un modèle générique (domain = *) et un modèle spécifique au domaine pour le même emailTemplateId.
• Spécifier domain n'est pertinent que si vous avez différents domaines, ou souhaitez utiliser des modèles spécifiques pour les tests (domain défini sur localhost etc).
• Si vous spécifiez domain, il doit correspondre à un DomainConfig. En cas d'erreur, une liste de domaines valides est fournie.
• La syntaxe du modèle est EJS et est rendue avec un timeout de 500ms. Le P99 pour le rendu est <5ms, donc si vous atteignez 500ms, quelque chose ne va pas.
• Votre modèle doit se rendre avec vos testData fournies pour être enregistré. Les erreurs de rendu sont agrégées et rapportées dans le tableau de bord (bientôt disponible via l'API).

Les données minimales requises pour ajouter un modèle sont les suivantes :

Exemple cURL Minimum de POST de EmailTemplate

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."

9}'

10

Vous voudrez peut-être avoir des modèles par site, auquel cas vous définissez domain :

Exemple cURL de POST de EmailTemplate

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is some email content!",

9 "domain": "somespecificsite.com",

10}'

11

Structure de Requête POST de EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse POST de EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'invalid-email-template-id' | 'domain-invalid' | 'duplicate' | 'does-not-render';

7 /** Included on failure. **/

8 reason?: string

9 /** The created template. **/

10 emailTemplate?: EmailTemplate

11}

12

Ce endpoint API fournit la capacité de prévisualiser des modèles d'email.

Exemple cURL Minimum de Prévisualisation de EmailTemplate

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/email-templates/render?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."

9}'

10

Structure de Requête POST de EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse POST de EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'does-not-render';

7 /** Included on failure. **/

8 reason?: string

9 /** The rendered HTML on success. **/

10 html?: string

11}

12

Cette route fournit la suppression d'un unique EmailTemplate par id.

Exemple cURL de Suppression de EmailTemplate

Copy

1

2curl --request DELETE \

3 --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de Suppression de EmailTemplate

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Suppression de EmailTemplate

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'

6 /** Included on failure. **/

7 reason?: string

8}

9

Cette API utilise la pagination, fournie par le paramètre de requête page. Les HashTags sont retournés par pages de 100, triés par tag.

Exemple cURL de HashTag

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/hash-tags?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de HashTag

Copy

1

2interface HashTagsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The page to fetch, starting with 0. **/

6 page: number

7}

8

Structure de Réponse de HashTag

Copy

1

2interface HashTagsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'

6 /** Included on failure. **/

7 reason?: string

8 /** The hashtags! **/

9 hashTags: HashTag[]

10}

11

Cette route fournit la capacité de mettre à jour un seul HashTag.

Exemple cURL de Mise à Jour de HashTag

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/hash-tags/%23example_hash_tag?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "url": "https://example.com/some-`page`"

7}'

8

Structure de Requête de Mise à Jour de HashTag

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Mise à Jour de HashTag

Copy

1

2interface HashTagPatchResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag' | 'already-exists'

6 /** Included on failure. **/

7 reason?: string

8 hashTag?: HashTag; // We return the complete updated hashtag on success.

9}

10

Cette route fournit la capacité d'ajouter un seul HashTag.

Exemple cURL de Création de HashTag

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/hash-tags?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "tag": "#example",

7 "url": "https://example.com/some-page"

8}'

9

Structure de Requête de Création de HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Création de HashTag

Copy

1

2interface HashTagPostResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag'

6 /** Included on failure. **/

7 reason?: string

8 hashTag?: HashTag; // We return the complete created hashtag on success.

9}

10

Cette route fournit la capacité d'ajouter jusqu'à 100 objets HashTag à la fois.

Exemple cURL de Création en Masse de HashTag

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/hash-tags/bulk?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "tags": [

7 {

8 "tag": "#example",

9 "url": "https://example.com/some-page"

10 }

11 ]

12}'

13

Structure de Requête de Création en Masse de HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Création en Masse de HashTag

Copy

1

2interface HashTagBulkPostResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag'

6 /** Included on failure. **/

7 reason?: string

8 results?: HashTagPostResponse[]; // We return a list of HashTagPostResponse objects for each provided tag.

9}

10

Cette route permet la suppression d'un HashTag utilisateur par le tag fourni.

Notez qu'à moins que la création automatique de HashTag ne soit désactivée, les hashtags peuvent être recréés par un utilisateur fournissant le hashtag lors de la rédaction d'un commentaire.

Exemple cURL de Suppression de HashTag

Copy

1

2curl --request DELETE \

3 --url 'https://fastcomments.com/api/v1/hash-tags/%23example_hash_tag?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de Suppression de HashTag

Copy

1

2interface HashTagDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Suppression de HashTag

Copy

1

2interface HashTagDeleteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist'

6 /** Included on failure. **/

7 reason?: string

8}

9

Un objet Moderator représente la configuration d'un modérateur.

Il existe trois types de modérateurs :

1. Les utilisateurs administrateurs qui ont le drapeau isCommentModeratorAdmin.
2. Les utilisateurs SSO avec le drapeau isCommentModeratorAdmin.
3. Les commentateurs réguliers, ou utilisateurs FastComments.com, qui sont invités en tant que modérateurs.

La structure Moderator est utilisée pour représenter l'état de modération du cas d'utilisation 3.

Si vous souhaitez inviter un utilisateur à être modérateur, via l'API, utilisez l'API Moderator en créant un Moderator et en l'invitant.

Si l'utilisateur n'a pas de compte FastComments.com, l'email d'invitation l'aidera à se configurer. S'il a déjà un compte, il se verra accorder l'accès de modération à votre locataire et le userId de l'objet Moderator sera mis à jour pour pointer vers son utilisateur. Vous n'aurez pas d'accès API à son utilisateur, car dans ce cas il lui appartient et est géré par FastComments.com.

Si vous avez besoin d'une gestion complète du compte de l'utilisateur, nous recommandons soit d'utiliser SSO, soit de l'ajouter en tant qu'Utilisateur Locataire et ensuite d'ajouter un objet Moderator pour suivre ses statistiques.

La structure Moderator peut être utilisée comme mécanisme de suivi des statistiques pour les cas d'utilisation 1 et 2. Après avoir créé l'utilisateur, ajoutez un objet Moderator avec son userId défini et ses statistiques seront suivies sur la Page des Modérateurs de Commentaires.

La structure de l'objet Moderator est la suivante :

Structure de Modérateur

Copy

1

2interface Moderator {

3 name: string

4 email: string

5 tenantId: string

6 userId?: string|null

7 acceptedInvite?: boolean

8 markReviewedCount?: number

9 deletedCount?: number

10 markedSpamCount?: number

11 approvedCount?: number

12 editedCount?: number

13 bannedCount?: number

14 createdAt: string

15 moderationGroupIds?: string[]|null

16}

17

Cette route retourne un seul modérateur par son id.

Exemple cURL de Modérateur par ID

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de Modérateur

Copy

1

2interface ModeratorByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Modérateur

Copy

1

2interface ModeratorByIdResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'

6 /** Included on failure. **/

7 reason?: string

8 moderator?: Moderator

9}

10

Cette API utilise la pagination, fournie par le paramètre de requête skip. Les modérateurs sont retournés par pages de 100, triés par createdAt et id.

Le coût est basé sur le nombre de modérateurs retournés, coûtant 1 crédit par 10 modérateurs retournés.

Exemple cURL de Modérateur

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de Modérateur

Copy

1

2interface ModeratorsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The number of moderators to skip for pagination. **/

6 skip?: number

7}

8

Structure de Réponse de Modérateur

Copy

1

2interface ModeratorsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'

6 /** Included on failure. **/

7 reason?: string

8 moderators?: Moderator[]

9}

10

Ce endpoint API fournit la capacité de mettre à jour un Moderator par id.

La mise à jour d'un Moderator a les restrictions suivantes :

• Les valeurs suivantes ne peuvent pas être fournies lors de la mise à jour d'un Moderator :
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Lorsqu'un userId est spécifié, cet utilisateur doit exister.
• Lorsqu'un userId est spécifié, il doit appartenir au même tenantId spécifié dans les paramètres de requête.
• Deux modérateurs dans le même locataire ne peuvent pas être ajoutés avec le même email.
• Vous ne pouvez pas changer le tenantId associé à un Moderator.

Exemple cURL de PATCH de Modérateur

Copy

1

2curl --request PATCH \

3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "name": "Some New Name",

7}'

8

Structure de Requête PATCH de Modérateur

Copy

1

2interface ModeratorPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse PATCH de Modérateur

Copy

1

2

3interface ModeratorPatchResponse {

4 status: 'success' | 'failed'

5 /** Included on failure. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';

7 /** Included on failure. **/

8 reason?: string

9}

10

Cette route fournit la capacité d'ajouter un seul Moderator.

La création d'un Moderator a les restrictions suivantes :

• Un name et un email doivent toujours être fournis. Un userId est optionnel.
• Les valeurs suivantes ne peuvent pas être fournies lors de la création d'un Moderator :
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Lorsqu'un userId est spécifié, cet utilisateur doit exister.
• Lorsqu'un userId est spécifié, il doit appartenir au même tenantId spécifié dans les paramètres de requête.
• Deux modérateurs dans le même locataire ne peuvent pas être ajoutés avec le même email.

Nous pouvons créer un Moderator pour un utilisateur dont nous ne connaissons que l'email :

Exemple cURL de Création de Modérateur via Email

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "name": "Some Name",

7 "email": "someone@someone.com"

8}'

9

Ou nous pouvons créer un Moderator pour un utilisateur qui appartient à notre locataire, pour suivre leurs statistiques de modération :

Exemple cURL de Création de Modérateur via Utilisateur Locataire

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "name": "Some Name",

7 "email": "someone@someone.com",

8 "userId": "some-tenant-user-id"

9}'

10

Structure de Requête de Création de Modérateur

Copy

1

2interface ModeratorPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Création de Modérateur

Copy

1

2interface ModeratorPostResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'

6 /** Included on failure. **/

7 reason?: string

8 moderator?: Moderator; // We return the complete created moderator on success.

9}

10

Cette route fournit la capacité d'inviter un seul Moderator.

Les restrictions suivantes existent pour envoyer un email d'invitation à un Moderator :

• Le Moderator doit déjà exister.
• Le fromName ne peut pas dépasser 100 caractères.

Notes :

• Si un utilisateur avec l'email fourni existe déjà, il sera invité à modérer les commentaires de votre locataire.
• Si un utilisateur avec l'email fourni n'existe pas, le lien d'invitation le guidera dans la création de son compte.
• L'invitation expirera après 30 jours.

Nous pouvons créer un Moderator pour un utilisateur dont nous ne connaissons que l'email :

Exemple cURL d'Invitation de Modérateur

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/moderators/xyz/send-invite?tenantId=demo&API_KEY=DEMO_API_SECRET&fromName=Bob' \

4 --header 'Content-Type: application/json'

5

Cela enverra un email comme Bob de TenantName vous invite à être modérateur...

Structure de Requête d'Invitation de Modérateur

Copy

1

2interface ModeratorSendInviteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** The email sent to the user will appear to be sent from this name. **/

6 fromName: string

7}

8

Structure de Réponse d'Invitation de Modérateur

Copy

1

2interface ModeratorSendInviteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found | 'from-name-required' | 'from-name-invalid'

6 /** Included on failure. **/

7 reason?: string

8}

9

Cette route permet la suppression d'un Moderator par id.

Exemple cURL de Suppression de Modérateur

Copy

1

2curl --request DELETE \

3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4

Structure de Requête de Suppression de Modérateur

Copy

1

2interface ModeratorDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Suppression de Modérateur

Copy

1

2interface ModeratorDeleteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'

6 /** Included on failure. **/

7 reason?: string

8}

9

Cette route retourne un seul NotificationCount par id utilisateur. Avec SSO, l'id utilisateur est au format <tenant id>:<user id>.

S'il n'y a pas de notifications non lues, il n'y aura pas de NotificationCount - donc vous obtiendrez un 404.

Ceci est différent de notifications/count en ce qu'il est beaucoup plus rapide, mais ne permet pas le filtrage.

Exemple cURL de NotificationCount par ID

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4# -> {"status":"success","data":{"count":1,"createdAt":"2023-03-06T18:45:01.726Z","expireAt":"2024-03-06T01:25:01.726Z","id":"example"}}

5

Structure de Requête de NotificationCount

Copy

1

2interface NotificationCountGetQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de NotificationCount

Copy

1

2interface NotificationCountGetResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'

6 /** Included on failure. **/

7 reason?: string

8 data?: NotificationCount

9}

10

Cette route supprime un seul NotificationCount par id utilisateur. Avec SSO, l'id utilisateur est au format <tenant id>:<user id>.

Cela effacera le compteur de notifications non lues de l'utilisateur (la cloche rouge dans le widget de commentaires s'estompera et le compteur disparaîtra).

Exemple cURL de DELETE NotificationCount

Copy

1

2curl --request DELETE \

3 --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

4# -> {"status":"success"}

5

Structure de Requête de Suppression de NotificationCount

Copy

1

2interface NotificationCountDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Structure de Réponse de Suppression de NotificationCount

Copy

1

2interface NotificationCountDeleteResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'

6 /** Included on failure. **/

7 reason?: string

8}

9