Χρήση Πόρων

Πρέπει να σημειωθεί ότι η ανάκτηση δεδομένων από το API μετράται ως χρήση στον λογαριασμό σας.

Κάθε πόρος θα αναφέρει ποια είναι αυτή η χρήση στη δική του ενότητα.

Ορισμένοι πόροι κοστίζουν περισσότερο στην εξυπηρέτηση από άλλους. Κάθε endpoint έχει ένα καθορισμένο κόστος credits ανά κλήση API. Για ορισμένα endpoints, ο αριθμός των credits ποικίλλει ανάλογα με τις επιλογές και τα μεγέθη των απαντήσεων.

Η χρήση του API μπορεί να ελεγχθεί στη σελίδα Billing Analytics και ενημερώνεται κάθε λίγα λεπτά.

Σημείωση!

Προτείνουμε να διαβάσετε πρώτα την τεκμηρίωση των Pages, για να αποφύγετε τη σύγχυση όταν καθορίζετε ποιες τιμές να περάσετε για το urlId στο Comment API.

Αυτό το API συγκεντρώνει έγγραφα ομαδοποιώντας τα (αν παρέχεται groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες. Υποστηρίζονται διαφορετικές λειτουργίες (π.χ. sum, countDistinct, avg, κ.λπ.).

Το κόστος είναι μεταβλητό. Κάθε 500 αντικείμενα που σαρώνονται κοστίζουν 1 API credit.

Η μέγιστη χρήση μνήμης που επιτρέπεται ανά κλήση API από προεπιλογή είναι 64MB, και από προεπιλογή μπορείτε να έχετε μόνο μία συγκέντρωση να εκτελείται τη φορά. Αν υποβάλετε πολλαπλές συγκεντρώσεις ταυτόχρονα, θα μπουν σε ουρά και θα εκτελεστούν με τη σειρά που υποβλήθηκαν. Οι εκκρεμείς συγκεντρώσεις θα περιμένουν το πολύ 60 δευτερόλεπτα, μετά από αυτό το αίτημα θα λήξει. Οι μεμονωμένες συγκεντρώσεις μπορούν να εκτελούνται για έως 5 λεπτά.

Αν έχετε διαχειριζόμενους tenants, μπορείτε να συγκεντρώσετε όλους τους πόρους των θυγατρικών tenants σε μία κλήση περνώντας την παράμετρο query parentTenantId.

Παραδείγματα

Παράδειγμα: Μέτρηση Μοναδικών

Μέτρηση Μοναδικών Τιμών cURL Παράδειγμα

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

Μέτρηση Μοναδικών Τιμών Απάντηση

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

Παράδειγμα: Μέτρηση Διακριτών

Μέτρηση Διακριτών Τιμών cURL Παράδειγμα

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

Απάντηση:

Μέτρηση Διακριτών Τιμών Απάντηση

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

Παράδειγμα: Άθροισμα Τιμών Πολλαπλών Πεδίων

Άθροισμα Τιμών cURL Παράδειγμα

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

Απάντηση:

Άθροισμα Τιμών Απάντηση

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

Παράδειγμα: Μέσος Όρος Τιμών Πολλαπλών Πεδίων

Μέσος Όρος Τιμών cURL Παράδειγμα

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

Απάντηση:

Μέσος Όρος Τιμών Απάντηση

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

Παράδειγμα: Ελάχιστο/Μέγιστο Τιμών Πολλαπλών Πεδίων

Ελάχιστο/Μέγιστο Τιμών cURL Παράδειγμα

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

Απάντηση:

Ελάχιστο/Μέγιστο Τιμών Απάντηση

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

Παράδειγμα: Μέτρηση Μοναδικών Τιμών Πολλαπλών Πεδίων

Μέτρηση Μοναδικών Τιμών cURL Παράδειγμα

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

Απάντηση:

Μέτρηση Μοναδικών Τιμών Απάντηση

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

Παράδειγμα: Δημιουργία Ερωτήματος

Δημιουργία Ερωτήματος cURL Παράδειγμα

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

Απάντηση:

Δημιουργία Ερωτήματος Απάντηση

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

Παράδειγμα: Μέτρηση Σχολίων σε Αναμονή Ελέγχου

Μέτρηση Σχολίων σε Αναμονή Ελέγχου cURL Παράδειγμα

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

Απάντηση:

Μέτρηση Σχολίων σε Αναμονή Ελέγχου Απάντηση

Copy

1

2{

3 "status": "success",

4 "data": [

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

6 ],

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

8}

9

Παράδειγμα: Ανάλυση Εγκεκριμένων, Ελεγμένων και Spam Σχολίων

Ανάλυση Σχολίων cURL Παράδειγμα

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

Απάντηση:

Ανάλυση Σχολίων Απάντηση

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

Δομές

Δομή Αιτήματος Συγκέντρωσης

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

Δομή Απάντησης Συγκέντρωσης

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

Οι ακόλουθοι πόροι μπορούν να συγκεντρωθούν:

• 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

Αυτό το API χρησιμοποιεί σελιδοποίηση, που παρέχεται από τις παραμέτρους skip, before και after. Τα AuditLogs επιστρέφονται σε σελίδες των 1000, ταξινομημένα κατά when και id.

Η ανάκτηση κάθε 1000 logs έχει κόστος credit 10.

Από προεπιλογή, θα λάβετε μια λίστα με τα νεότερα στοιχεία πρώτα. Με αυτόν τον τρόπο, μπορείτε να κάνετε polling ξεκινώντας με skip=0, σελιδοποιώντας μέχρι να βρείτε την τελευταία εγγραφή που έχετε καταναλώσει.

Εναλλακτικά, μπορείτε να ταξινομήσετε από τα παλαιότερα στα νεότερα, και να σελιδοποιήσετε μέχρι να μην υπάρχουν άλλες εγγραφές.

Η ταξινόμηση μπορεί να γίνει ρυθμίζοντας το order είτε σε ASC είτε σε DESC. Η προεπιλογή είναι ASC.

Η αναζήτηση κατά ημερομηνία είναι δυνατή μέσω before και after ως timestamps με milliseconds. Τα before και after ΔΕΝ είναι inclusive.

AuditLog cURL Παράδειγμα

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

Δομή Αιτήματος 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

Δομή Απάντησης 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

Αυτό το API χρησιμοποιείται για να πάρετε σχόλια για εμφάνιση σε έναν χρήστη. Για παράδειγμα, φιλτράρει αυτόματα τα μη εγκεκριμένα ή spam σχόλια.

Σελιδοποίηση

Η σελιδοποίηση μπορεί να γίνει με έναν από δύο τρόπους, ανάλογα με τις απαιτήσεις απόδοσης και την περίπτωση χρήσης:

1. Ταχύτερη: Προϋπολογισμένη Σελιδοποίηση:
   1. Έτσι λειτουργεί το FastComments όταν χρησιμοποιείτε τα προκατασκευασμένα widgets και clients μας.
   2. Κάνοντας κλικ στο "επόμενο" απλά αυξάνει τον αριθμό σελίδας.
   3. Μπορείτε να το σκεφτείτε ως ανάκτηση από ένα key-value store.
   4. Με αυτόν τον τρόπο, απλά ορίστε μια παράμετρο page ξεκινώντας από 0 και μια κατεύθυνση ταξινόμησης ως direction.
   5. Τα μεγέθη σελίδων μπορούν να προσαρμοστούν μέσω κανόνων προσαρμογής.
2. Πιο Ευέλικτη: Ευέλικτη Σελιδοποίηση:
   1. Με αυτόν τον τρόπο μπορείτε να ορίσετε προσαρμοσμένες παραμέτρους limit και skip. Μην περνάτε page.
   2. Η κατεύθυνση ταξινόμησης direction υποστηρίζεται επίσης.
   3. Το limit είναι ο συνολικός αριθμός για επιστροφή μετά την εφαρμογή του skip.
      • Παράδειγμα: ορίστε skip = 200, limit = 100 όταν page size = 100 και page = 2.
   4. Τα θυγατρικά σχόλια εξακολουθούν να μετρούν στη σελιδοποίηση. Μπορείτε να το παρακάμψετε χρησιμοποιώντας την επιλογή asTree.
      • Μπορείτε να σελιδοποιήσετε τα παιδιά μέσω limitChildren και skipChildren.
      • Μπορείτε να περιορίσετε το βάθος των threads που επιστρέφονται μέσω maxTreeDepth.

Threads

1. Όταν χρησιμοποιείτε Προϋπολογισμένη Σελιδοποίηση, τα σχόλια ομαδοποιούνται ανά σελίδα και τα σχόλια σε threads επηρεάζουν τη συνολική σελίδα.
   1. Με αυτόν τον τρόπο, τα threads μπορούν να καθοριστούν στον client βάσει του parentId.
   2. Για παράδειγμα, με μια σελίδα με ένα σχόλιο κορυφαίου επιπέδου, και 29 απαντήσεις, και ρυθμίζοντας page=0 στο API - θα πάρετε μόνο το σχόλιο κορυφαίου επιπέδου και τα 29 παιδιά.
   3. Παράδειγμα εικόνας εδώ που απεικονίζει πολλαπλές σελίδες.
2. Όταν χρησιμοποιείτε Ευέλικτη Σελιδοποίηση, μπορείτε να ορίσετε μια παράμετρο parentId.
   1. Ορίστε αυτό σε null για να πάρετε μόνο σχόλια κορυφαίου επιπέδου.
   2. Στη συνέχεια για να δείτε threads, καλέστε ξανά το API και περάστε parentId.
   3. Μια συνηθισμένη λύση είναι να κάνετε μια κλήση API για τα σχόλια κορυφαίου επιπέδου και στη συνέχεια να κάνετε παράλληλες κλήσεις API για να πάρετε σχόλια για τα παιδιά κάθε σχολίου.
3. ΝΕΟ από Φεβ 2023! Ανάκτηση ως δέντρο χρησιμοποιώντας &asTree=true.
   1. Μπορείτε να το σκεφτείτε ως Ευέλικτη Σελιδοποίηση ως Δέντρο.
   2. Μόνο τα σχόλια κορυφαίου επιπέδου μετρούν στη σελιδοποίηση.
   3. Ορίστε parentId=null για να ξεκινήσετε το δέντρο από τη ρίζα (πρέπει να ορίσετε parentId).
   4. Ορίστε skip και limit για σελιδοποίηση.
   5. Ορίστε asTree σε true.
   6. Το κόστος credits αυξάνεται κατά 2x, καθώς το backend μας πρέπει να κάνει πολύ περισσότερη δουλειά σε αυτό το σενάριο.
   7. Ορίστε maxTreeDepth, limitChildren, και skipChildren όπως επιθυμείτε.

Εξήγηση Δέντρων

Όταν χρησιμοποιείτε asTree, μπορεί να είναι δύσκολο να συλλάβετε τη σελιδοποίηση. Εδώ είναι ένα χρήσιμο γραφικό:

Διάγραμμα Σελιδοποίησης Δέντρου

Ανάκτηση Σχολίων στο Πλαίσιο ενός Χρήστη

Το /comments API μπορεί να χρησιμοποιηθεί σε δύο πλαίσια, για διαφορετικές περιπτώσεις χρήσης:

• Για επιστροφή σχολίων ταξινομημένων και με πληροφορίες για την κατασκευή του δικού σας client.
  • Σε αυτή την περίπτωση, ορίστε μια παράμετρο query contextUserId.
• Για ανάκτηση σχολίων από το backend σας για προσαρμοσμένες ενσωματώσεις.
  • Η πλατφόρμα θα επιλέξει αυτό από προεπιλογή χωρίς contextUserId.

Σχόλια Προϋπολογισμένη Σελιδοποίηση

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

Σχόλια Ευέλικτη Σελιδοποίηση

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

Σχόλια Ευέλικτη Σελιδοποίηση σε Πλαίσιο Χρήστη

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

Σχόλια Ευέλικτη Σελιδοποίηση σε Πλαίσιο Χρήστη μόνο για Σχόλια Κορυφαίου Επιπέδου

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

Ανάκτηση Σχολίων ως Δέντρο

Είναι δυνατό να πάρετε τα σχόλια που επιστρέφονται ως δέντρο, με τη σελιδοποίηση να μετρά μόνο τα σχόλια κορυφαίου επιπέδου.

Σχόλια Ως-Δέντρο σε Πλαίσιο Χρήστη

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

Θέλετε να πάρετε μόνο τα σχόλια κορυφαίου επιπέδου και τα άμεσα παιδιά; Εδώ είναι ένας τρόπος:

Σχόλια Ως-Δέντρο με Μέγιστο Βάθος

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

Ωστόσο, στο UI σας μπορεί να χρειαστεί να γνωρίζετε αν θα εμφανίσετε ένα κουμπί "εμφάνιση απαντήσεων" σε κάθε σχόλιο. Όταν ανακτάτε σχόλια μέσω δέντρου υπάρχει μια ιδιότητα hasChildren που προστίθεται στα σχόλια όταν ισχύει.

Ανάκτηση Σχολίων ως Δέντρο, Αναζήτηση με Hash Tag

Είναι δυνατή η αναζήτηση με hashtag χρησιμοποιώντας το API, σε ολόκληρο τον tenant σας (όχι περιορισμένη σε μία σελίδα, ή urlId).

Σε αυτό το παράδειγμα, παραλείπουμε το urlId, και αναζητούμε με πολλαπλά hashtags. Το API θα επιστρέψει μόνο σχόλια που έχουν όλα τα ζητούμενα hashtags.

Σχόλια Ως-Δέντρο σε Πλαίσιο Χρήστη, με 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

Όλες οι Παράμετροι Αιτήματος

Δομή Αιτήματος Σχολίων

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

Η Απάντηση

Δομή Απάντησης Σχολίων

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

Χρήσιμες Συμβουλές

URL ID

Πιθανότατα θέλετε να χρησιμοποιήσετε το Comment API με την παράμετρο urlId. Μπορείτε να καλέσετε πρώτα το Pages API, για να δείτε πώς μοιάζουν οι διαθέσιμες τιμές urlId.

Ανώνυμες Ενέργειες

Για ανώνυμο σχολιασμό πιθανότατα θέλετε να περνάτε anonUserId όταν ανακτάτε σχόλια, και όταν εκτελείτε επισήμανση και αποκλεισμό.

(!) Αυτό απαιτείται για πολλά app stores καθώς οι χρήστες πρέπει να μπορούν να επισημάνουν περιεχόμενο που δημιουργήθηκε από χρήστες που μπορούν να δουν, ακόμα κι αν δεν είναι συνδεδεμένοι. Η μη συμμόρφωση μπορεί να προκαλέσει την αφαίρεση της εφαρμογής σας από το εν λόγω store.

Σχόλια που δεν Επιστρέφονται

Ελέγξτε ότι τα σχόλιά σας είναι εγκεκριμένα, και δεν είναι spam.

Αυτό το API παρέχει τη δυνατότητα ανάκτησης ενός μόνο σχολίου με βάση το id.

Ανάκτηση Σχολίου με ID cURL Παράδειγμα

Copy

1

2curl --request GET \

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

4

Δομή Αιτήματος Ανάκτησης Σχολίου με ID

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Ανάκτησης Σχολίου με 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

Αυτό το API endpoint παρέχει τη δυνατότητα δημιουργίας σχολίων.

Συνήθεις περιπτώσεις χρήσης είναι προσαρμοσμένα UI, ενσωματώσεις ή εισαγωγές.

Σημειώσεις:

• Αυτό το API μπορεί να ενημερώσει το comment widget "live" αν επιθυμείτε (αυτό αυξάνει το creditsCost από 1 σε 2).
• Αυτό το API θα δημιουργήσει αυτόματα αντικείμενα χρηστών στο σύστημά μας αν παρέχεται email.
• Η προσπάθεια αποθήκευσης δύο σχολίων με διαφορετικά emails, αλλά το ίδιο username, θα οδηγήσει σε σφάλμα για το δεύτερο σχόλιο.
• Αν καθορίζετε parentId, και ένα θυγατρικό σχόλιο έχει notificationSentForParent ως false, θα στείλουμε ειδοποιήσεις για το γονικό σχόλιο. Αυτό γίνεται κάθε ώρα (συγκεντρώνουμε τις ειδοποιήσεις μαζί για να μειώσουμε τον αριθμό των emails που αποστέλλονται).
• Αν θέλετε να στείλετε emails καλωσορίσματος κατά τη δημιουργία χρηστών, ή emails επαλήθευσης σχολίων, ορίστε sendEmails σε true στις παραμέτρους query.
• Τα σχόλια που δημιουργούνται μέσω αυτού του API θα εμφανίζονται στις σελίδες Analytics και Moderation της εφαρμογής διαχείρισης.
• Οι "κακές λέξεις" εξακολουθούν να καλύπτονται στα ονόματα σχολιαστών και στο κείμενο σχολίου αν η ρύθμιση είναι ενεργοποιημένη.
• Τα σχόλια που δημιουργούνται μέσω αυτού του API μπορούν ακόμα να ελεγχθούν για spam αν επιθυμείτε.
• Διαμόρφωση όπως μέγιστο μήκος σχολίου, αν διαμορφωθεί μέσω της σελίδας διαχείρισης Customization Rule, θα εφαρμοστεί εδώ.

Τα ελάχιστα δεδομένα που απαιτούνται για υποβολή που θα εμφανίζονται στο comment widget, είναι τα εξής:

Ελάχιστη Δημιουργία Σχολίου POST cURL Παράδειγμα

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

Ένα πιο ρεαλιστικό αίτημα μπορεί να μοιάζει με:

Δημιουργία Σχολίου POST cURL Παράδειγμα

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

Δομή Αιτήματος Δημιουργίας Σχολίου POST

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

Δομή Απάντησης Δημιουργίας Σχολίου POST

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

Αυτό το API endpoint παρέχει τη δυνατότητα ενημέρωσης ενός μεμονωμένου σχολίου.

Σημειώσεις:

• Αυτό το API μπορεί να ενημερώσει το widget σχολίων "ζωντανά" αν το επιθυμείτε (αυτό αυξάνει το βασικό creditsCost από 1 σε 2).
  • Αυτό μπορεί να κάνει τη μετεγκατάσταση σχολίων μεταξύ σελίδων "ζωντανή" (αλλάζοντας το urlId).
  • Οι μετεγκαταστάσεις κοστίζουν επιπλέον 2 credits καθώς οι σελίδες προϋπολογίζονται και αυτό απαιτεί υψηλή CPU.
• Σε αντίθεση με το API δημιουργίας, αυτό το API ΔΕΝ θα δημιουργεί αυτόματα αντικείμενα χρήστη στο σύστημά μας αν παρέχεται email.
• Τα σχόλια που ενημερώνονται μέσω αυτού του API μπορούν ακόμη να ελεγχθούν για spam, αν το επιθυμείτε.
• Ρυθμίσεις όπως το μέγιστο μήκος σχολίου, εάν έχουν ρυθμιστεί μέσω της σελίδας διαχείρισης Customization Rule, θα εφαρμόζονται εδώ.
• Για να επιτρέψετε στους χρήστες να ενημερώσουν το κείμενο του σχολίου τους, μπορείτε απλά να καθορίσετε το comment στο σώμα του αιτήματος. Εμείς θα δημιουργήσουμε το προκύπτον commentHTML.
  • Εάν καθορίσετε και τα comment και commentHTML, δεν θα δημιουργήσουμε αυτόματα το HTML.
  • Εάν ο χρήστης προσθέσει mentions ή hashtags στο νέο κείμενό του, θα επεξεργαστείται όπως και στο POST API.
• Όταν ενημερώνετε το commenterEmail σε ένα σχόλιο, είναι καλύτερο επίσης να καθορίσετε το userId. Διαφορετικά, πρέπει να διασφαλίσετε ότι ο χρήστης με αυτό το email ανήκει στον tenant σας, αλλιώς το αίτημα θα αποτύχει.
• Εάν το στοχευόμενο σχόλιο είναι κλειδωμένο (isLocked: true), το αίτημα απορρίπτεται με code: 'locked'. Ξεκλειδώστε πρώτα το σχόλιο, ενημερώστε το, και μετά κλειδώστε το ξανά αν το επιθυμείτε.

Ελάχιστο Παράδειγμα PATCH cURL Σχολίου

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

Δομή Αιτήματος PATCH Σχολίου

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Ο χρήστης που πραγματοποιεί την ενημέρωση. Αν επιθυμείτε, μπορεί να χρησιμοποιηθεί για να ελεγχθεί εάν μπορούν να επεξεργαστούν το σχόλιο. **/

6 contextUserId?: string

7 /** Να ελέγξουμε αν το νέο σχόλιο μοιάζει με spam; **/

8 doSpamCheck?: 'true' | 'false'

9 /** Εάν το σχόλιο πρέπει να εμφανίζεται "ζωντανά" στους χρήστες που βλέπουν περιπτώσεις του widget σχολίων με το ίδιο urlId. ΣΗΜΕΙΩΣΗ: Διπλασιάζει το κόστος σε credits από 1 σε 2. **/

10 isLive?: 'true' | 'false'

11}

12

Δομή Απάντησης PATCH Σχολίου

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Συμπεριλαμβάνεται σε περίπτωση αποτυχίας. **/

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' | 'locked'

7 /** Συμπεριλαμβάνεται σε περίπτωση αποτυχίας. **/

8 reason?: string

9}

10

Αυτό το endpoint API παρέχει τη δυνατότητα διαγραφής ενός σχολίου.

Σημειώσεις:

• Αυτό το API μπορεί να ενημερώσει το widget σχολίων "live" εάν το επιθυμείτε (αυτό αυξάνει creditsCost από 1 σε 2).
• Αυτό το API θα διαγράψει όλα τα παιδικά σχόλια.
• Εάν το στοχευόμενο σχόλιο είναι κλειδωμένο (isLocked: true), το αίτημα απορρίπτεται με code: 'locked'. Ξεκλειδώστε πρώτα το σχόλιο, και μετά διαγράψτε το.

Παράδειγμα cURL DELETE Σχολίου

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

Δομή Αιτήματος DELETE Σχολίου

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** Ο χρήστης που πραγματοποιεί την ενημέρωση. Εάν το επιθυμείτε, μπορεί να χρησιμοποιηθεί για να ελεγχθεί αν μπορεί να διαγράψει το σχόλιο. **/

6 contextUserId?: string

7 /** Εάν το σχόλιο θα πρέπει να διαγραφεί "live" για χρήστες που βλέπουν εμφανίσεις του widget σχολίων με το ίδιο urlId. ΣΗΜΕΙΩΣΗ: Διπλασιάζει το κόστος σε credits από 1 σε 2. **/

8 isLive?: 'true' | 'false'

9}

10

Δομή Απόκρισης DELETE Σχολίου

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Συμπεριλαμβάνεται σε περίπτωση αποτυχίας. **/

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

7 /** Συμπεριλαμβάνεται σε περίπτωση αποτυχίας. **/

8 reason?: string

9}

10

Αυτό το API endpoint παρέχει τη δυνατότητα επισήμανσης ενός σχολίου για έναν συγκεκριμένο χρήστη.

Σημειώσεις:

• Αυτή η κλήση πρέπει πάντα να γίνεται στο πλαίσιο ενός χρήστη. Ο χρήστης μπορεί να είναι FastComments.com User, SSO User ή Tenant User.
• Αν έχει οριστεί όριο επισήμανσης για απόκρυψη, το σχόλιο θα αποκρυφτεί αυτόματα live αφού επισημανθεί τον καθορισμένο αριθμό φορών.
• Αφού αυτόματα απορριφθεί (αποκρυφτεί) - το σχόλιο μπορεί να επανεγκριθεί μόνο από διαχειριστή ή συντονιστή. Η αφαίρεση της επισήμανσης δεν θα επανεγκρίνει το σχόλιο.

Επισήμανση Σχολίου cURL Παράδειγμα

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

Για ανώνυμη επισήμανση, πρέπει να καθορίσουμε ένα anonUserId. Αυτό μπορεί να είναι ένα ID που αντιπροσωπεύει την ανώνυμη συνεδρία, ή ένα τυχαίο UUID. Αυτό μας επιτρέπει να υποστηρίξουμε την επισήμανση και αφαίρεση επισήμανσης σχολίων ακόμα κι αν ένας χρήστης δεν είναι συνδεδεμένος. Με αυτόν τον τρόπο, το σχόλιο μπορεί να επισημανθεί ως επισημασμένο όταν ανακτώνται σχόλια με το ίδιο anonUserId.

Ανώνυμη Επισήμανση Σχολίου cURL Παράδειγμα

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

Δομή Αιτήματος Επισήμανσης Σχολίου

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Δομή Απάντησης Επισήμανσης Σχολίου

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

Αυτό το API endpoint παρέχει τη δυνατότητα αφαίρεσης επισήμανσης ενός σχολίου για έναν συγκεκριμένο χρήστη.

Σημειώσεις:

• Αυτή η κλήση πρέπει πάντα να γίνεται στο πλαίσιο ενός χρήστη. Ο χρήστης μπορεί να είναι FastComments.com User, SSO User ή Tenant User.
• Αφού ένα σχόλιο αυτόματα απορριφθεί (αποκρυφτεί) - το σχόλιο μπορεί να επανεγκριθεί μόνο από διαχειριστή ή συντονιστή. Η αφαίρεση της επισήμανσης δεν θα επανεγκρίνει το σχόλιο.

Αφαίρεση Επισήμανσης Σχολίου cURL Παράδειγμα

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

Για ανώνυμη επισήμανση, πρέπει να καθορίσουμε ένα anonUserId. Αυτό μπορεί να είναι ένα ID που αντιπροσωπεύει την ανώνυμη συνεδρία, ή ένα τυχαίο UUID.

Ανώνυμη Επισήμανση Σχολίου cURL Παράδειγμα

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

Δομή Αιτήματος Αφαίρεσης Επισήμανσης Σχολίου

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Δομή Απάντησης Αφαίρεσης Επισήμανσης Σχολίου

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

Αυτό το API endpoint παρέχει τη δυνατότητα αποκλεισμού ενός χρήστη που έγραψε ένα συγκεκριμένο σχόλιο. Υποστηρίζει τον αποκλεισμό από σχόλια που γράφτηκαν από χρήστες FastComments.com, SSO Users και Tenant Users.

Υποστηρίζει μια παράμετρο body commentIdsToCheck για να ελέγξει αν άλλα πιθανώς ορατά σχόλια στον client θα πρέπει να αποκλειστούν/ξεμπλοκαριστούν μετά την εκτέλεση αυτής της ενέργειας.

Σημειώσεις:

• Αυτή η κλήση πρέπει πάντα να γίνεται στο πλαίσιο ενός χρήστη. Ο χρήστης μπορεί να είναι FastComments.com User, SSO User ή Tenant User.
• Το userId στο αίτημα είναι ο χρήστης που κάνει τον αποκλεισμό. Για παράδειγμα: Ο User A θέλει να αποκλείσει τον User B. Περάστε userId=User A και το id σχολίου που έγραψε ο User B.
• Εντελώς ανώνυμα σχόλια (χωρίς user id, χωρίς email) δεν μπορούν να αποκλειστούν και θα επιστραφεί σφάλμα.

Αποκλεισμός Σχολίου cURL Παράδειγμα

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

Για ανώνυμο αποκλεισμό, πρέπει να καθορίσουμε ένα anonUserId. Αυτό μπορεί να είναι ένα ID που αντιπροσωπεύει την ανώνυμη συνεδρία, ή ένα τυχαίο UUID. Αυτό μας επιτρέπει να υποστηρίξουμε τον αποκλεισμό σχολίων ακόμα κι αν ένας χρήστης δεν είναι συνδεδεμένος, ανακτώντας τα σχόλια με το ίδιο anonUserId.

Ανώνυμος Αποκλεισμός Σχολίου cURL Παράδειγμα

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

Δομή Αιτήματος Αποκλεισμού Σχολίου

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Δομή Απάντησης Αποκλεισμού Σχολίου

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

Αυτό το API endpoint παρέχει τη δυνατότητα άρσης αποκλεισμού ενός χρήστη που έγραψε ένα συγκεκριμένο σχόλιο. Υποστηρίζει την άρση αποκλεισμού από σχόλια που γράφτηκαν από χρήστες FastComments.com, SSO Users και Tenant Users.

Υποστηρίζει μια παράμετρο body commentIdsToCheck για να ελέγξει αν άλλα πιθανώς ορατά σχόλια στον client θα πρέπει να αποκλειστούν/ξεμπλοκαριστούν μετά την εκτέλεση αυτής της ενέργειας.

Σημειώσεις:

• Αυτή η κλήση πρέπει πάντα να γίνεται στο πλαίσιο ενός χρήστη. Ο χρήστης μπορεί να είναι FastComments.com User, SSO User ή Tenant User.
• Το userId στο αίτημα είναι ο χρήστης που κάνει την άρση αποκλεισμού. Για παράδειγμα: Ο User A θέλει να άρει τον αποκλεισμό του User B. Περάστε userId=User A και το id σχολίου που έγραψε ο User B.
• Εντελώς ανώνυμα σχόλια (χωρίς user id, χωρίς email) δεν μπορούν να αποκλειστούν και θα επιστραφεί σφάλμα.

Άρση Αποκλεισμού Σχολίου cURL Παράδειγμα

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

Ανώνυμη Άρση Αποκλεισμού Σχολίου cURL Παράδειγμα

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

Δομή Αιτήματος Άρσης Αποκλεισμού Σχολίου

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Δομή Απάντησης Άρσης Αποκλεισμού Σχολίου

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

Μεμονωμένα EmailTemplates μπορούν να ανακτηθούν με βάση το αντίστοιχο id (ΟΧΙ emailTemplateId).

EmailTemplate ανά ID cURL Παράδειγμα

Copy

1

2curl --request GET \

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

4

Δομή Αιτήματος EmailTemplate ανά ID

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης EmailTemplate ανά 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

Αυτό το API χρησιμοποιεί σελιδοποίηση, που παρέχεται από την παράμετρο ερωτήματος page. Τα EmailTemplates επιστρέφονται σε σελίδες των 100, ταξινομημένα κατά createdAt και μετά id.

EmailTemplate cURL Παράδειγμα

Copy

1

2curl --request GET \

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

4

Δομή Αιτήματος 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

Δομή Απάντησης 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

Αυτό το API endpoint παρέχει τη δυνατότητα ενημέρωσης ενός προτύπου email καθορίζοντας μόνο το id και τα χαρακτηριστικά προς ενημέρωση.

Σημειώστε ότι όλες οι ίδιες επικυρώσεις για τη δημιουργία προτύπου ισχύουν επίσης, για παράδειγμα:

• Το πρότυπο πρέπει να αποδίδεται. Αυτό ελέγχεται με κάθε ενημέρωση.
• Δεν μπορείτε να έχετε διπλότυπα πρότυπα για το ίδιο domain (διαφορετικά το ένα θα αγνοηθεί σιωπηλά).

EmailTemplate PATCH cURL Παράδειγμα

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

Δομή Αιτήματος EmailTemplate PATCH

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης EmailTemplate PATCH

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

Αυτό το API endpoint παρέχει τη δυνατότητα δημιουργίας προτύπων email.

Σημειώσεις:

• Δεν μπορείτε να έχετε πολλαπλά πρότυπα με το ίδιο emailTemplateId με το ίδιο domain.
• Αλλά μπορείτε να έχετε ένα πρότυπο με χαρακτήρα μπαλαντέρ (domain = * και ένα πρότυπο ειδικό για domain για το ίδιο emailTemplateId).
• Ο καθορισμός domain είναι σχετικός μόνο αν έχετε διαφορετικά domains, ή θέλετε να χρησιμοποιήσετε συγκεκριμένα πρότυπα για δοκιμές (domain ορισμένο σε localhost κλπ).
• Αν καθορίσετε domain πρέπει να ταιριάζει με ένα DomainConfig. Σε σφάλμα παρέχεται μια λίστα με έγκυρα domains.
• Η σύνταξη προτύπου είναι EJS και αποδίδεται με χρονικό όριο 500ms. Το P99 για απόδοση είναι <5ms, οπότε αν φτάσετε τα 500ms κάτι δεν πάει καλά.
• Το πρότυπό σας πρέπει να αποδίδεται με τα δεδομένα testData που δώσατε για να αποθηκευτεί. Τα σφάλματα απόδοσης συγκεντρώνονται και αναφέρονται στον πίνακα ελέγχου (σύντομα διαθέσιμο μέσω API).

Τα ελάχιστα απαιτούμενα δεδομένα για την προσθήκη ενός προτύπου είναι τα ακόλουθα:

Ελάχιστο EmailTemplate POST cURL Παράδειγμα

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

Μπορεί να θέλετε να έχετε πρότυπα ανά ιστότοπο, οπότε ορίζετε το domain:

EmailTemplate POST cURL Παράδειγμα

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

Δομή Αιτήματος EmailTemplate POST

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης EmailTemplate POST

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

Αυτό το API endpoint παρέχει τη δυνατότητα προεπισκόπησης προτύπων email.

Ελάχιστο EmailTemplate Προεπισκόπηση POST cURL Παράδειγμα

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

Δομή Αιτήματος EmailTemplate POST

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης EmailTemplate POST

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

Αυτή η διαδρομή παρέχει την αφαίρεση ενός μόνο EmailTemplate με βάση το id.

Αφαίρεση EmailTemplate cURL Παράδειγμα

Copy

1

2curl --request DELETE \

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

4

Δομή Αιτήματος Αφαίρεσης EmailTemplate

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Αφαίρεσης 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

Αυτό το API χρησιμοποιεί σελιδοποίηση, που παρέχεται από την παράμετρο ερωτήματος page. Τα HashTags επιστρέφονται σε σελίδες των 100, ταξινομημένα κατά tag.

HashTag cURL Παράδειγμα

Copy

1

2curl --request GET \

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

4

Δομή Αιτήματος 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

Δομή Απάντησης 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

Αυτή η διαδρομή παρέχει τη δυνατότητα ενημέρωσης ενός μόνο HashTag.

Ενημέρωση HashTag cURL Παράδειγμα

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

Δομή Αιτήματος Ενημέρωσης HashTag

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Ενημέρωσης 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

Αυτή η διαδρομή παρέχει τη δυνατότητα προσθήκης ενός μόνο HashTag.

Δημιουργία HashTag cURL Παράδειγμα

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

Δομή Αιτήματος Δημιουργίας HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Δημιουργίας 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

Αυτή η διαδρομή παρέχει τη δυνατότητα προσθήκης έως 100 αντικειμένων HashTag ταυτόχρονα.

Μαζική Δημιουργία HashTag cURL Παράδειγμα

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

Δομή Αιτήματος Μαζικής Δημιουργίας HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Μαζικής Δημιουργίας 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

Αυτή η διαδρομή παρέχει την αφαίρεση ενός HashTag με βάση το παρεχόμενο tag.

Σημειώστε ότι εκτός αν η αυτόματη δημιουργία HashTag είναι απενεργοποιημένη, τα hashtags μπορούν να αναδημιουργηθούν από έναν χρήστη που παρέχει το hashtag κατά το σχολιασμό.

Αφαίρεση HashTag cURL Παράδειγμα

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

Δομή Αιτήματος Αφαίρεσης HashTag

Copy

1

2interface HashTagDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Αφαίρεσης 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

Ένα αντικείμενο Moderator αντιπροσωπεύει τη διαμόρφωση για έναν συντονιστή.

Υπάρχουν τρεις τύποι συντονιστών:

1. Χρήστες διαχειριστές που έχουν τη σημαία isCommentModeratorAdmin.
2. Χρήστες SSO με τη σημαία isCommentModeratorAdmin.
3. Κανονικοί σχολιαστές, ή χρήστες FastComments.com, που προσκαλούνται ως Συντονιστές.

Η δομή Moderator χρησιμοποιείται για να αναπαραστήσει την Κατάσταση Συντονισμού της περίπτωσης χρήσης 3.

Αν θέλετε να προσκαλέσετε έναν χρήστη να γίνει συντονιστής, μέσω του API, χρησιμοποιήστε το API Moderator δημιουργώντας έναν Moderator και προσκαλώντας τον.

Αν ο χρήστης δεν έχει λογαριασμό FastComments.com, το email πρόσκλησης θα τον βοηθήσει να ρυθμίσει. Αν έχει ήδη λογαριασμό, θα του δοθεί πρόσβαση συντονισμού στον ενοικιαστή σας και το userId του αντικειμένου Moderator θα ενημερωθεί για να δείχνει στον χρήστη του. Δεν θα έχετε πρόσβαση API στον χρήστη τους, καθώς σε αυτή την περίπτωση ανήκει στους ίδιους και διαχειρίζεται από το FastComments.com.

Αν απαιτείτε πλήρη διαχείριση του λογαριασμού του χρήστη, συνιστούμε είτε τη χρήση SSO, είτε την προσθήκη τους ως Χρήστη Ενοικιαστή και μετά την προσθήκη ενός αντικειμένου Moderator για την παρακολούθηση των στατιστικών τους.

Η δομή Moderator μπορεί να χρησιμοποιηθεί ως μηχανισμός παρακολούθησης στατιστικών για τις περιπτώσεις χρήσης 1 και 2. Μετά τη δημιουργία του χρήστη, προσθέστε ένα αντικείμενο Moderator με το userId τους ορισμένο και τα στατιστικά τους θα παρακολουθούνται στη Σελίδα Συντονιστών Σχολίων.

Η δομή για το αντικείμενο Moderator είναι η ακόλουθη:

Δομή Συντονιστή

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

Αυτή η διαδρομή επιστρέφει έναν μόνο συντονιστή με βάση το id του.

Συντονιστής Ανά ID cURL Παράδειγμα

Copy

1

2curl --request GET \

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

4

Δομή Αιτήματος Συντονιστή

Copy

1

2interface ModeratorByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Συντονιστή

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

Αυτό το API χρησιμοποιεί σελιδοποίηση, που παρέχεται από την παράμετρο ερωτήματος skip. Οι Συντονιστές επιστρέφονται σε σελίδες των 100, ταξινομημένοι κατά createdAt και id.

Το κόστος βασίζεται στον αριθμό των συντονιστών που επιστρέφονται, κοστίζοντας 1 πίστωση ανά 10 συντονιστές που επιστρέφονται.

Moderator cURL Παράδειγμα

Copy

1

2curl --request GET \

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

4

Δομή Αιτήματος Moderator

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

Δομή Απάντησης Moderator

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

Αυτό το API endpoint παρέχει τη δυνατότητα ενημέρωσης ενός Moderator με βάση το id.

Η ενημέρωση ενός Moderator έχει τους ακόλουθους περιορισμούς:

• Οι ακόλουθες τιμές δεν μπορούν να παρέχονται κατά την ενημέρωση ενός Moderator:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Όταν καθορίζεται ένα userId, αυτός ο χρήστης πρέπει να υπάρχει.
• Όταν καθορίζεται ένα userId, πρέπει να ανήκει στο ίδιο tenantId που καθορίζεται στις παραμέτρους ερωτήματος.
• Δύο συντονιστές στον ίδιο ενοικιαστή δεν μπορούν να προστεθούν με το ίδιο email.
• Δεν μπορείτε να αλλάξετε το tenantId που σχετίζεται με έναν Moderator.

Moderator PATCH cURL Παράδειγμα

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

Δομή Αιτήματος Moderator PATCH

Copy

1

2interface ModeratorPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Moderator PATCH

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

Αυτή η διαδρομή παρέχει τη δυνατότητα προσθήκης ενός μόνο Moderator.

Η δημιουργία ενός Moderator έχει τους ακόλουθους περιορισμούς:

• Ένα name και email πρέπει πάντα να παρέχονται. Το userId είναι προαιρετικό.
• Οι ακόλουθες τιμές δεν μπορούν να παρέχονται κατά τη δημιουργία ενός Moderator:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Όταν καθορίζεται ένα userId, αυτός ο χρήστης πρέπει να υπάρχει.
• Όταν καθορίζεται ένα userId, πρέπει να ανήκει στο ίδιο tenantId που καθορίζεται στις παραμέτρους ερωτήματος.
• Δύο συντονιστές στον ίδιο ενοικιαστή δεν μπορούν να προστεθούν με το ίδιο email.

Μπορούμε να δημιουργήσουμε έναν Moderator για έναν χρήστη για τον οποίο γνωρίζουμε μόνο το email:

Δημιουργία Συντονιστή μέσω Email cURL Παράδειγμα

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

Ή μπορούμε να δημιουργήσουμε έναν Moderator για έναν χρήστη που ανήκει στον ενοικιαστή μας, για να παρακολουθούμε τα στατιστικά συντονισμού του:

Δημιουργία Συντονιστή μέσω Χρήστη Ενοικιαστή cURL Παράδειγμα

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

Δομή Αιτήματος Δημιουργίας Συντονιστή

Copy

1

2interface ModeratorPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Δημιουργίας Συντονιστή

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

Αυτή η διαδρομή παρέχει τη δυνατότητα πρόσκλησης ενός μόνο Moderator.

Οι ακόλουθοι περιορισμοί υπάρχουν για την αποστολή email πρόσκλησης σε έναν Moderator:

• Ο Moderator πρέπει να υπάρχει ήδη.
• Το fromName δεν μπορεί να είναι μεγαλύτερο από 100 χαρακτήρες.

Σημειώσεις:

• Αν υπάρχει ήδη χρήστης με το παρεχόμενο email, θα προσκληθεί να συντονίσει τα σχόλια του ενοικιαστή σας.
• Αν δεν υπάρχει χρήστης με το παρεχόμενο email, ο σύνδεσμος πρόσκλησης θα τον καθοδηγήσει στη δημιουργία του λογαριασμού του.
• Η πρόσκληση θα λήξει μετά από 30 ημέρες.

Μπορούμε να δημιουργήσουμε έναν Moderator για έναν χρήστη για τον οποίο γνωρίζουμε μόνο το email:

Πρόσκληση Συντονιστή cURL Παράδειγμα

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

Αυτό θα στείλει ένα email όπως Ο Bob στο TenantName σας προσκαλεί να γίνετε συντονιστής...

Δομή Αιτήματος Πρόσκλησης Συντονιστή

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

Δομή Απάντησης Πρόσκλησης Συντονιστή

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

Αυτή η διαδρομή παρέχει την αφαίρεση ενός Moderator με βάση το id.

Αφαίρεση Συντονιστή cURL Παράδειγμα

Copy

1

2curl --request DELETE \

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

4

Δομή Αιτήματος Αφαίρεσης Συντονιστή

Copy

1

2interface ModeratorDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Αφαίρεσης Συντονιστή

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

Αυτή η διαδρομή επιστρέφει ένα μόνο NotificationCount με βάση το αναγνωριστικό χρήστη. Με SSO, το αναγνωριστικό χρήστη έχει τη μορφή <tenant id>:<user id>.

Αν δεν υπάρχουν μη αναγνωσμένες ειδοποιήσεις, δεν θα υπάρχει NotificationCount - οπότε θα λάβετε 404.

Αυτό διαφέρει από το notifications/count στο ότι είναι πολύ πιο γρήγορο, αλλά δεν επιτρέπει φιλτράρισμα.

NotificationCount Ανά ID cURL Παράδειγμα

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

Δομή Αιτήματος NotificationCount

Copy

1

2interface NotificationCountGetQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης 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

Αυτή η διαδρομή διαγράφει ένα μόνο NotificationCount με βάση το αναγνωριστικό χρήστη. Με SSO, το αναγνωριστικό χρήστη έχει τη μορφή <tenant id>:<user id>.

Αυτό θα καθαρίσει τον αριθμό μη αναγνωσμένων ειδοποιήσεων του χρήστη (το κόκκινο καμπανάκι στο widget σχολίων θα εξασθενίσει και ο αριθμός θα εξαφανιστεί).

DELETE NotificationCount cURL Παράδειγμα

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

Δομή Αιτήματος Αφαίρεσης NotificationCount

Copy

1

2interface NotificationCountDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Δομή Απάντησης Αφαίρεσης 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