API | FastComments Docs

Το API του FastComments

Το FastComments παρέχει ένα API για αλληλεπίδραση με πολλούς πόρους. Δημιουργήστε ενσωματώσεις με την πλατφόρμα μας, ή ακόμη και δημιουργήστε τους δικούς σας clients!

Σε αυτή την τεκμηρίωση, θα βρείτε όλους τους υποστηριζόμενους πόρους από το API τεκμηριωμένους με τους τύπους αιτήσεων και απαντήσεων τους.

Για πελάτες Enterprise, όλη η πρόσβαση στο API καταγράφεται στο Αρχείο Ελέγχου.

Παραγόμενα SDKs

Το FastComments πλέον δημιουργεί μια Περιγραφή API από τον κώδικά μας (αυτό δεν είναι ακόμη πλήρες, αλλά περιλαμβάνει πολλά APIs).

Έχουμε επίσης πλέον SDKs για δημοφιλείς γλώσσες:

Αυθεντικοποίηση

Το API αυθεντικοποιείται περνώντας το κλειδί API είτε ως X-API-KEY header είτε ως παράμετρο ερωτήματος API_KEY. Θα χρειαστείτε επίσης το tenantId σας για να κάνετε κλήσεις στο API. Αυτό μπορεί να ανακτηθεί από την ίδια σελίδα με το κλειδί API σας.

Σημείωση Ασφαλείας

Αυτές οι διαδρομές προορίζονται να κληθούν από έναν server. ΜΗΝ τις καλείτε από έναν περιηγητή. Κάνοντας κάτι τέτοιο θα εκθέσετε το κλειδί API σας - αυτό θα παρέχει πλήρη πρόσβαση στο λογαριασμό σας σε οποιονδήποτε μπορεί να δει τον πηγαίο κώδικα μιας σελίδας!

Επιλογή Αυθεντικοποίησης Πρώτη - Κεφαλίδες

Κεφαλίδα: X-API-KEY
Κεφαλίδα: X-TENANT-ID

Επιλογή Αυθεντικοποίησης Δεύτερη - Παράμετροι Ερωτήματος

Παράμετρος ερωτήματος: API_KEY
Παράμετρος ερωτήματος: tenantId

Πόροι API

Χρήση Πόρων

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

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

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

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

Σημείωση!

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

Συγκεντρώστε τα δεδομένα σας

Resource: Aggregate as GET /api/v1/aggregate Credit Cost: 1

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

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

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

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

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

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "operations": [
        { "op": "distinct", "field": "urlId", "alias": "urlId" },
        { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }
    ]
}'

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

Copy

{
    "status": "success",
    "data": [
        {
            "commenterEmail": {
                "distinctCounts": {
                    "someone@somewhere.com": 1,
                    "someone2@somewhere.com": 1
                }
            }
        },
        {
            "urlId": {
                "distinctCounts": {
                    "some-page": 2
                }
            }
        }
    ],
    "stats": { "scanned": 2 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "operations": [
        { "op": "countDistinct", "field": "urlId", "alias": "urlId" },
        { "op": "countDistinct", "field": "commenterEmail", "alias": "commenterEmail" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        {
            "commenterEmail": { "distinctCount": 2 },
            "urlId": { "distinctCount": 1 }
        }
    ],
    "stats": { "scanned": 2 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "operations": [
        { "op": "sum", "field": "votes", "alias": "votes" },
        { "op": "sum", "field": "votesUp", "alias": "votesUp" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        {
            "votes": { "numericValue": 2 },
            "votesUp": { "numericValue": 2 }
        }
    ],
    "stats": { "scanned": 2 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "operations": [
        { "op": "avg", "field": "votes", "alias": "votes" },
        { "op": "avg", "field": "votesUp", "alias": "votesUp" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        {
            "votes": { "numericValue": 1 },
            "votesUp": { "numericValue": 1 }
        }
    ],
    "stats": { "scanned": 2 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "operations": [
        { "op": "min", "field": "votes", "alias": "votes" },
        { "op": "min", "field": "votesUp", "alias": "votesUp" },
        { "op": "max", "field": "votes", "alias": "votes" },
        { "op": "max", "field": "votesUp", "alias": "votesUp" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        {
            "votes": { "numericValue": 0 },
            "votesUp": { "numericValue": 0 },
            "votes": { "numericValue": 2 },
            "votesUp": { "numericValue": 2 }
        }
    ],
    "stats": { "scanned": 2 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "operations": [
        { "op": "distinct", "field": "urlId", "alias": "urlId" },
        { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        {
            "commenterEmail": {
                "distinctCounts": {
                    "someone@somewhere.com": 1,
                    "someone2@somewhere.com": 1
                }
            },
            "urlId": {
                "distinctCounts": {
                    "some-page": 2
                }
            }
        }
    ],
    "stats": { "scanned": 2 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "groupBy": ["commenterName"],
    "query": [
        { "key": "approved", "value": true, "operator": "eq" },
        { "key": "commenterName", "value": "some-username-2", "operator": "eq" }
    ],
    "operations": [
        { "op": "sum", "field": "votes", "alias": "votes" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        {
            "groups": { "commenterName": "some-username-2" },
            "votes": { "numericValue": 2 }
        }
    ],
    "stats": { "scanned": 1 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "query": [
        { "key": "reviewed", "value": true, "operator": "not_eq" }
    ],
    "operations": [
        { "op": "count", "field": "id", "alias": "count" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        { "count": { "numericValue": 2 } }
    ],
    "stats": { "scanned": 2 }
}

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

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

Copy

curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{
    "resourceName": "Comment",
    "operations": [
        { "op": "distinct", "field": "approved", "alias": "approved" },
        { "op": "distinct", "field": "reviewed", "alias": "reviewed" },
        { "op": "distinct", "field": "isSpam", "alias": "isSpam" }
    ]
}'

Απάντηση:

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

Copy

{
    "status": "success",
    "data": [
        {
            "approved": { "distinctCounts": { "true": 2 } },
            "reviewed": { "distinctCounts": { "false": 2 } },
            "isSpam": { "distinctCounts": { "false": 2 } }
        }
    ],
    "stats": { "scanned": 2 }
}

Δομές

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

Copy

export type AggregationOpType = 'sum' | 'countDistinct' | 'distinct' | 'avg' | 'min' | 'max' | 'count';
/** An operation that will be applied on a field */
export interface AggregationOperation {
    /** The field to operate on */
    field: string;
    /** The type of operation */
    op: AggregationOpType;
    /** Optional alias for the output; if not provided, a default alias is computed */
    alias?: string;
    expandArray?: boolean;
}
export interface QueryPredicate {
    key: string
    value: string | number | boolean
    operator: 'eq' | 'not_eq' | 'greater_than' | 'less_than' | 'contains'
}
export interface AggregationRequest {
    query?: QueryPredicate[];
    resourceName: string;
    groupBy?: string[];
    operations: AggregationOperation[];
    sort?: {
        field: string;
        dir: 'asc' | 'desc';
    };
}
type DistinctAccumulator = Record<string, number>;
type GroupValues = Record<string, string>;
export type AggregationValue = {
    distinctCounts?: DistinctAccumulator
    distinctCount?: number
    numericValue?: number
    stringValue?: string
    groups?: GroupValues
};

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

Copy

export type AggregationItem = Record<string, AggregationValue> & { groups?: GroupValues };
export interface AggregationResponse {
    status: APIStatus,
    data: AggregationItem[];
    stats?: {
        scanned: number;
        timeMS: number;
    };
}

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

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

Δομή Αρχείου Καταγραφής Ελέγχου

Ένα AuditLog είναι ένα αντικείμενο που αντιπροσωπεύει ένα ελεγμένο συμβάν για tenants που έχουν πρόσβαση σε αυτή τη δυνατότητα.

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

Δομή AuditLog

Copy

interface AuditLog {
    id: string;
    userId?: string;
    username?: string;
    resourceName: string;
    crudType: 'c' | 'r' | 'u' | 'd' | 'login';
    from: string;
    url?: string;
    ip?: string;
    when: string;
    description?: string;
    serverStartDate: string;
    objectDetails?: object;
}

Το audit log είναι αμετάβλητο. Επίσης δεν μπορεί να γραφτεί χειροκίνητα. Μόνο το FastComments.com μπορεί να αποφασίσει πότε θα γράψει στο audit log. Ωστόσο, μπορείτε να το διαβάσετε μέσω αυτού του API.

Τα συμβάντα στο audit log λήγουν μετά από δύο χρόνια.

GET /api/v1/audit-logs

Resource: AuditLog as GET /api/v1/audit-logs Credit Cost: 10

Αυτό το 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

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

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

Copy

interface CommentsRequestQueryParams {
    tenantId: string
    API_KEY: string
    order?: 'ASC' | 'DESC'
    skip?: number
    before?: number
    after?: number
}

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

Copy

interface CommentsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    /** The logs! **/
    auditLogs: AuditLog[]
}

Δομή Σχολίου

Ένα αντικείμενο Comment αντιπροσωπεύει ένα σχόλιο που αφήνει ένας χρήστης.

Η σχέση μεταξύ γονικών και θυγατρικών σχολίων ορίζεται μέσω του parentId.

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

Δομή Comment

Copy

interface Comment {
    /** READONLY: Set to true if the spam engine determined the comment was spam. **/
    aiDeterminedSpam?: boolean
    /** Whether the comment is approved to show. Set to true when saving the comment, else it will be hidden. **/
    approved?: boolean
    /** The user's avatar. **/
    avatarSrc?: string
    /** Child comments. Not populated in all scenarios. Used when asTree is set to true via the API. **/
    children: Comment[]
    /** The commenter's raw comment. **/
    comment: string
    /** READONLY: The commenter's comment parsed into HTML. **/
    commentHTML?: string
    /** The commenter's email. Required if anonymous commenting is off. **/
    commenterEmail?: string
    /** The commenter's link (for example, their blog). **/
    commenterLink?: string
    /** The commenter's name. Always required. If not available, set to something like "Anonymous". **/
    commenterName: string
    /** The date the comment was left, in UTC epoch. **/
    date: number
    /** The "display label" for the comment - for example "Admin", "Moderator", or something like "VIP User". **/
    displayLabel?: string
    /** The domain the comment was posted on. **/
    domain?: string
    /** READONLY: The number of times the comment was flagged. **/
    flagCount?: number
    /** The #hashtags written in the comment that were successfully parsed. You can also manually add hashtags, for querying, but they won't display in the comment text automatically. **/
    hashTags?: CommentHashTag[]
    /** READONLY: Does the comment contain images? **/
    hasImages?: boolean
    /** READONLY: Does the comment contain links? **/
    hasLinks?: boolean
    /** READONLY: The unique comment id. **/
    id: string
    /** Only on create! This is hashed for storage. **/
    ip?: string
    /** READONLY: Did the current user block the user that wrote this comment? **/
    isBlocked?: boolean
    /** READONLY: Is the comment by an admin? Automatically set based on userId. **/
    isByAdmin?: boolean
    /** READONLY: Is the comment by a moderator? Automatically set based on userId. **/
    isByModerator?: boolean
    /** Set to true if the comment was soft deleted (placeholder had to be left due to some other configuration). **/
    isDeleted?: boolean
    /** Set to true if the user's account was deleted and the comment had to be retained. **/
    isDeletedUser?: boolean
    /** READONLY: Is the flagged by the currently logged-in user (contextUserId)? **/
    isFlagged?: boolean
    /** Is the comment pinned? **/
    isPinned?: boolean
    /** Is the comment locked for new replies (moderators still can reply)? **/
    isLocked?: boolean
    /** Is the comment spam? **/
    isSpam?: boolean
    /** READONLY: Is the comment voted down for the current user (contextUserId)? **/
    isVotedDown?: boolean
    /** READONLY: Is the comment voted up for the current user (contextUserId)? **/
    isVotedUp?: boolean
    /** The locale the comment is in. If not provided, will be derived from the language accept HTTP header. **/
    locale?: 'de_de' | 'en_us' | 'es_es' | 'fr_fr' | 'it_it' | 'ja_jp' | 'ko_kr' | 'pl_pl' | 'pt_br' | 'ru_ru' | 'tr_tr' | 'zh_cn' | 'zh_tw'
    /** READONLY: The @mentions written in the comment that were successfully parsed. **/
    mentions?: CommentUserMention[]
    /** Optional metadata associated with the comment. **/
    meta?: Record<string, string | number | boolean>
    /** The optional list of moderation group ids associated with this comment. **/
    moderationGroupIds?: string[]|null
    /** READONLY: The id of the vote object that corresponds to the vote from the current user (contextUserId) on this comment. **/
    myVoteId?: string
    /** Whether notifications were sent for this comment for commenters. To prevent notifications being sent on imports, set this to true. **/
    notificationSentForParent?: boolean
    /** Whether notifications were sent for this comment for tenant users. To prevent notifications being sent on imports, set this to true. **/
    notificationSentForParentTenant?: boolean
    /** The title of the page this comment was on. **/
    pageTitle?: string
    /** If we're replying to a comment, this is the ID that we are replying to. **/
    parentId?: string|null
    /** Whether the comment is marked reviewed. **/
    reviewed: boolean
    /** The tenant id where the comment belongs. **/
    tenantId: string
    /** The user that wrote the comment. Created automatically when saving a comment with a name/email. **/
    userId?: string|null
    /** The URL to the location that this comment is visible, like a blog post. **/
    url: string
    /** A "cleaned" version of the urlId you passed us. When saving, you specify this field, but when you fetch the comment back this will be "cleaned" and your original value moved to "urlIdRaw". **/
    urlId: string
    /** READONLY: The original urlId you passed us. **/
    urlIdRaw?: string
    /** Is the user and this comment verified? **/
    verified: boolean
    /** Number of votes up. **/
    votesUp?: number
    /** Number of votes down. **/
    votesDown?: number
    /** The "karma" of the comment (= votes up - votes down). **/
    votes?: number
}

Ορισμένα από αυτά τα πεδία είναι σημειωμένα ως READONLY - αυτά επιστρέφονται από το API αλλά δεν μπορούν να οριστούν.

Δομή Κειμένου Σχολίου

Τα σχόλια γράφονται σε μια FastComments εκδοχή του markdown, που είναι απλώς markdown συν παραδοσιακές ετικέτες στυλ bbcode για εικόνες, όπως [img]path[/img].

Το κείμενο αποθηκεύεται σε δύο πεδία. Το κείμενο που εισήγαγε ο χρήστης αποθηκεύεται αμετάβλητο στο πεδίο comment. Αυτό αναλύεται και αποθηκεύεται στο πεδίο commentHTML.

Οι επιτρεπόμενες HTML ετικέτες είναι b, u, i, strike, pre, span, code, img, a, strong, ul, ol, li, και br.

Συνιστάται να αναλύσετε το HTML, αφού είναι ένα πολύ μικρό υποσύνολο HTML, η κατασκευή ενός αναλυτή είναι αρκετά απλή. Υπάρχουν πολλαπλές βιβλιοθήκες για React Native και Flutter, για παράδειγμα, για να βοηθήσουν με αυτό

Μπορείτε να επιλέξετε να αναλύσετε τη μη κανονικοποιημένη τιμή του πεδίου comment. Ένα παράδειγμα αναλυτή είναι εδώ..

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

Tagging

Όταν οι χρήστες επισημαίνονται σε ένα σχόλιο, οι πληροφορίες αποθηκεύονται σε μια λίστα που ονομάζεται mentions. Κάθε αντικείμενο σε αυτή τη λίστα έχει την ακόλουθη δομή.

Το Αντικείμενο Mentions Σχολίου

Copy

Run

interface CommentUserMention {
    /** The user id. For SSO users, this will have your tenant id prefixed. **/
    id: string
    /** The final @mention tag text, including the @ symbol. **/
    tag: string
    /** The original @mention tag text, including the @ symbol. **/
    rawTag: string
    /** What type of user was tagged. user = FastComments.com account. sso = SSOUser. **/
    type: 'user'|'sso'
    /** If the user opts out of notifications, this will still be set to true. **/
    sent: boolean
}

HashTags

Όταν χρησιμοποιούνται hashtags και αναλύονται επιτυχώς, οι πληροφορίες αποθηκεύονται σε μια λίστα που ονομάζεται hashTags. Κάθε αντικείμενο σε αυτή τη λίστα έχει την ακόλουθη δομή. Τα Hashtags μπορούν επίσης να προστεθούν χειροκίνητα στον πίνακα hashTags του σχολίου για αναζήτηση, αν οριστεί retain.

Το Αντικείμενο HashTag Σχολίου

Copy

Run

interface CommentHashTag {
    /** The hashtag id. **/
    id: string
    /** The final #hashtag tag text, including the # symbol. **/
    tag: string
    /** If the hashtag is associated with a custom URL, this will be defined. **/
    url?: string
    /** If we should retain the hashtag, even if it does not exist in the comment text, when the comment is updated. Useful for tagging comments without changing comment text. **/
    retain?: boolean
}

GET /api/v1/comments

Resource: Comment as GET /api/v1/comments Credit Cost: 1

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

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

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

Ταχύτερη: Προϋπολογισμένη Σελιδοποίηση:
1. Έτσι λειτουργεί το FastComments όταν χρησιμοποιείτε τα προκατασκευασμένα widgets και clients μας.
2. Κάνοντας κλικ στο "επόμενο" απλά αυξάνει τον αριθμό σελίδας.
3. Μπορείτε να το σκεφτείτε ως ανάκτηση από ένα key-value store.
4. Με αυτόν τον τρόπο, απλά ορίστε μια παράμετρο page ξεκινώντας από 0 και μια κατεύθυνση ταξινόμησης ως direction.
5. Τα μεγέθη σελίδων μπορούν να προσαρμοστούν μέσω κανόνων προσαρμογής.
Πιο Ευέλικτη: Ευέλικτη Σελιδοποίηση:
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

Όταν χρησιμοποιείτε Προϋπολογισμένη Σελιδοποίηση, τα σχόλια ομαδοποιούνται ανά σελίδα και τα σχόλια σε threads επηρεάζουν τη συνολική σελίδα.
1. Με αυτόν τον τρόπο, τα threads μπορούν να καθοριστούν στον client βάσει του parentId.
2. Για παράδειγμα, με μια σελίδα με ένα σχόλιο κορυφαίου επιπέδου, και 29 απαντήσεις, και ρυθμίζοντας page=0 στο API - θα πάρετε μόνο το σχόλιο κορυφαίου επιπέδου και τα 29 παιδιά.
3. Παράδειγμα εικόνας εδώ που απεικονίζει πολλαπλές σελίδες.
Όταν χρησιμοποιείτε Ευέλικτη Σελιδοποίηση, μπορείτε να ορίσετε μια παράμετρο parentId.
1. Ορίστε αυτό σε null για να πάρετε μόνο σχόλια κορυφαίου επιπέδου.
2. Στη συνέχεια για να δείτε threads, καλέστε ξανά το API και περάστε parentId.
3. Μια συνηθισμένη λύση είναι να κάνετε μια κλήση API για τα σχόλια κορυφαίου επιπέδου και στη συνέχεια να κάνετε παράλληλες κλήσεις API για να πάρετε σχόλια για τα παιδιά κάθε σχολίου.
ΝΕΟ από Φεβ 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

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

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

Copy

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

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

Copy

curl --request GET \
  --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'

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

Copy

curl --request GET \
  --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'

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

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

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

Copy

curl --request GET \
  --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'

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

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

Copy

curl --request GET \
  --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'

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

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

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

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

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

Copy

curl --request GET \
  --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'

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

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

Copy

interface CommentsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** The urlId (page url, or article id) the comments are associated with. **/
    urlId?: string
    /** Limit the comments returned by this user. **/
    userId?: string
    /** Use this to search by hashtag. To drill down to the intersection of multiple hashtags, do &hashTag=a&hashTag=b. **/
    hashTag?: string
    /** The sort direction. Default is MR (Most Relevant). Other options are OF (Oldest First) and NF (Newest First). **/
    direction?: 'MR' | 'OF' | 'NF'
    /** Precalculated Pagination: The page to fetch, starting with 0. Pass -1 for all comments (up to 250). **/
    page?: number
    /** Flexible Pagination: How many comments should we return? **/
    limit?: number
    /** Flexible Pagination: How many child comments should we return for each parent? **/
    limitChildren?: number
    /** Flexible Pagination: How many comments should we skip? **/
    skip?: number
    /** Flexible Pagination: How many child comments should we skip for each parent? **/
    skipChildren?: number
    /** For determining blocked and flagged comments. **/
    contextUserId?: string
    /** For determining blocked and flagged comments. **/
    anonUserId?: string
    /** For fetching child comments. **/
    parentId?: string
    /** For fetching as a tree. **/
    asTree?: boolean
    /** How far into the tree should we return data? 0 returns no children. 1 returns immediate children, etc. **/
    maxTreeDepth?: number
}

Η Απάντηση

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

Copy

interface CommentsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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'
    /** Included on failure. **/
    reason?: string
    /** The comments! **/
    comments: Comment[]
}

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

URL ID

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

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

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

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

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

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

GET /api/v1/comments/:id

Resource: Comment as GET /api/v1/comments/:id Credit Cost: 1

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

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

Copy

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

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

Copy

interface CommentsGetByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface CommentGetByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'missing-id'
    /** Included on failure. **/
    reason?: string
    /** The comment! **/
    comment?: Comment
}

POST /api/v1/comments

Resource: Comment as POST /api/v1/comments Credit Cost: 1

Αυτό το 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

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true' \
  --header 'Content-Type: application/json' \
  --data '{
    "approved": true,
    "comment": "some-comment",
    "commenterName": "some-commenter-name",
    "date": 1622644382148,
    "urlId": "some-place",
    "url": "https://exmaple.com/some-page",
    "verified": true
}'

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true&doSpamCheck=true' \
  --header 'Content-Type: application/json' \
  --data '{
    "approved": true,
    "avatarSrc": "https://static.fastcomments.com/1605337537848-DSC_0841.JPG",
    "comment": "some-comment",
    "commenterName": "some-commenter-name",
    "commenterEmail": "fordperfect@spaceship.com",
    "date": 1622644382148,
    "isSpam": false,
    "locale": "en_us",
    "notificationSentForParent": true,
    "notificationSentForParentTenant": true,
    "reviewed": true,
    "urlId": "some-place",
    "url": "https://exmaple.com/some-page",
    "verified": true,
    "votes": 1,
    "votesUp": 2,
    "votesDown": 1,
    "ip": "123.456.789.000"
}'

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

Copy

interface CommentPostQueryParams {
    tenantId: string
    API_KEY: string
    doSpamCheck?: 'true' | 'false'
    /** 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. **/
    isLive?: 'true' | 'false'
    sendEmails?: 'true' | 'false'
    populateNotifications?: 'true' | 'false'
}

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

Copy

interface CommentPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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';
    /** Included on failure. **/
    reason?: string
    /** The created comment. **/
    comment?: Comment
    /** The associated user, which may or may not have already existed. **/
    user?: User
}

PATCH /api/v1/comments/:id

Resource: Comment as PATCH /api/v1/comments/:id Credit Cost: 1

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

Σημειώσεις:

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

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "some-new-comment-text"
}'

Δομή Αιτήματος Ενημέρωσης Σχολίου PATCH

Copy

interface CommentPatchQueryParams {
    tenantId: string
    API_KEY: string
    /** The user doing the update. If desired can be used to check that they can edit the comment.  **/
    contextUserId?: string
    /** Should we check if the new comment looks like spam?  **/
    doSpamCheck?: 'true' | 'false'
    /** 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. **/
    isLive?: 'true' | 'false'
}

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

Copy

interface CommentPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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'
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/comments/:id

Resource: Comment as DELETE /api/v1/comments/:id Credit Cost: 1

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

Σημειώσεις:

Αυτό το API μπορεί να ενημερώσει το comment widget "live" αν επιθυμείτε (αυτό αυξάνει το creditsCost από 1 σε 2).
Αυτό το API θα διαγράψει όλα τα θυγατρικά σχόλια.

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json'

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

Copy

interface CommentDeleteQueryParams {
    tenantId: string
    API_KEY: string
    /** The user doing the update. If desired can be used to check that they can delete the comment.  **/
    contextUserId?: string
    /** 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. **/
    isLive?: 'true' | 'false'
}

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

Copy

interface CommentDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

POST /api/v1/comments/:id/flag

Resource: Comment as POST /api/v1/comments/:id/flag Credit Cost: 1

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

Σημειώσεις:

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
  --header 'Content-Type: application/json'

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
  --header 'Content-Type: application/json'

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

Copy

interface CommentFlagQueryParams {
    tenantId: string
    API_KEY: string
    userId?: string
    anonUserId?: string
}

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

Copy

interface CommentFlagResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'
    /** Included on failure. **/
    reason?: string
    /** Was the comment un-approved (hidden) due to being flagged too many times? **/
    wasUnapproved?: boolean;
}

POST /api/v1/comments/:id/un-flag

Resource: Comment as POST /api/v1/comments/:id/un-flag Credit Cost: 1

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

Σημειώσεις:

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
  --header 'Content-Type: application/json'

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
  --header 'Content-Type: application/json'

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

Copy

interface CommentFlagQueryParams {
    tenantId: string
    API_KEY: string
    userId?: string
    anonUserId?: string
}

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

Copy

interface CommentUnFlagResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'
    /** Included on failure. **/
    reason?: string
}

POST /api/v1/comments/:id/block

Resource: Comment as POST /api/v1/comments/:id/block Credit Cost: 1

Αυτό το 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

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/block?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
  --header 'Content-Type: application/json'

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
  --header 'Content-Type: application/json'

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

Copy

interface CommentBlockQueryParams {
    tenantId: string
    API_KEY: string
    userId?: string
    anonUserId?: string
    commentIdsToCheck?: string[]
}

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

Copy

interface CommentBlockResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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'
    /** Included on failure. **/
    reason?: string
    /** If commentIdsToCheck is defined, entries in this map with true are also blocked. **/
    commentStatuses?: Record<string, boolean>;
}

POST /api/v1/comments/:id/un-block

Resource: Comment as POST /api/v1/comments/:id/un-block Credit Cost: 1

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

Σημειώσεις:

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \
  --header 'Content-Type: application/json'

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \
  --header 'Content-Type: application/json'

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

Copy

interface CommentUnBlockQueryParams {
    tenantId: string
    API_KEY: string
    userId?: string
    anonUserId?: string
    commentIdsToCheck?: string[]
}

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

Copy

interface CommentUnBlockResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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'
    /** Included on failure. **/
    reason?: string
    /** 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. **/
    commentStatuses?: Record<string, boolean>;
}

Δομή Προτύπου Email

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

Το σύστημα θα επιλέξει το πρότυπο email προς χρήση μέσω:

Του αναγνωριστικού τύπου, το ονομάζουμε emailTemplateId. Αυτές είναι σταθερές.
Το domain. Πρώτα θα προσπαθήσουμε να βρούμε ένα πρότυπο για το domain στο οποίο σχετίζεται το αντικείμενο (όπως ένα Comment), και αν δεν βρεθεί αντιστοιχία τότε θα προσπαθήσουμε να βρούμε ένα πρότυπο όπου το domain είναι null ή *.

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

Δομή Προτύπου Email

Copy

interface EmailTemplate {
    id: string
    tenantId: string
    emailTemplateId: string
    displayName: string
    /** READONLY **/
    createdAt: string
    /** READONLY **/
    updatedAt: string
    /** READONLY **/
    updatedByUserId: string
    /** The domain the template should be associated with. **/
    domain?: string | '*' | null
    /** The email template content in EJS syntax. **/
    ejs: string
    /** A map of overridden translation keys to values, for each supported locale. **/
    translationOverridesByLocale: Record<string, Record<string, string>>
    /** An object that represents the render context of the template. **/
    testData: object
}

Σημειώσεις

Μπορείτε να λάβετε τις έγκυρες τιμές emailTemplateId από το endpoint /definitions.
Το endpoint /definitions περιλαμβάνει επίσης τις προεπιλεγμένες μεταφράσεις και δεδομένα δοκιμής.
Τα πρότυπα θα αποτύχουν να αποθηκευτούν με μη έγκυρη δομή ή δεδομένα δοκιμής.

GET /api/v1/email-templates/:id

Resource: EmailTemplate as GET /api/v1/email-templates/:id Credit Cost: 1

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

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

Copy

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

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

Copy

interface EmailTemplatesByIdRequestQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface EmailTemplateResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
    /** Included on failure. **/
    reason?: string
    emailTemplate?: EmailTemplate | null
}

GET /api/v1/email-templates

Resource: EmailTemplate as GET /api/v1/email-templates Credit Cost: 1

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

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

Copy

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

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

Copy

interface EmailTemplatesRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** The page to fetch, starting with 0. **/
    page: number
}

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

Copy

interface EmailTemplatesResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    emailTemplates: EmailTemplate[]
}

PATCH /api/v1/email-templates/:id

Resource: EmailTemplate as PATCH /api/v1/email-templates/:id Credit Cost: 1

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

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

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

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/email-templates/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "displayName": "Some New Name",
}'

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

Copy

interface EmailTemplatePatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface EmailTemplatePatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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';
    /** Included on failure. **/
    reason?: string
    /** The updated email template. **/
    emailTemplate?: EmailTemplate
}

POST /api/v1/email-templates

Resource: EmailTemplate as POST /api/v1/email-templates Credit Cost: 1

Αυτό το 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

curl --request POST \
  --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "emailTemplateId": "comment-user-mention",
    "displayName": "I'm a custom template.",
    "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."
}'

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/email-templates?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "emailTemplateId": "comment-user-mention",
    "displayName": "I'm a custom template.",
    "ejs": "This is some email content!",
    "domain": "somespecificsite.com",
}'

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

Copy

interface EmailTemplatePostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface EmailTemplatePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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';
    /** Included on failure. **/
    reason?: string
    /** The created template. **/
    emailTemplate?: EmailTemplate
}

POST /api/v1/email-templates/render

Resource: EmailTemplate as POST /api/v1/email-templates/render Credit Cost: 1

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/email-templates/render?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "emailTemplateId": "comment-user-mention",
    "displayName": "I'm a custom template.",
    "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."
}'

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

Copy

interface EmailTemplatePostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface EmailTemplatePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'does-not-render';
    /** Included on failure. **/
    reason?: string
    /** The rendered HTML on success. **/
    html?: string
}

DELETE /api/v1/email-templates/:id

Resource: EmailTemplate as DELETE /api/v1/email-templates/:id Credit Cost: 1

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

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

Copy

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

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

Copy

interface EmailTemplateRequestQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface EmailTemplateDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'
    /** Included on failure. **/
    reason?: string
}

Δομή Hashtag

Ένα αντικείμενο HashTag αντιπροσωπεύει ένα tag που μπορεί να αφεθεί από έναν χρήστη. Τα HashTags μπορούν να χρησιμοποιηθούν για σύνδεση με εξωτερικό περιεχόμενο ή για σύνδεση σχετικών σχολίων μεταξύ τους.

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

Δομή HashTag

Copy

interface HashTag {
    /** Should start with the "#" or desired character. **/
    tag: string
    /** An optional URL that the hashtag can point to. Instead of filtering comments by hashtag, the UI will redirect to this upon click. **/
    url?: string
    /** READONLY **/
    createdAt: string
}

Σημειώσεις:

Σε ορισμένα API endpoints θα δείτε ότι το hashtag χρησιμοποιείται στο URL. Θυμηθείτε να κωδικοποιήσετε τις τιμές URI. Για παράδειγμα, το # θα πρέπει αντ' αυτού να αναπαρίσταται ως %23.
Ορισμένα από αυτά τα πεδία είναι επισημασμένα ως READONLY - αυτά επιστρέφονται από το API αλλά δεν μπορούν να οριστούν.

GET /api/v1/hash-tags

Resource: HashTag as GET /api/v1/hash-tags Credit Cost: 1

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

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

Copy

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

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

Copy

interface HashTagsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** The page to fetch, starting with 0. **/
    page: number
}

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

Copy

interface HashTagsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    /** The hashtags! **/
    hashTags: HashTag[]
}

PATCH /api/v1/hash-tags/:tag

Resource: HashTag as PATCH /api/v1/hash-tags/:tag Credit Cost: 1

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

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/hash-tags/%23example_hash_tag?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/some-`page`"
}'

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

Copy

interface HashTagPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Ενημέρωσης HashTag

Copy

interface HashTagPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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'
    /** Included on failure. **/
    reason?: string
    hashTag?: HashTag; // We return the complete updated hashtag on success.
}

POST /api/v1/hash-tags

Resource: HashTag as POST /api/v1/hash-tags Credit Cost: 1

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/hash-tags?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "tag": "#example",
    "url": "https://example.com/some-page"
}'

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

Copy

interface HashTagPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface HashTagPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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'
    /** Included on failure. **/
    reason?: string
    hashTag?: HashTag; // We return the complete created hashtag on success.
}

POST /api/v1/hash-tags/bulk

Resource: HashTag as POST /api/v1/hash-tags/bulk Credit Cost: 1

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

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/hash-tags/bulk?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "tags": [
        {
            "tag": "#example",
            "url": "https://example.com/some-page"
        }
    ]
}'

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

Copy

interface HashTagPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface HashTagBulkPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    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'
    /** Included on failure. **/
    reason?: string
    results?: HashTagPostResponse[]; // We return a list of HashTagPostResponse objects for each provided tag.
}

DELETE /api/v1/hash-tags/:tag

Resource: HashTag as DELETE /api/v1/hash-tags/:tag Credit Cost: 1

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

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

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

Copy

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

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

Copy

interface HashTagDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface HashTagDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist'
    /** Included on failure. **/
    reason?: string
}

Δομή Διαχειριστή

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

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

Χρήστες διαχειριστές που έχουν τη σημαία isCommentModeratorAdmin.
Χρήστες SSO με τη σημαία isCommentModeratorAdmin.
Κανονικοί σχολιαστές, ή χρήστες 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

interface Moderator {
    name: string
    email: string
    tenantId: string
    userId?: string|null
    acceptedInvite?: boolean
    markReviewedCount?: number
    deletedCount?: number
    markedSpamCount?: number
    approvedCount?: number
    editedCount?: number
    bannedCount?: number
    createdAt: string
    moderationGroupIds?: string[]|null
}

GET /api/v1/moderators/:id

Resource: Moderator as GET /api/v1/moderators/:id Credit Cost: 1

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

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

Copy

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

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

Copy

interface ModeratorByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface ModeratorByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
    moderator?: Moderator
}

GET /api/v1/moderators

Resource: Moderator as GET /api/v1/moderators Credit Cost: 1

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

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

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

Copy

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

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

Copy

interface ModeratorsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** The number of moderators to skip for pagination. **/
    skip?: number
}

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

Copy

interface ModeratorsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    moderators?: Moderator[]
}

PATCH /api/v1/moderators/:id

Resource: Moderator as PATCH /api/v1/moderators/:id Credit Cost: 1

Αυτό το 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

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some New Name",
}'

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

Copy

interface ModeratorPatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface ModeratorPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';
    /** Included on failure. **/
    reason?: string
}

POST /api/v1/moderators

Resource: Moderator as POST /api/v1/moderators Credit Cost: 1

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

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

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

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some Name",
    "email": "someone@someone.com"
}'

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some Name",
    "email": "someone@someone.com",
    "userId": "some-tenant-user-id"
}'

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

Copy

interface ModeratorPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface ModeratorPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
    moderator?: Moderator; // We return the complete created moderator on success.
}

POST /api/v1/moderators/:id/send-invite

Resource: Moderator as POST /api/v1/moderators/:id/send-invite Credit Cost: 10

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

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

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

Σημειώσεις:

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

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/moderators/xyz/send-invite?tenantId=demo&API_KEY=DEMO_API_SECRET&fromName=Bob' \
  --header 'Content-Type: application/json'

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

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

Copy

interface ModeratorSendInviteQueryParams {
    tenantId: string
    API_KEY: string
    /** The email sent to the user will appear to be sent from this name. **/
    fromName: string
}

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

Copy

interface ModeratorSendInviteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found | 'from-name-required' | 'from-name-invalid'
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/moderators/:id

Resource: Moderator as DELETE /api/v1/moderators/:id Credit Cost: 5

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

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

Copy

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

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

Copy

interface ModeratorDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface ModeratorDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

Δομή Αριθμού Ειδοποιήσεων

Ένα αντικείμενο NotificationCount αντιπροσωπεύει τον αριθμό μη αναγνωσμένων ειδοποιήσεων και τα μεταδεδομένα για έναν χρήστη.

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

Τα αντικείμενα NotificationCount δημιουργούνται αυτόματα και δεν μπορούν να δημιουργηθούν μέσω του API. Επίσης λήγουν μετά από ένα έτος.

Μπορείτε να καθαρίσετε τον αριθμό μη αναγνωσμένων ειδοποιήσεων ενός χρήστη διαγράφοντας το NotificationCount του.

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

Δομή NotificationCount

Copy

interface NotificationCount {
    id: string // user id
    count: number
    createdAt: string // date string
    expireAt: string // date string
}

GET /api/v1/notification-count/:user_id

Resource: NotificationCount as GET /api/v1/notification-count/:user_id Credit Cost: 1

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

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

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
# -> {"status":"success","data":{"count":1,"createdAt":"2023-03-06T18:45:01.726Z","expireAt":"2024-03-06T01:25:01.726Z","id":"example"}}

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

Copy

interface NotificationCountGetQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface NotificationCountGetResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
    /** Included on failure. **/
    reason?: string
    data?: NotificationCount
}

DELETE /api/v1/notification-count/:user_id

Resource: NotificationCount as DELETE /api/v1/notification-count/:user_id Credit Cost: 1

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

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

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
# -> {"status":"success"}

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

Copy

interface NotificationCountDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface NotificationCountDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

Δομή Ειδοποίησης

Ένα αντικείμενο Notification αντιπροσωπεύει μια ειδοποίηση για έναν χρήστη.

Τα αντικείμενα Notification δημιουργούνται αυτόματα και δεν μπορούν να δημιουργηθούν μέσω του API. Επίσης λήγουν μετά από ένα έτος. Οι ειδοποιήσεις δεν μπορούν να διαγραφούν. Μπορούν όμως να ενημερωθούν για να ορίσουν το viewed σε false, και μπορείτε να κάνετε ερώτημα με βάση το viewed.

Ένας χρήστης μπορεί επίσης να εξαιρεθεί από τις ειδοποιήσεις για ένα συγκεκριμένο σχόλιο ορίζοντας το optedOut στην ειδοποίηση σε true. Μπορείτε να συμμετάσχετε ξανά ορίζοντάς το σε false.

Υπάρχουν διαφορετικοί τύποι ειδοποιήσεων - ελέγξτε τα relatedObjectType και type.

Οι τρόποι δημιουργίας ειδοποιήσεων είναι αρκετά ευέλικτοι και μπορούν να ενεργοποιηθούν από πολλά σενάρια (δείτε NotificationType).

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

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

Δομή Ειδοποίησης

Copy

enum NotificationObjectType {
    Comment = 0,
    Profile = 1,
    Tenant = 2
}
enum NotificationType {
    /** If someone replied to you. **/
    RepliedToMe = 0,
    /** If someone replied anywhere in a thread (even children of children) of a thread you commented on. **/
    RepliedTransientChild = 1,
    /** If your comment was up-voted. **/
    VotedMyComment = 2,
    /** If a new comment is left on the root of a page you're subscribed to. **/
    SubscriptionReplyRoot = 3,
    /** If someone commented on your profile. **/
    CommentedOnProfile = 4,
    /** If you have a DM. **/
    DirectMessage = 5,
    /** TrialLimits is for tenant users only. **/
    TrialLimits = 6,
    /** If you were @mentioned. **/
    Mentioned = 7
}
interface Notification {
    id: string
    tenantId: string
    /** With SSO, the user id is in the format `<tenant id>:<user id>`. **/
    userId?: string
    /** When working with SSO, you only have to worry about `userId`. **/
    anonUserId?: string
    /** urlId is almost always defined. It is only optional for tenant-level notifications, which are infrequent. **/
    urlId?: string
    /** URL is cached for quick navigation to the source of the notification. **/
    url?: string
    /** Page Title is cached for quick reading of notification source. **/
    pageTitle?: string
    relatedObjectType: NotificationObjectType
    /** For example, comment id. **/
    relatedObjectId: string
    viewed: boolean
    createdAt: string // date string
    type: NotificationType
    fromCommentId?: string
    fromVoteId?: string
    /** fromUserName and fromUserAvatarSrc are cached here for quick displaying of the notification. They are updated when the user is updated. **/
    fromUserName: string
    fromUserId: string
    fromUserAvatarSrc?: string
    /** Set this to true to stop getting notifications for this object. **/
    optedOut?: boolean
}

GET /api/v1/notifications

Resource: Notification as GET /api/v1/notifications Credit Cost: 1

Αυτή η διαδρομή επιστρέφει έως 30 αντικείμενα Notification ταξινομημένα κατά createdAt, με τα πιο πρόσφατα πρώτα.

Μπορείτε να φιλτράρετε κατά userId. Με SSO, το αναγνωριστικό χρήστη έχει τη μορφή <tenant id>:<user id>.

Μη Αναγνωσμένες Ειδοποιήσεις Για Χρήστη cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/notifications?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false'

Δομή Αιτήματος Ειδοποιήσεων

Copy

interface NotificationsGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Paginate by skipping records. **/
    skip?: number
    /** Filter by user. **/
    userId?: string
    /** Filter by urlId. **/
    urlId?: string
    /** Filter by source comment. **/
    fromCommentId?: string
    /** Filter by read/unread. **/
    viewed?: 'true' | 'false'
    /** Filter by type. **/
    type?: NotificationType
}

Δομή Απάντησης Ειδοποιήσεων

Copy

interface NotificationsGetResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
    notifications?: Notification[]
}

GET /api/v1/notifications/count

Resource: Notification as GET /api/v1/notifications/count Credit Cost: 2

Αυτή η διαδρομή επιστρέφει ένα αντικείμενο που περιέχει τον αριθμό ειδοποιήσεων σε μια παράμετρο count.

Είναι πιο αργή από την /notification-count/ και διπλάσιου κόστους πιστώσεων, αλλά επιτρέπει φιλτράρισμα σε περισσότερες διαστάσεις.

Μπορείτε να φιλτράρετε με τις ίδιες παραμέτρους όπως το endpoint /notifications όπως το userId. Με SSO, το αναγνωριστικό χρήστη έχει τη μορφή <tenant id>:<user id>.

Αριθμός Μη Αναγνωσμένων Ειδοποιήσεων Για Χρήστη cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/notifications/count?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false'

Αριθμός Μη Αναγνωσμένων Ειδοποιήσεων Για Χρήστη Για Συγκεκριμένη Σελίδα cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/notifications/count?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false&urlId=some-article-id-or-url'

Δομή Αιτήματος Αριθμού Ειδοποιήσεων

Copy

interface NotificationCountGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Filter by user. **/
    userId?: string
    /** Filter by urlId. **/
    urlId?: string
    /** Filter by source comment. **/
    fromCommentId?: string
    /** Filter by read/unread. **/
    viewed?: 'true' | 'false'
    /** Filter by type. **/
    type?: NotificationType
}

Δομή Απάντησης Αριθμού Ειδοποιήσεων

Copy

interface NotificationCountGetResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
    count?: number
}

PATCH /api/v1/notifications/:id

Resource: Notification as PATCH /api/v1/notifications/:id Credit Cost: 1

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

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

Μπορείτε να ενημερώσετε μόνο τα ακόλουθα πεδία:
- viewed
- optedOut

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/notifications/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "viewed": false,
}'

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

Copy

interface NotificationPatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface NotificationPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';
    /** Included on failure. **/
    reason?: string
}

Δομή Σελίδας

Ένα αντικείμενο Page αντιπροσωπεύει τη σελίδα στην οποία μπορούν να ανήκουν πολλά σχόλια. Αυτή η σχέση ορίζεται από το urlId.

Μια Page αποθηκεύει πληροφορίες όπως ο τίτλος σελίδας, ο αριθμός σχολίων και το urlId.

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

Δομή Σελίδας

Copy

interface Page {
    id: string
    urlId: string
    url: string
    title?: string
    createdAt: string
    commentCount: number
    rootCommentCount: number
    /** Setting this to null means all SSO users can see the page. An empty list means it is closed to all users. **/
    accessibleByGroupIds?: string[] | null
    /** Is this page closed for new comments? **/
    isClosed?: boolean
}

GET /api/v1/pages

Resource: Page as GET /api/v1/pages Credit Cost: 10

Αυτή τη στιγμή μπορείτε να ανακτήσετε μόνο όλες τις σελίδες (ή μια μόνο σελίδα μέσω /by-url-id) που σχετίζονται με τον λογαριασμό σας. Αν θέλετε πιο λεπτομερή αναζήτηση, επικοινωνήστε μαζί μας.

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/pages?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface PagesRequestQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface PagesResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    pages: Page[]
}

Χρήσιμη Συμβουλή

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

GET /api/v1/pages/by-url-id

Resource: Page as GET /api/v1/pages/by-url-id Credit Cost: 1

Μεμονωμένες σελίδες μπορούν να ανακτηθούν με βάση το αντίστοιχο urlId. Αυτό μπορεί να είναι χρήσιμο για αναζήτηση τίτλων σελίδων ή αριθμών σχολίων.

Σελίδα ανά URL ID cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/pages/by-url-id?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=example-id-or-url'

Δομή Αιτήματος Σελίδας Ανά URL ID

Copy

interface PagesRequestQueryParams {
    tenantId: string
    API_KEY: string
    urlId: string
}

Δομή Απάντησης Σελίδας ανά URL ID

Copy

interface PagesResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
    /** Included on failure. **/
    reason?: string
    page?: Page[] | null
}

Χρήσιμη Συμβουλή

Θυμηθείτε να κωδικοποιήσετε URI τιμές όπως το urlId.

PATCH /api/v1/pages/:id

Resource: Page as PATCH /api/v1/pages/:id Credit Cost: 1

Αυτή η διαδρομή παρέχει τη δυνατότητα ενημέρωσης μιας μόνο Page. Τα αντίστοιχα σχόλια θα ενημερωθούν.

Ενημέρωση Σελίδας cURL Παράδειγμα

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/pages/my-page-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/some-page"
}'

Δομή Αιτήματος Ενημέρωσης Σελίδας

Copy

interface PagePatchQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Ενημέρωσης Σελίδας

Copy

interface PagePatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-id' | 'page-does-not-exist' | 'empty-request' | 'internal' | 'invalid-input' | 'invalid-title' | 'extra-params' | 'accessible-by-group-ids-not-array' | 'too-many-group-ids' | 'group-id-too-large'
    /** Included on failure. **/
    reason?: string
    user?: Page; // We return the complete updated page on success.
}

Σημείωση

Ορισμένες παράμετροι στο αντικείμενο Page ενημερώνονται αυτόματα. Αυτές είναι τα χαρακτηριστικά μετρητών και τίτλου. Οι μετρητές δεν μπορούν να ενημερωθούν μέσω του API καθώς είναι υπολογισμένες τιμές. Ο title της σελίδας μπορεί να οριστεί μέσω του API, αλλά θα αντικατασταθεί αν το widget σχολίων χρησιμοποιηθεί σε μια σελίδα με το ίδιο urlId και διαφορετικό τίτλο σελίδας.

POST /api/v1/pages

Resource: Page as POST /api/v1/pages Credit Cost: 1

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

Μια συνήθης περίπτωση χρήσης είναι ο έλεγχος πρόσβασης.

Σημειώσεις:

Αν έχετε σχολιάσει σε ένα νήμα σχολίων, ή έχετε καλέσει το API για να δημιουργήσετε ένα Comment, έχετε ήδη δημιουργήσει ένα αντικείμενο Page! Μπορείτε να δοκιμάσετε να το ανακτήσετε μέσω της διαδρομής Page /by-url-id, περνώντας το ίδιο urlId που περάσατε στο widget σχολίων.
Η δομή Page περιέχει ορισμένες υπολογισμένες τιμές. Αυτή τη στιγμή, αυτές είναι commentCount και rootCommentCount. Συμπληρώνονται αυτόματα και δεν μπορούν να οριστούν από το API. Η προσπάθεια να το κάνετε θα προκαλέσει το API να επιστρέψει σφάλμα.

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/pages?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Test Page",
    "url": "some0-url",
    "urlId": "page2",
    "accessibleByGroupIds": ["SOME_GROUP_ID"]
}'

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

Copy

interface PagePostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface PagePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-request' | 'internal' | 'invalid-input' | 'invalid-title' | 'extra-params' | 'accessible-by-group-ids-not-array' | 'too-many-group-ids' | 'group-id-too-large';
    /** Included on failure. **/
    reason?: string
    /** The created page. **/
    page?: Page
}

DELETE /api/v1/pages/:id

Resource: Page as DELETE /api/v1/pages/:id Credit Cost: 1

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

Σημειώστε ότι η αλληλεπίδραση με το widget σχολίων για μια σελίδα με το ίδιο urlId θα αναδημιουργήσει απλά τη Page απρόσκοπτα.

Αφαίρεση Σελίδας cURL Παράδειγμα

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/pages/some-page-id?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface PageDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface PageDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'page-does-not-exist'
    /** Included on failure. **/
    reason?: string
}

Δομή Εκκρεμούς Συμβάντος Webhook

Ένα αντικείμενο PendingWebhookEvent αντιπροσωπεύει ένα γεγονός webhook στην ουρά που εκκρεμεί.

Τα αντικείμενα PendingWebhookEvent δημιουργούνται αυτόματα και δεν μπορούν να δημιουργηθούν χειροκίνητα μέσω του API. Επίσης λήγουν μετά από ένα έτος. Μπορούν να διαγραφούν, πράγμα που αφαιρεί την εργασία από την ουρά.

Υπάρχουν διαφορετικοί τύποι γεγονότων - ελέγξτε τα eventType (OutboundSyncEventType) και type (OutboundSyncType).

Μια συνήθης περίπτωση χρήσης για αυτό το API είναι η υλοποίηση προσαρμοσμένης παρακολούθησης. Μπορεί να θέλετε να καλείτε το endpoint /count περιοδικά για να ελέγχετε τον εκκρεμή αριθμό για δεδομένα φίλτρα.

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

Δομή PendingWebhookEvent

Copy

enum OutboundSyncEventType {
    Create: 0,
    Delete: 1,
    Update: 2
}
enum OutboundSyncType {
    /** WordPress-specific sync task. **/
    WP: 0,
    Webhook: 1
}
interface PendingWebhookEvent {
    id: string
    /** The comment id associated with the event. **/
    commentId: string
    /** The comment object for the event at the time of the event. We started adding these in Nov 2023. **/
    comment: Comment
    /** An external id that may be associated with the comment. **/
    externalId: string | null
    createdAt: Date
    tenantId: string
    attemptCount: number
    /** Set before first attempt, and after every failure. **/
    nextAttemptAt: Date
    /** Whether this is a creation, deletion, or update event... **/
    eventType: OutboundSyncEventType
    /** The type of sync to perform (WordPress, call API, etc). **/
    type: OutboundSyncType
    /** The domain that matched the comment. We use this domain to pick the API key. **/
    domain: string
    /** The last error that occurred. This type is untyped and is a "dump" of whatever happened. Usually it contains an object with statusCode, body, and a headers map. **/
    lastError: object | null
}

GET /api/v1/pending-webhook-events

Resource: PendingWebhookEvent as GET /api/v1/pending-webhook-events Credit Cost: 2

Αυτή η διαδρομή επιστρέφει μια λίστα εκκρεμών γεγονότων webhook σε μια παράμετρο pendingWebhookEvents.

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/pending-webhook-events?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface PendingWebhookEventsGetQueryParams {
    tenantId: string
    API_KEY: string
    commentId?: string
    externalId?: string
    eventType?: OutboundSyncEventType
    type?: OutboundSyncType
    domain?: string
    /** Query for events with an attempt count greater than the specified number. **/
    attemptCountGT?: number
}

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

Copy

interface PendingWebhookEventsGetResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
    pendingWebhookEvents?: PendingWebhookEvent[]
}

GET /api/v1/pending-webhook-events/count

Resource: PendingWebhookEvent as GET /api/v1/pending-webhook-events/count Credit Cost: 2

Αυτή η διαδρομή επιστρέφει ένα αντικείμενο που περιέχει τον αριθμό εκκρεμών γεγονότων webhook σε μια παράμετρο count.

Μπορείτε να φιλτράρετε με τις ίδιες παραμέτρους όπως το endpoint /pending-webhook-events

Αριθμός PendingWebhookEvent cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/pending-webhook-events/count?tenantId=demo&API_KEY=DEMO_API_SECRET'

Δομή Αιτήματος Αριθμού PendingWebhookEvent

Copy

interface PendingWebhookEventsCountQueryParams {
    tenantId: string
    API_KEY: string
    commentId?: string
    externalId?: string
    eventType?: OutboundSyncEventType
    type?: OutboundSyncType
    domain?: string
    /** Query for events with an attempt count greater than the specified number. **/
    attemptCountGT?: number
}

Δομή Απάντησης Αριθμού PendingWebhookEvent

Copy

interface PendingWebhookEventsCountResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
    count?: number
}

DELETE /api/v1/pending-webhook-events/:id

Resource: PendingWebhookEvent as DELETE /api/v1/pending-webhook-events/:id Credit Cost: 1

Αυτή η διαδρομή επιτρέπει τη διαγραφή ενός μόνο PendingWebhookEvent.

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

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/pending-webhook-events/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET'

Δομή Αιτήματος Διαγραφής PendingWebhookEvent

Copy

interface PendingWebhookEventDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Διαγραφής PendingWebhookEvent

Copy

interface PendingWebhookEventDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

Δομή Χρήστη SSO

Το FastComments παρέχει μια εύκολη στη χρήση λύση SSO. Η ενημέρωση των πληροφοριών ενός χρήστη με την ενσωμάτωση βασισμένη σε HMAC είναι τόσο απλή όσο η φόρτωση της σελίδας από τον χρήστη με ένα ενημερωμένο φορτίο.

Ωστόσο, μπορεί να είναι επιθυμητό να διαχειριστείτε έναν χρήστη εκτός αυτής της ροής, για να βελτιώσετε τη συνέπεια της εφαρμογής σας.

Το API SSO User παρέχει έναν τρόπο για CRUD αντικειμένων που ονομάζουμε SSOUsers. Αυτά τα αντικείμενα είναι διαφορετικά από τους κανονικούς Users και διατηρούνται χωριστά για ασφάλεια τύπου.

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

Δομή SSOUser

Copy

interface SSOUser {
    id: string
    username: string
    email?: string
    websiteUrl?: string
    signUpDate: number
    createdFromUrlId?: string
    loginCount?: number
    avatarSrc?: string
    optedInNotifications?: boolean
    optedInSubscriptionNotifications?: boolean
    displayLabel?: string
    displayName?: string
    isAccountOwner?: boolean // Admin permission - SSO users with this flag are billed as SSO Admins (separate from regular SSO users)
    isAdminAdmin?: boolean // Admin permission - SSO users with this flag are billed as SSO Admins (separate from regular SSO users)
    isCommentModeratorAdmin?: boolean // Moderator permission - SSO users with this flag are billed as SSO Moderators (separate from regular SSO users)
    /** If null, Access Control will not be applied to the user. If an empty list, this user will not be able to see any pages or @mention other users. **/
    groupIds?: string[] | null
    createdFromSimpleSSO?: boolean
    /** Don't let other users see this user's activity, including comments, on their profile. Default is true to provide secure profiles by default. **/
    isProfileActivityPrivate?: boolean
    /** Don't let other users leave comments on the user's profile, or see existing profile comments. Default false. **/
    isProfileCommentsPrivate?: boolean
    /** Don't let other users send direct messages to this user. Default false. **/
    isProfileDMDisabled?: boolean
    karma?: number
    /** Optional configuration for user badges. **/
    badgeConfig?: {
        /** Array of badge IDs to assign to the user. Limited to 30 badges. Order is respected. **/
        badgeIds: string[]
        /** If true, replaces all existing displayed badges with the provided ones. If false, adds to existing badges. **/
        override?: boolean
        /** If true, updates badge display properties from tenant configuration. **/
        update?: boolean
    }
}

Χρέωση για Χρήστες SSO

Οι χρήστες SSO χρεώνονται διαφορετικά με βάση τις σημαίες δικαιωμάτων τους:

Κανονικοί Χρήστες SSO: Χρήστες χωρίς δικαιώματα διαχειριστή ή συντονιστή χρεώνονται ως κανονικοί χρήστες SSO
Διαχειριστές SSO: Χρήστες με σημαίες isAccountOwner ή isAdminAdmin χρεώνονται ξεχωριστά ως Διαχειριστές SSO (ίδια τιμή με τους κανονικούς διαχειριστές ενοικιαστή)
Συντονιστές SSO: Χρήστες με σημαία isCommentModeratorAdmin χρεώνονται ξεχωριστά ως Συντονιστές SSO (ίδια τιμή με τους κανονικούς συντονιστές)

Σημαντικό: Για να αποφευχθεί η διπλή χρέωση, το σύστημα αφαιρεί αυτόματα τα διπλότυπα χρηστών SSO έναντι κανονικών χρηστών ενοικιαστή και συντονιστών με βάση τη διεύθυνση email. Αν ένας χρήστης SSO έχει το ίδιο email με έναν κανονικό χρήστη ενοικιαστή ή συντονιστή, δεν θα χρεωθεί δύο φορές.

Έλεγχος Πρόσβασης

Οι χρήστες μπορούν να χωριστούν σε ομάδες. Αυτό είναι για το πεδίο groupIds, και είναι προαιρετικό.

@Αναφορές

Από προεπιλογή οι @αναφορές θα χρησιμοποιούν το username για αναζήτηση άλλων χρηστών sso όταν πληκτρολογηθεί ο χαρακτήρας @. Αν χρησιμοποιείται το displayName, τότε τα αποτελέσματα που ταιριάζουν με το username θα αγνοηθούν όταν υπάρχει αντιστοιχία για το displayName, και τα αποτελέσματα αναζήτησης @αναφοράς θα χρησιμοποιούν το displayName.

Συνδρομές

Με το FastComments, οι χρήστες μπορούν να εγγραφούν σε μια σελίδα κάνοντας κλικ στο εικονίδιο καμπάνας στο widget σχολίων και κάνοντας κλικ στο Εγγραφή.

Με έναν κανονικό χρήστη, τους στέλνουμε emails ειδοποίησης με βάση τις ρυθμίσεις ειδοποιήσεων τους.

Με τους Χρήστες SSO, το χωρίζουμε αυτό για συμβατότητα προς τα πίσω. Οι χρήστες θα λαμβάνουν αυτά τα επιπλέον emails ειδοποίησης συνδρομής μόνο αν ορίσετε το optedInSubscriptionNotifications σε true.

Εμβλήματα

Μπορείτε να αναθέσετε εμβλήματα σε χρήστες SSO χρησιμοποιώντας την ιδιότητα badgeConfig. Τα εμβλήματα είναι οπτικοί δείκτες που εμφανίζονται δίπλα στο όνομα ενός χρήστη στα σχόλια.

badgeIds - Ένας πίνακας με IDs εμβλημάτων για ανάθεση στον χρήστη. Αυτά πρέπει να είναι έγκυρα IDs εμβλημάτων που δημιουργήθηκαν στον λογαριασμό FastComments σας. Περιορισμένο σε 30 εμβλήματα.
override - Αν είναι αληθές, όλα τα υπάρχοντα εμβλήματα που εμφανίζονται στα σχόλια θα αντικατασταθούν με τα παρεχόμενα. Αν είναι ψευδές ή παραλείπεται, τα παρεχόμενα εμβλήματα θα προστεθούν σε οποιαδήποτε υπάρχοντα εμβλήματα.
update - Αν είναι αληθές, οι ιδιότητες εμφάνισης εμβλήματος θα ενημερωθούν από τη διαμόρφωση ενοικιαστή όποτε ο χρήστης συνδέεται.

GET /api/v1/sso-users

Resource: SSOUser as GET /api/v1/sso-users Credit Cost: 10

Αυτή η διαδρομή επιστρέφει Χρήστες SSO σε σελίδες των 100. Η σελιδοποίηση παρέχεται από την παράμετρο skip. Οι χρήστες ταξινομούνται κατά signUpDate και id.

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/sso-users?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface SSOUsersRequestQueryParams {
    tenantId: string
    API_KEY: string
    skip?: number
}

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

Copy

interface SSOUsersResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    users: SSOUser[]
}

GET /api/v1/sso-users/by-id/:id

Resource: SSOUser as GET /api/v1/sso-users/by-id/:id Credit Cost: 1

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/sso-users/by-id/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface SSOUserRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface SSOUserByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
    /** Included on failure. **/
    reason?: string
    user: SSOUser
}

GET /api/v1/sso-users/by-email/:email

Resource: SSOUser as GET /api/v1/sso-users/by-email/:email Credit Cost: 1

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

SSOUser Ανά Email cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/sso-users/by-email/someone@somewhere.com?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface SSOUserRequestByEmailQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface SSOUserByEmailResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-email' | 'user-does-not-exist'
    /** Included on failure. **/
    reason?: string
    user: SSOUser
}

PATCH /api/v1/sso-users/:id

Resource: SSOUser as PATCH /api/v1/sso-users/:id Credit Cost: 1

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

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/sso-users/my-user-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "notfordperfect"
}'

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

Copy

interface SSOUserPatchQueryParams {
    tenantId: string
    API_KEY: string
    /** When email or username is changed, you can set this to true to also update the user's comments. This will double the credit cost. **/
    updateComments: 'true' | 'false'
}

Δομή Απάντησης Ενημέρωσης SSOUser

Copy

interface SSOUserPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-does-not-exist'
    /** Included on failure. **/
    reason?: string
    user?: SSOUser; // We return the complete updated user on success.
}

POST /api/v1/sso-users

Resource: SSOUser as POST /api/v1/sso-users Credit Cost: 1

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

Η προσπάθεια δημιουργίας δύο χρηστών με το ίδιο ID θα οδηγήσει σε σφάλμα.

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/sso-users?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "my-user-id",
    "username": "fordperfect",
    "displayName": "Ford Perfect",
    "email": "fordperfect@galaxy.com",
    "groupIds": ["some-optional-group-id"]
}'

Σε αυτό το παράδειγμα καθορίζουμε groupIds για έλεγχο πρόσβασης, αλλά αυτό είναι προαιρετικό.

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

Copy

interface SSOUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface SSOUserPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
    /** Included on failure. **/
    reason?: string
    user?: SSOUser; // We return the created user on success.
}

Σημείωση Ενσωμάτωσης

Τα δεδομένα που περνούν από το API μπορούν να αντικατασταθούν απλά περνώντας ένα διαφορετικό φορτίο SSO User HMAC. Για παράδειγμα, αν ορίσετε ένα username μέσω του API, αλλά μετά περάσετε ένα διαφορετικό μέσω της ροής SSO κατά τη φόρτωση σελίδας, θα ενημερώσουμε αυτόματα το username τους.

Δεν θα ενημερώσουμε παραμέτρους χρήστη σε αυτή τη ροή εκτός αν τις καθορίσετε ρητά ή τις ορίσετε σε null (όχι undefined).

PUT /api/v1/sso-users/:id

Resource: SSOUser as PUT /api/v1/sso-users Credit Cost: 1

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

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

Copy

curl --request PUT \
  --url 'https://fastcomments.com/api/v1/sso-users/my-user-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "fordperfect",
    "displayName": "Ford Perfect",
    "email": "fordperfect@galaxy.com",
    "groupIds": ["some-optional-group-id"]
}'

Σε αυτό το παράδειγμα καθορίζουμε groupIds για έλεγχο πρόσβασης, αλλά αυτό είναι προαιρετικό.

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

Copy

interface SSOUserPutQueryParams {
    tenantId: string
    API_KEY: string
    /** When email or username is changed, you can set this to true to also update the user's comments. This will double the credit cost. **/
    updateComments: 'true' | 'false'
}

Δομή Απάντησης Ενημέρωσης SSOUser

Copy

interface SSOUserPutResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
    /** Included on failure. **/
    reason?: string
    user?: SSOUser; // We return the update user on success.
}

DELETE /api/v1/sso-users/:id

Resource: SSOUser as DELETE /api/v1/sso-users/:id Credit Cost: 1

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

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

Η διαγραφή των σχολίων του χρήστη είναι δυνατή μέσω της παραμέτρου ερωτήματος deleteComments. Σημειώστε ότι αν αυτή είναι αληθής:

Όλα τα σχόλια του χρήστη θα διαγραφούν ζωντανά.
Όλα τα παιδικά (τώρα ορφανά) σχόλια θα διαγραφούν ή θα ανωνυμοποιηθούν με βάση τη διαμόρφωση της συσχετισμένης σελίδας κάθε σχολίου. Για παράδειγμα αν η λειτουργία διαγραφής νήματος είναι "ανωνυμοποίηση", τότε οι απαντήσεις θα παραμείνουν, και τα σχόλια του χρήστη θα ανωνυμοποιηθούν. Αυτό ισχύει μόνο όταν το commentDeleteMode είναι Remove (η προεπιλεγμένη τιμή).
Το creditsCost γίνεται 2.

Ανωνυμοποιημένα Σχόλια

Μπορείτε να διατηρήσετε τα σχόλια του χρήστη αλλά απλά να τα ανωνυμοποιήσετε ορίζοντας commentDeleteMode=1.

Αν τα σχόλια του χρήστη ανωνυμοποιηθούν τότε οι ακόλουθες τιμές ορίζονται σε null:

- commenterName
- commenterEmail
- avatarSrc
- userId
- anonUserId
- mentions
- badges

Τα isDeleted και isDeletedUser ορίζονται σε true.

Κατά την απόδοση, το widget σχολίων θα χρησιμοποιεί το DELETED_USER_PLACEHOLDER (προεπιλογή: "[deleted]") για το όνομα του χρήστη και το DELETED_CONTENT_PLACEHOLDER για το σχόλιο. Αυτά μπορούν να προσαρμοστούν μέσω του UI Προσαρμογής Widget.

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

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/sso-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

enum SSOUserCommentDeleteMode {
    Remove = 0, // default
    Anonymize = 1
}
interface SSOUsersDeleteQueryParams {
    tenantId: string
    API_KEY: string
    /** You can set this to true to also delete the user's comments. This will double the credit cost. **/
    deleteComments?: 'true' | 'false'
    /** You can set this as desired to determine how to handle the user's comments. **/
    commentDeleteMode?: SSOUserCommentDeleteMode
}

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

Copy

interface SSOUsersResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
    /** Included on failure. **/
    reason?: string
    user?: SSOUser; // We return the removed user on success.
}

Δομή Συνδρομής

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

Τα αντικείμενα Subscription δημιουργούνται όταν ένας χρήστης κάνει κλικ στο καμπανάκι ειδοποίησης στο widget σχολίων και κάνει κλικ στο "Εγγραφή σε αυτή τη σελίδα".

Οι συνδρομές μπορούν επίσης να δημιουργηθούν μέσω του API.

Η ύπαρξη ενός αντικειμένου Subscription προκαλεί τη δημιουργία αντικειμένων Notification, και την αποστολή emails, όταν νέα σχόλια αφήνονται στη ρίζα της σχετικής σελίδας για την οποία είναι η Subscription. Η αποστολή emails εξαρτάται από τον τύπο του χρήστη. Για κανονικούς χρήστες αυτό εξαρτάται από το optedInNotifications. Για Χρήστες SSO αυτό εξαρτάται από το optedInSubscriptionNotifications. Σημειώστε ότι ορισμένες εφαρμογές μπορεί να μην έχουν την έννοια μιας σελίδας προσβάσιμης από το web, οπότε απλά ορίστε το urlId στο id του στοιχείου στο οποίο εγγράφεστε (ίδια τιμή για το urlId που θα περνούσατε στο widget σχολίων).

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

Δομή Συνδρομής

Copy

interface Subscription {
    id: string
    tenantId: string
    /** With SSO, the user id is in the format `<tenant id>:<user id>`. **/
    userId: string
    anonUserId?: string
    urlId: string
    url?: string
    pageTitle?: string
    createdAt: string // date string
}

GET /api/v1/subscriptions/:id

Resource: Subscription as GET /api/v1/subscriptions Credit Cost: 1

Αυτή η διαδρομή επιστρέφει έως 30 αντικείμενα Subscription ταξινομημένα κατά createdAt, με τα πιο πρόσφατα πρώτα.

Μπορείτε να φιλτράρετε κατά userId. Με SSO, το αναγνωριστικό χρήστη έχει τη μορφή <tenant id>:<user id>.

Συνδρομές Για Χρήστη cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/subscriptions?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID'

Δομή Αιτήματος Συνδρομών

Copy

interface SubscriptionsGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Paginate by skipping records. **/
    skip?: number
    /** Filter by user. **/
    userId?: string
}

Δομή Απάντησης Συνδρομών

Copy

interface SubscriptionsGetResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
    subscriptions?: Subscription[]
}

POST /api/v1/subscriptions

Resource: Subscription as POST /api/v1/subscriptions Credit Cost: 1

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

Η δημιουργία μιας συνδρομής θα έχει ως αποτέλεσμα τη δημιουργία αντικειμένων Notification όταν ένα νέο σχόλιο αφήνεται στη ρίζα του συνδεδεμένου urlId (όταν το parentId του σχολίου είναι null).

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/subscriptions?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "userId": "tenantId:test-user-id",
    "urlId": "some-page-id-or-url",
    "url": "https://example.com/page",
    "pageTitle": "Some Example Page!"
}'

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

Copy

interface SubscriptionPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface SubscriptionPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/subscriptions/:id

Resource: Subscription as DELETE /api/v1/subscriptions Credit Cost: 1

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

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/subscriptions/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface SubscriptionsDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface SubscriptionDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

Δομή Ημερήσιας Χρήσης Ενοικιαστή

Ένα αντικείμενο TenantDailyUsage αντιπροσωπεύει τη χρήση για έναν ενοικιαστή σε μια δεδομένη ημέρα. Αν δεν υπήρξε δραστηριότητα για έναν δεδομένο ενοικιαστή σε μια δεδομένη ημέρα, αυτή η ημέρα δεν θα έχει αντικείμενο TenantDailyUsage.

Το αντικείμενο TenantDailyUsage δεν είναι σε πραγματικό χρόνο και μπορεί να υστερεί κατά λεπτά από την πραγματική χρήση.

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

Δομή TenantDailyUsage

Copy

export interface TenantDailyUsage {
    yearNumber: number
    monthNumber: number
    dayNumber: number
    commentFetchCount?: number
    commentCreateCount?: number
    conversationCreateCount?: number
    voteCount?: number
    accountCreatedCount?: number
    userMentionSearch?: number
    hashTagSearch?: number
    gifSearchTrending?: number
    gifSearch?: number
    apiCreditsUsed?: number
    createdAt: string
    billed: boolean
    /** Ignored for billing. **/
    ignored: boolean
}

GET /api/v1/tenant-daily-usage

Resource: TenantDailyUsage as GET /api/v1/tenant-daily-usage Credit Cost: 1

Αυτή η διαδρομή επιτρέπει την αναζήτηση για τη χρήση ενός ενοικιαστή ανά έτος, μήνα και ημέρα. Μπορούν να επιστραφούν έως 365 αντικείμενα, και το κόστος είναι 1 πίστωση api ανά 10 αντικείμενα.

Τα αντικείμενα απάντησης ταξινομούνται κατά την ημερομηνία δημιουργίας τους (τα παλαιότερα πρώτα).

Αναζήτηση TenantDailyUsage cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenant-daily-usage?tenantId=demo&API_KEY=DEMO_API_SECRET&yearNumber=2022&monthNumber=2&dayNumber=10'

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

Copy

interface TenantDailyUsageQueryParams {
    tenantId: string
    API_KEY: string
    /** Based on UTC. **/
    yearNumber?: number
    /** Zero-based. Based on UTC. **/
    monthNumber?: number
    /** One-based. Based on UTC. **/
    dayNumber?: number
}

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

Copy

interface TenantDailyUsageResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
    tenantDailyUsages: TenantDailyUsage[]
}

Δομή Ενοικιαστή

Ο Tenant ορίζει έναν πελάτη του FastComments.com. Μπορούν να δημιουργηθούν μέσω του API από ενοικιαστές με πρόσβαση white labeling. Οι white labeled ενοικιαστές δεν μπορούν να δημιουργήσουν άλλους white labeled ενοικιαστές (επιτρέπεται μόνο ένα επίπεδο ένθεσης).

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

Δομή Tenant

Copy

export enum SiteType {
    Unknown = 0,
    WordPress = 1
}
/** This can also be handled via the DomainConfig API. **/
export interface TenantDomainConfig {
    domain: string
    emailFromName?: string
    emailFromEmail?: string
    createdAt?: string,
    siteType?: FastCommentsSiteType, // you probably want Unknown
    logoSrc?: string, // raw image path
    logoSrc100px?: string, // resized for thumbnails
    footerUnsubscribeURL?: string,
    emailHeaders?: Record<string, string>,
    disableUnsubscribeLinks?: boolean,
    dkim?: {
        domainName: string,
        keySelector: string,
        privateKey: string
    }
}
export interface TenantBillingInfo {
    name: string
    address: string
    city: string
    state: string
    zip: string
    country: string
}
export enum TenantPaymentFrequency {
    Monthly = 0,
    Annually = 1
}
export interface Tenant {
    id: string
    name: string
    email?: string
    signUpDate: number; // number due to "legacy" reasons
    packageId?: string | null
    paymentFrequency?: TenantPaymentFrequency
    billingInfoValid?: boolean
    billingHandledExternally?: boolean
    createdBy?: string
    isSetup?: boolean
    domainConfiguration: FastCommentsAPITenantDomainConfig[]
    billingInfo?: FastCommentsAPITenantBillingInfo
    stripeCustomerId?: string
    stripeSubscriptionId?: string
    stripePlanId?: string
    enableProfanityFilter?: boolean
    enableSpamFilter?: boolean
    lastBillingIssueReminderDate?: string
    removeUnverifiedComments?: boolean
    unverifiedCommentsTTLms?: number
    commentsRequireApproval?: boolean
    autoApproveCommentOnVerification?: boolean
    sendProfaneToSpam?: boolean
    /** @readonly - Is calculated based on packageId. **/
    hasFlexPricing?: boolean
    /** @readonly **/
    flexLastBilledAmount?: number
    /** @readonly - Is calculated based on packageId. **/
    hasAuditing?: boolean
    /** You can store a key value pair with the tenant which you can use to query. Keys cannot contain "." or "$", or be longer than 100 chars. Values may not be longer than 2k chars. **/
    meta?: Record<string, string | null>
}

GET /api/v1/tenants/:id

Resource: Tenant as GET /api/v1/tenants/:id Credit Cost: 1

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

Tenant Κατά ID cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface TenantByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** Included on failure. **/
    reason?: string
    tenant?: Tenant
}

GET /api/v1/tenants

Resource: Tenant as GET /api/v1/tenants Credit Cost: 1

Αυτό το API επιστρέφει ενοικιαστές που διαχειρίζονται από τον ενοικιαστή σας.

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

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'

Μπορείτε να ορίσετε παραμέτρους meta στα αντικείμενα Tenant και να αναζητήσετε αντίστοιχους ενοικιαστές. Για παράδειγμα, για το κλειδί someKey και την τιμή meta some-value, μπορούμε να κατασκευάσουμε ένα αντικείμενο JSON με αυτό το ζεύγος κλειδιού/τιμής και μετά να το κωδικοποιήσουμε URI ως παράμετρο ερωτήματος για φιλτράρισμα:

Αναζήτηση Tenant κατά Meta cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET&meta=%7B%22someKey%22%3A%22some-value%22%7D'

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

Copy

interface TenantsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** The number of tenants to skip for pagination. **/
    skip?: number
    /** Filter by meta params. **/
    meta?: string
}

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

Copy

interface TenantsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    tenants?: Tenant[]
}

POST /api/v1/tenants

Resource: Tenant as POST /api/v1/tenants Credit Cost: 1

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

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

Ένα name είναι απαιτούμενο.
Το domainConfiguration είναι απαιτούμενο.
Οι ακόλουθες τιμές δεν μπορούν να παρέχονται κατά τη δημιουργία ενός Tenant:
- hasFlexPricing
- lastBillingIssueReminderDate
- flexLastBilledAmount
Η signUpDate δεν μπορεί να είναι στο μέλλον.
Το name δεν μπορεί να είναι μεγαλύτερο από 200 χαρακτήρες.
Το email δεν μπορεί να είναι μεγαλύτερο από 300 χαρακτήρες.
Το email πρέπει να είναι μοναδικό σε όλους τους ενοικιαστές του FastComments.com.
Δεν μπορείτε να δημιουργήσετε ενοικιαστές αν ο γονικός ενοικιαστής δεν έχει ένα έγκυρο TenantPackage ορισμένο.
- Αν ο ενοικιαστής σας δημιουργήθηκε μέσω του FastComments.com, αυτό δεν θα πρέπει να είναι πρόβλημα.
Δεν μπορείτε να δημιουργήσετε περισσότερους ενοικιαστές από αυτούς που ορίζονται στο maxWhiteLabeledTenants στο πακέτο σας.
Πρέπει να καθορίσετε την παράμετρο ερωτήματος tenantId που είναι το id του γονικού ενοικιαστή σας με ενεργοποιημένο το white labeling.

Μπορούμε να δημιουργήσουμε έναν Tenant με μόνο λίγες παραμέτρους:

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some Name",
    "email": "someone@someone.com",
    "domainConfiguration": [ { "domain": "somedomain.com" } ]
}'

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

Copy

interface TenantPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'unexpected-param' | 'sign-up-date-in-future' | 'payment-frequency-invalid' | 'cannot-change-payment-frequency' | 'name-invalid' | 'email-invalid' | 'email-taken' | 'no-package' | 'invalid-package' | 'unauthorized' | 'tenant-limit-reached' | 'cannot-move-tenant' | 'cannot-change-package' | 'invalid-billing-info'
    /** Included on failure. **/
    reason?: string
    tenant?: Tenant; // We return the complete created tenant on success.
}

PATCH /api/v1/tenants/:id

Resource: Tenant as PATCH /api/v1/tenants/:id Credit Cost: 1

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

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

Οι ακόλουθες τιμές δεν μπορούν να ενημερωθούν:
- hasFlexPricing
- lastBillingIssueReminderDate
- flexLastBilledAmount
- managedByTenantId
Η signUpDate δεν μπορεί να είναι στο μέλλον.
Το name δεν μπορεί να είναι μεγαλύτερο από 200 χαρακτήρες.
Το email δεν μπορεί να είναι μεγαλύτερο από 300 χαρακτήρες.
Το email πρέπει να είναι μοναδικό σε όλους τους ενοικιαστές του FastComments.com.
Όταν ορίζετε το billingInfoValid σε true, το billingInfo πρέπει να παρέχεται στο ίδιο αίτημα.
Δεν μπορείτε να ενημερώσετε το packageId που συσχετίζεται με τον δικό σας ενοικιαστή.
Δεν μπορείτε να ενημερώσετε το paymentFrequency που συσχετίζεται με τον δικό σας ενοικιαστή.

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some New Name",
}'

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

Copy

interface TenantPatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'unexpected-param' | 'sign-up-date-in-future' | 'payment-frequency-invalid' | 'cannot-change-payment-frequency' | 'name-invalid' | 'email-invalid' | 'email-taken' | 'no-package' | 'invalid-package' | 'unauthorized' | 'tenant-limit-reached' | 'cannot-move-tenant' | 'cannot-change-package' | 'invalid-billing-info';
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/tenants/:id

Resource: Tenant as DELETE /api/v1/tenants/:id Credit Cost: 1,000

Αυτή η διαδρομή παρέχει την αφαίρεση ενός Tenant και όλων των σχετικών δεδομένων (χρήστες, σχόλια, κλπ) με βάση το id.

Οι ακόλουθοι περιορισμοί υπάρχουν γύρω από την αφαίρεση ενοικιαστών:

Ο ενοικιαστής πρέπει να είναι δικός σας, ή ένας ενοικιαστής white label που διαχειρίζεστε.
Η παράμετρος ερωτήματος sure πρέπει να οριστεί σε true.

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface TenantDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'unsure'
    /** Included on failure. **/
    reason?: string
}

Δομή Πακέτου Ενοικιαστή

Το TenantPackage ορίζει τις πληροφορίες πακέτου που είναι διαθέσιμες σε έναν Tenant. Ένας ενοικιαστής μπορεί να έχει πολλά διαθέσιμα πακέτα, αλλά μόνο ένα σε χρήση σε δεδομένη στιγμή.

Ένας Tenant δεν μπορεί να χρησιμοποιηθεί για κανένα προϊόν μέχρι το packageId του να δείχνει σε ένα έγκυρο TenantPackage.

Υπάρχουν δύο τύποι αντικειμένων TenantPackage:

Πακέτα σταθερής τιμολόγησης - όπου το hasFlexPricing είναι false.
Ευέλικτη τιμολόγηση - όπου το hasFlexPricing είναι true.

Και στις δύο περιπτώσεις τα όρια ορίζονται στον λογαριασμό που χρησιμοποιεί το πακέτο, ωστόσο με το Flex ο ενοικιαστής χρεώνεται μια βασική τιμή συν αυτό που χρησιμοποίησε, που ορίζεται από τις παραμέτρους flex*.

Ένας ενοικιαστής μπορεί να έχει πολλαπλά πακέτα ενοικιαστή και να έχει τη δυνατότητα να αλλάξει το πακέτο ο ίδιος από τη Σελίδα Πληροφοριών Χρέωσης.

Αν θα χειρίζεστε τη χρέωση για τους ενοικιαστές εσείς, θα χρειαστεί ακόμα να ορίσετε ένα πακέτο για κάθε ενοικιαστή για να ορίσετε τα όριά τους. Απλά ορίστε το billingHandledExternally σε true στον Tenant και δεν θα μπορούν να αλλάξουν τις πληροφορίες χρέωσής τους, ή το ενεργό πακέτο, οι ίδιοι.

Δεν μπορείτε να δημιουργήσετε πακέτα με υψηλότερα όρια από τον γονικό ενοικιαστή.

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

Δομή TenantPackage

Copy

export interface TenantPackage {
    id: string
    name: string
    tenantId: string
    createdAt: string
    monthlyCostUSD: number
    yearlyCostUSD: number
    monthlyStripePlanId?: string
    yearlyStripePlanId?: string
    maxMonthlyPageLoads: number
    maxMonthlyAPICredits: number
    maxMonthlyComments: number
    maxConcurrentUsers: number
    maxTenantUsers: number
    maxSSOUsers: number
    maxModerators: number
    maxDomains: number
    maxWhiteLabeledTenants: number
    hasWhiteLabeling: boolean
    hasDebranding: boolean
    forWhoText: string
    featureTaglines: string[]
    hasAuditing: boolean
    hasFlexPricing: boolean
    flexPageLoadCostCents?: null
    flexPageLoadUnit?: null
    flexCommentCostCents?: null
    flexCommentUnit?: null
    flexSSOUserCostCents?: null // Cost per regular SSO user (without admin/moderator permissions)
    flexSSOUserUnit?: null
    flexAPICreditCostCents?: null
    flexAPICreditUnit?: null
    flexModeratorCostCents?: null
    flexModeratorUnit?: null
    flexAdminCostCents?: null
    flexAdminUnit?: null
    flexDomainCostCents?: null
    flexDomainUnit?: null
    flexSSOAdminCostCents?: null // Cost per SSO user with admin permissions (isAccountOwner or isAdminAdmin flags)
    flexSSOAdminUnit?: null
    flexSSOModeratorCostCents?: null // Cost per SSO user with moderator permissions (isCommentModeratorAdmin flag)
    flexSSOModeratorUnit?: null
    flexMinimumCostCents?: null
}

GET /api/v1/tenant-packages/:id

Resource: TenantPackage as GET /api/v1/tenant-packages/:id Credit Cost: 1

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

TenantPackage Κατά ID cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface TenantPackageByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPackageByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
    tenantPackage: TenantPackage
}

GET /api/v1/tenant-packages

Resource: TenantPackage as GET /api/v1/tenant-packages Credit Cost: 1

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

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenant-packages?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'

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

Copy

interface TenantPackagesRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** The number of tenant packages to skip for pagination. **/
    skip?: number
}

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

Copy

interface TenantPackagesResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    tenantPackages?: TenantPackage[]
}

POST /api/v1/tenant-packages

Resource: TenantPackage as POST /api/v1/tenant-packages Credit Cost: 1

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

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

Οι ακόλουθες παράμετροι είναι απαιτούμενες:
- name
- tenantId
- monthlyCostUSD - Μπορεί να είναι null.
- yearlyCostUSD - Μπορεί να είναι null.
- maxMonthlyPageLoads
- maxMonthlyAPICredits
- maxMonthlyComments
- maxConcurrentUsers
- maxTenantUsers
- maxSSOUsers
- maxModerators
- maxDomains
- hasDebranding
- forWhoText
- featureTaglines
- hasFlexPricing - Αν είναι true, τότε όλες οι παράμετροι flex* απαιτούνται.
Το name δεν μπορεί να είναι μεγαλύτερο από 50 χαρακτήρες.
Κάθε στοιχείο forWhoText δεν μπορεί να είναι μεγαλύτερο από 200 χαρακτήρες.
Κάθε στοιχείο featureTaglines δεν μπορεί να είναι μεγαλύτερο από 100 χαρακτήρες.
Το TenantPackage πρέπει να είναι "μικρότερο" από τον γονικό ενοικιαστή. Για παράδειγμα, όλες οι παράμετροι max* πρέπει να έχουν χαμηλότερες τιμές από τον γονικό ενοικιαστή.
Ένας white labeled ενοικιαστής μπορεί να έχει μέχρι πέντε πακέτα.
Μόνο οι ενοικιαστές με πρόσβαση white labeling μπορούν να δημιουργήσουν ένα TenantPackage.
Δεν μπορείτε να προσθέσετε πακέτα στον δικό σας ενοικιαστή. :)

Μπορούμε να δημιουργήσουμε ένα TenantPackage ως εξής:

Δημιουργία TenantPackage μέσω Email cURL Παράδειγμα

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/tenant-packages?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Default Package",
  "tenantId": "some-child-tenant-id",
  "monthlyCostUSD": null,
  "yearlyCostUSD": null,
  "maxMonthlyPageLoads": 50000,
  "maxMonthlyAPICredits": 50000,
  "maxMonthlyComments": 50000,
  "maxConcurrentUsers": 50000,
  "maxTenantUsers": 10,
  "maxSSOUsers": 50000,
  "maxModerators": 100,
  "maxDomains": 3,
  "hasWhiteLabeling": false,
  "hasDebranding": true,
  "forWhoText": "For Everyone",
  "featureTaglines": [
    "Some Tag",
    "Some Other Tag"
  ],
  "hasFlexPricing": true,
  "flexPageLoadCostCents": 100,
  "flexPageLoadUnit": 100000,
  "flexCommentCostCents": 100,
  "flexCommentUnit": 100000,
  "flexSSOUserCostCents": 100,
  "flexSSOUserUnit": 1000,
  "flexAPICreditCostCents": 100,
  "flexAPICreditUnit": 50000,
  "flexModeratorCostCents": 500,
  "flexModeratorUnit": 1,
  "flexAdminCostCents": 1000,
  "flexAdminUnit": 1,
  "flexDomainCostCents": 1000,
  "flexDomainUnit": 1,
  "flexMinimumCostCents": 99
}'

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

Copy

interface TenantPackagePostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPackagePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' 'white-labeling-not-allowed' | 'name-too-long' | 'for-who-text-too-long' | 'feature-tag-lines-too-long' | 'no-package' | 'invalid-package' | 'unauthorized' | 'child-tenant-too-large' | 'flex-param-missing' | 'unexpected-flex-param' | 'package-limit-reached' | 'flex-param-missing' | 'unexpected-flex-param'
    /** Included on failure. **/
    reason?: string
    tenantPackage?: TenantPackage; // We return the complete created tenant package on success.
}

PATCH /api/v1/tenant-packages/:id

Resource: TenantPackage as PATCH /api/v1/tenant-packages/:id Credit Cost: 1

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

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

Αν ορίζετε το hasFlexPricing σε true, τότε όλες οι παράμετροι flex* απαιτούνται στο ίδιο αίτημα.
Το name δεν μπορεί να είναι μεγαλύτερο από 50 χαρακτήρες.
Κάθε στοιχείο forWhoText δεν μπορεί να είναι μεγαλύτερο από 200 χαρακτήρες.
Κάθε στοιχείο featureTaglines δεν μπορεί να είναι μεγαλύτερο από 100 χαρακτήρες.
Το TenantPackage πρέπει να είναι "μικρότερο" από τον γονικό ενοικιαστή. Για παράδειγμα, όλες οι παράμετροι max* πρέπει να έχουν χαμηλότερες τιμές από τον γονικό ενοικιαστή.
Δεν μπορείτε να αλλάξετε το tenantId που συσχετίζεται με ένα TenantPackage.

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some New Name",
}'

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

Copy

interface TenantPackagePatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPackagePatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'white-labeling-not-allowed' | 'name-too-long' | 'for-who-text-too-long' | 'feature-tag-lines-too-long' | 'no-package' | 'invalid-package' | 'unauthorized' | 'child-tenant-too-large' | 'flex-param-missing' | 'unexpected-flex-param' | 'package-limit-reached' | 'flex-param-missing' | 'unexpected-flex-param';
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/tenant-packages/:id

Resource: TenantPackage as DELETE /api/v1/tenant-packages/:id Credit Cost: 5

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

Δεν μπορείτε να αφαιρέσετε ένα TenantPackage που είναι σε χρήση (το packageId ενός ενοικιαστή δείχνει στο πακέτο). Ενημερώστε πρώτα τον Tenant.

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface TenantPackageDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPackageDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'package-in-use'
    /** Included on failure. **/
    reason?: string
}

Δομή Χρήστη Ενοικιαστή

Ο TenantUser ορίζει έναν User που διαχειρίζεται από έναν συγκεκριμένο ενοικιαστή. Ο λογαριασμός του είναι υπό πλήρη έλεγχο του ενοικιαστή με τον οποίο συσχετίζεται, και ο λογαριασμός του μπορεί να ενημερωθεί ή να διαγραφεί μέσω του UI ή του API.

Οι χρήστες ενοικιαστή μπορούν να είναι διαχειριστές με όλα τα δικαιώματα και πρόσβαση στον Tenant, ή μπορούν να περιοριστούν σε συγκεκριμένα δικαιώματα για τον έλεγχο σχολίων, πρόσβαση σε κλειδιά API, κλπ.

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

Δομή TenantUser

Copy

/** This is for notifications. **/
export enum UserDigestEmailFrequency {
    Disabled = -1,
    Daily = 0,
    Weekly = 1,
    Monthly = 2
}
export interface TenantUser {
    id: string
    tenantId: string
    username: string
    /** A link to the commenter's blog, for example. **/
    websiteUrl?: string
    email: string
    signUpDate: number
    createdFromUrlId: string
    createdFromTenantId: string
    verified: boolean
    loginCount: number
    optedInNotifications: boolean
    optedInTenantNotifications: boolean
    hideAccountCode: boolean
    avatarSrc?: string
    /** Does the user receive help requests from commenters? **/
    isHelpRequestAdmin: boolean
    isAccountOwner: boolean
    isAdminAdmin: boolean
    isBillingAdmin: boolean
    isAnalyticsAdmin: boolean
    isCustomizationAdmin: boolean
    isManageDataAdmin: boolean
    isCommentModeratorAdmin: boolean
    isAPIAdmin: boolean
    moderatorIds: string[]
    locale: FastCommentsLocale
    digestEmailFrequency: UserDigestEmailFrequency
    lastLoginDate: string
    displayLabel?: string
    karma?: number
}

GET /api/v1/tenant-users/:id

Resource: TenantUser as GET /api/v1/tenant-users/:id Credit Cost: 1

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

TenantUser Κατά ID cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface TenantUserByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantUserByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** Included on failure. **/
    reason?: string
    tenantUser?: TenantUser
}

GET /api/v1/tenant-users

Resource: TenantUser as GET /api/v1/tenant-users Credit Cost: 1

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

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/tenant-users?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'

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

Copy

interface TenantUsersRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** The number of tenant users to skip for pagination. **/
    skip?: number
}

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

Copy

interface TenantUsersResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    tenantUsers?: TenantUser[]
}

POST /api/v1/tenant-users

Resource: TenantUser as POST /api/v1/tenant-users Credit Cost: 1

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

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

Ένα username είναι απαιτούμενο.
Ένα email είναι απαιτούμενο.
Η signUpDate δεν μπορεί να είναι στο μέλλον.
Η locale πρέπει να είναι στη λίστα των Υποστηριζόμενων Τοπικών Ρυθμίσεων.
Το username πρέπει να είναι μοναδικό σε όλο το FastComments.com. Αν αυτό είναι πρόβλημα, προτείνουμε να χρησιμοποιήσετε SSO αντί αυτού.
Το email πρέπει να είναι μοναδικό σε όλο το FastComments.com. Αν αυτό είναι πρόβλημα, προτείνουμε να χρησιμοποιήσετε SSO αντί αυτού.
Δεν μπορείτε να δημιουργήσετε περισσότερους χρήστες ενοικιαστή από αυτούς που ορίζονται στο maxTenantUsers στο πακέτο σας.

Μπορούμε να δημιουργήσουμε έναν TenantUser ως εξής

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "Some Name",
    "email": "someone@someone.com"
}'

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

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantUserPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'username-required' | 'email-required' | 'sign-up-date-in-future' | 'unsupported-locale' | 'unauthorized' | 'username-taken' | 'email-taken' | 'tenant-user-limit-reached'
    /** Included on failure. **/
    reason?: string
    tenantUser?: TenantUser; // We return the complete created tenant user on success.
}

Resource: TenantUser as POST /api/v1/tenant-users/:id/send-login-link Credit Cost: 10

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

Χρήσιμο όταν δημιουργείτε χρήστες μαζικά και δεν θέλετε να τους καθοδηγήσετε για τον τρόπο σύνδεσης στο FastComments.com. Αυτό απλά θα τους στείλει έναν "μαγικό σύνδεσμο" για σύνδεση που λήγει μετά από 30 ημέρες.

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

Ο TenantUser πρέπει να υπάρχει ήδη.
Πρέπει να έχετε πρόσβαση στη διαχείριση του Tenant στον οποίο ανήκει ο TenantUser.

Μπορούμε να στείλουμε σύνδεσμο σύνδεσης σε έναν TenantUser ως εξής:

Σύνδεσμος Σύνδεσης TenantUser cURL Παράδειγμα

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/tenant-users/xyz/send-login-link?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json'

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

Δομή Αιτήματος Συνδέσμου Σύνδεσης TenantUser

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Συνδέσμου Σύνδεσης TenantUser

Copy

interface TenantUserPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

PATCH /api/v1/tenant-users/:id

Resource: TenantUser as PATCH /api/v1/tenant-users/:id Credit Cost: 1

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

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

Η signUpDate δεν μπορεί να είναι στο μέλλον.
Η locale πρέπει να είναι στη λίστα των Υποστηριζόμενων Τοπικών Ρυθμίσεων.
Το username πρέπει να είναι μοναδικό σε όλο το FastComments.com. Αν αυτό είναι πρόβλημα, προτείνουμε να χρησιμοποιήσετε SSO αντί αυτού.
Το email πρέπει να είναι μοναδικό σε όλο το FastComments.com. Αν αυτό είναι πρόβλημα, προτείνουμε να χρησιμοποιήσετε SSO αντί αυτού.
Δεν μπορείτε να ενημερώσετε το tenantId ενός χρήστη.

Μπορούμε να δημιουργήσουμε έναν TenantUser ως εξής

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "Some Name",
    "email": "someone@someone.com"
}'

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

Copy

interface TenantUserPatchQueryParams {
    tenantId: string
    API_KEY: string
    /** When email or username is changed, you can set this to true to also update the user's comments. This will double the credit cost. **/
    updateComments: 'true' | 'false'
}

Δομή Απάντησης Ενημέρωσης TenantUser

Copy

interface TenantUserPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'sign-up-date-in-future' | 'unsupported-locale' | 'unauthorized' | 'username-taken' | 'email-taken' | 'unauthorized' | 'no-package' | 'invalid-package' | 'tenant-user-limit-reached' | 'user-does-not-exist'
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/tenant-users/:id

Resource: TenantUser as DELETE /api/v1/tenant-users/:id Credit Cost: 5

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

Η διαγραφή των σχολίων του χρήστη είναι δυνατή μέσω της παραμέτρου ερωτήματος deleteComments. Σημειώστε ότι αν αυτό είναι true:

Όλα τα σχόλια του χρήστη θα διαγραφούν ζωντανά.
Όλα τα θυγατρικά (τώρα ορφανά) σχόλια θα διαγραφούν ή θα ανωνυμοποιηθούν με βάση τη ρύθμιση της συσχετισμένης σελίδας κάθε σχολίου. Για παράδειγμα αν η λειτουργία διαγραφής νήματος είναι "anonymize", τότε οι απαντήσεις θα παραμείνουν, και τα σχόλια του χρήστη θα ανωνυμοποιηθούν. Αυτό ισχύει μόνο όταν το commentDeleteMode είναι Remove (η προεπιλεγμένη τιμή).
Το creditsCost γίνεται 2.

Ανωνυμοποιημένα Σχόλια

Μπορείτε να διατηρήσετε τα σχόλια του χρήστη αλλά απλά να τα ανωνυμοποιήσετε ορίζοντας commentDeleteMode=1.

Αν τα σχόλια του χρήστη ανωνυμοποιηθούν τότε οι ακόλουθες τιμές ορίζονται σε null:

- commenterName
- commenterEmail
- avatarSrc
- userId
- anonUserId
- mentions
- badges

Τα isDeleted και isDeletedUser ορίζονται σε true.

Κατά την απόδοση, το widget σχολίων θα χρησιμοποιεί DELETED_USER_PLACEHOLDER (προεπιλογή: "[deleted]") για το όνομα του χρήστη και DELETED_CONTENT_PLACEHOLDER για το σχόλιο. Αυτά μπορούν να προσαρμοστούν μέσω του UI Προσαρμογής Widget.

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

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

enum TenantUserCommentDeleteMode {
    Remove = 0, // default
    Anonymize = 1
}
interface TenantUserDeleteQueryParams {
    tenantId: string
    API_KEY: string
    /** You can set this to true to also delete the user's comments. This will double the credit cost. **/
    deleteComments?: 'true' | 'false'
    /** You can set this as desired to determine how to handle the user's comments. **/
    commentDeleteMode?: TenantUserCommentDeleteMode
}

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

Copy

interface TenantUserDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'
    /** Included on failure. **/
    reason?: string
}

Δομή Χρήστη

Ο User είναι ένα αντικείμενο που αντιπροσωπεύει τον πιο κοινό παρονομαστή όλων των χρηστών.

Λάβετε υπόψη ότι στο FastComments έχουμε πολλές διαφορετικές περιπτώσεις χρήσης για χρήστες:

Secure SSO
Simple SSO
Χρήστες Ενοικιαστή (Για παράδειγμα: Διαχειριστές)
Σχολιαστές

Αυτό το API είναι για Σχολιαστές και χρήστες που δημιουργήθηκαν μέσω Simple SSO. Βασικά, οποιοσδήποτε χρήστης που δημιουργήθηκε μέσω του ιστότοπού σας μπορεί να προσπελαστεί μέσω αυτού του API. Οι Χρήστες Ενοικιαστή μπορούν επίσης να ανακτηθούν με αυτόν τον τρόπο, αλλά θα λάβετε περισσότερες πληροφορίες αλληλεπιδρώντας με το API /tenant-users/.

Για Secure SSO παρακαλώ χρησιμοποιήστε το API /sso-users/.

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

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

Δομή User

Copy

export interface User {
    /** This is also the id used as userId on comment objects. **/
    id: string
    username: string
    /** A link to the commenter's blog, for example. **/
    websiteUrl?: string
    email: string
    signUpDate: number
    createdFromUrlId: string
    createdFromTenantId: string
    avatarSrc?: string
    locale: FastCommentsLocale
    displayLabel?: string
    karma?: number
}

GET /api/v1/users/:id

Resource: User as GET /api/v1/users/:id Credit Cost: 1

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

User Κατά ID cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface UserByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface UserByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** Included on failure. **/
    reason?: string
    user?: User
}

Δομή Ψηφοφορίας

Ένα αντικείμενο Vote αντιπροσωπεύει μια ψήφο που αφέθηκε από έναν χρήστη.

Η σχέση μεταξύ σχολίων και ψήφων ορίζεται μέσω του commentId.

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

Δομή Vote

Copy

interface Vote {
    id: string
    urlId: string
    commentId: string
    userId: string
    direction: 1 | -1
    createdAt: string
}

GET /api/v1/votes

Resource: Vote as GET /api/v1/votes Credit Cost: 10

Οι ψήφοι πρέπει να ανακτηθούν κατά urlId.

Τύποι Ψήφων

Υπάρχουν τρεις τύποι ψήφων:

Επαληθευμένες Ψήφοι, που εφαρμόζονται στο αντίστοιχο σχόλιο. Μπορείτε να τις δημιουργήσετε μέσω αυτού του API.
Επαληθευμένες Ψήφοι, που αναμένουν επαλήθευση, και επομένως δεν έχουν ακόμα εφαρμοστεί στο σχόλιο. Αυτές δημιουργούνται όταν ένας χρήστης χρησιμοποιεί τον μηχανισμό σύνδεση για ψηφοφορία του FastComments.com.
Ανώνυμες Ψήφοι, που εφαρμόζονται στο αντίστοιχο σχόλιο. Αυτές δημιουργούνται μαζί με τα ανώνυμα σχόλια.

Αυτές επιστρέφονται σε ξεχωριστές λίστες στο API για μείωση της σύγχυσης.

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test'

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

Copy

interface VotesRequestQueryParams {
    tenantId: string
    API_KEY: string
    urlId: string
}

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

Copy

interface VotesResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
    /** Included on failure. **/
    reason?: string
    /** Authorized, verified votes, applied to their corresponding comments. **/
    appliedAuthorizedVotes: Vote[]
    /** Anonymous votes, applied to their corresponding comments. **/
    appliedAnonymousVotes: Vote[]
    /** Votes pending verification, not yet applied to their corresponding comments. **/
    pendingVotes: Vote[]
}

Σημειώσεις Ανώνυμων Ψήφων

Σημειώστε ότι οι ανώνυμες ψήφοι που δημιουργήθηκαν μέσω αυτού του API θα εμφανιστούν στη λίστα appliedAuthorizedVotes. Θεωρούνται εξουσιοδοτημένες αφού δημιουργήθηκαν μέσω του API με κλειδί API.

Η δομή appliedAnonymousVotes είναι για ψήφους που δημιουργήθηκαν χωρίς email, κλειδί API, κλπ.

GET /api/v1/votes/for-user

Resource: Vote as GET /api/v1/votes/for-user Credit Cost: 1

Επιτρέπει την ανάκτηση ψήφων που αφέθηκαν από έναν χρήστη σε ένα δεδομένο urlId. Δέχεται ένα userId που μπορεί να είναι οποιοσδήποτε χρήστης FastComments.com ή SSO User.

Αυτό είναι χρήσιμο αν θέλετε να δείξετε αν ένας χρήστης έχει ψηφίσει σε ένα σχόλιο. Κατά την ανάκτηση σχολίων, απλά καλέστε αυτό το API ταυτόχρονα για τον χρήστη με το ίδιο urlId.

Αν χρησιμοποιείτε ανώνυμη ψηφοφορία τότε θα θέλετε να περάσετε το anonUserId αντί αυτού.

Ψήφοι Για Χρήστη cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/votes/for-user?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test&userId=some-user-id'

Ψήφοι Για Ανώνυμο Χρήστη cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/votes/for-user?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test&anonUserId=some-user-id'

Σημειώστε ότι οι ανώνυμες ψήφοι θα εμφανιστούν στη λίστα appliedAuthorizedVotes. Θεωρούνται εξουσιοδοτημένες αφού δημιουργήθηκαν μέσω του API με κλειδί API.

Δομή Αιτήματος Ψήφων Για Χρήστη

Copy

interface VotesForUserRequestQueryParams {
    tenantId: string
    API_KEY: string
    urlId: string
    userId?: string
    anonUserId?: string
}

Δομή Απάντησης Ψήφων Για Χρήστη

Copy

interface VotesForUserResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'invalid-user-id'
    /** Included on failure. **/
    reason?: string
    /** Authorized, verified votes, applied to their corresponding comments. **/
    appliedAuthorizedVotes: Vote[]
    /** Votes pending verification, not yet applied to their corresponding comments. **/
    pendingVotes: Vote[]
}

POST /api/v1/votes

Resource: Vote as POST /api/v1/votes Credit Cost: 1

Αυτή η διαδρομή παρέχει τη δυνατότητα προσθήκης μιας μόνου εξουσιοδοτημένης Vote. Οι ψήφοι μπορούν να είναι up (+1) ή down (-1).

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=user-id&commentId=comment-id&direction=up' \
  --header 'Content-Type: application/json'

Δημιουργία Ανώνυμης Vote cURL Παράδειγμα

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-randomly-generated-identifier&commentId=comment-id&direction=up' \
  --header 'Content-Type: application/json'

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

Copy

interface VotePostQueryParams {
    tenantId: string
    API_KEY: string
    userId?: string
    anonUserId?: string
    commentId: string
    direction: 'up' | 'down'
}

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

Copy

interface VotePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-user-id' | 'invalid-user-id' | 'invalid-comment-id' | 'invalid-direction' | 'duplicate' | 'voting-disabled'
    /** Included on failure. **/
    reason?: string
    voteId?: string
}

Δημιουργία Ανώνυμων Ψήφων

Οι ανώνυμες ψήφοι μπορούν να δημιουργηθούν ορίζοντας το anonUserId στις παραμέτρους ερωτήματος αντί του userId.

Αυτό το id δεν χρειάζεται να αντιστοιχεί σε αντικείμενο χρήστη οπουδήποτε (εξ ου και ανώνυμο). Είναι απλά ένα αναγνωριστικό για τη συνεδρία, ώστε να μπορείτε να ανακτήσετε ψήφους ξανά στην ίδια συνεδρία, για να ελέγξετε αν ένα σχόλιο έχει ψηφιστεί.

Αν δεν έχετε κάτι σαν "ανώνυμες συνεδρίες" όπως το FastComments - μπορείτε απλά να το ορίσετε σε ένα τυχαίο ID, όπως ένα UUID (αν και εκτιμούμε μικρότερα αναγνωριστικά για εξοικονόμηση χώρου).

Άλλες Σημειώσεις

Αυτό το API υπακούει τις ρυθμίσεις σε επίπεδο ενοικιαστή. Για παράδειγμα, αν απενεργοποιήσετε την ψηφοφορία για μια δεδομένη σελίδα, και προσπαθήσετε να δημιουργήσετε μια ψήφο μέσω του API, θα αποτύχει με κωδικό σφάλματος voting-disabled.
Αυτό το API είναι ζωντανό από προεπιλογή.
Αυτό το API θα ενημερώσει τα votes του αντίστοιχου Comment.

DELETE /api/v1/votes/:id

Resource: Vote as DELETE /api/v1/votes/:id Credit Cost: 1

Αυτή η διαδρομή παρέχει τη δυνατότητα διαγραφής μιας μόνου Vote.

Διαγραφή Vote cURL Παράδειγμα

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/votes/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json'

Δομή Αιτήματος Διαγραφής Vote

Copy

interface VoteDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Διαγραφής Vote

Copy

interface VoteDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id'
    /** Included on failure. **/
    reason?: string
}

Σημειώσεις:

Αυτό το API υπακούει τις ρυθμίσεις σε επίπεδο ενοικιαστή. Για παράδειγμα, αν απενεργοποιήσετε την ψηφοφορία για μια δεδομένη σελίδα, και προσπαθήσετε να δημιουργήσετε μια ψήφο μέσω του API, θα αποτύχει με κωδικό σφάλματος voting-disabled.
Αυτό το API είναι ζωντανό από προεπιλογή.
Αυτό το API θα ενημερώσει τα votes του αντίστοιχου Comment.

Δομή Διαμόρφωσης Τομέα

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

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

Δομή Domain Config

Copy

interface DomainConfig {
    /** A domain, not a URL, like "fastcomments.com" or "www.example.com". Subdomain may be included if limiting to a subdomain is desired. Max 1000 characters. **/
    domain: string
    /** The From-Name used when sending emails. **/
    emailFromName?: string
    /** The From-Email used when sending emails. Ensure SPF is setup to allow mail.fastcomments.com to send emails as the domain used in this attribute. **/
    emailFromEmail?: string
    /** READONLY. When the object was created. **/
    createdAt: string
    /** The logo related to this domain. Used in emails. Use HTTPS. **/
    logoSrc?: string
    /** A smaller logo related to this domain. Use HTTPS. **/
    logoSrc100px?: string
    /** SSO ONLY. The URL used in the footer of every email sent. Supports a "[userId]" variable. **/
    footerUnsubscribeURL?: string
    /** SSO ONLY. The headers used in of every email sent. Useful for example for setting unsubscribe related headers to improve delivery. The List-Unsubscribe entry in this Record, if it exists, supports a "[userId]" variable. **/
    emailHeaders?: Record<string, string>
    /** Disable all unsubscribe links. Not recommended, may hurt delivery rates. **/
    disableUnsubscribeLinks?: boolean
    /** DKIM Configuration. **/
    dkim?: DomainConfigDKIM
}

Δομή Ρύθμισης DKIM

Copy

interface DomainConfigDKIM {
    /** The domain name in your DKIM record. **/
    domainName: string
    /** The DKIM key selector to use. **/
    keySelector: string
    /** Your private key. Start with -----BEGIN PRIVATE KEY----- and end with -----END PRIVATE KEY----- **/
    privateKey: string
}

Για Πιστοποίηση

Η Διαμόρφωση Domain χρησιμοποιείται για να καθοριστεί ποιοι ιστότοποι μπορούν να φιλοξενήσουν το widget FastComments για τον λογαριασμό σας. Αυτή είναι μια βασική μορφή πιστοποίησης, που σημαίνει ότι η προσθήκη ή αφαίρεση οποιωνδήποτε Διαμορφώσεων Domain μπορεί να επηρεάσει τη διαθεσιμότητα της εγκατάστασης FastComments σας στην παραγωγή.

Μην αφαιρείτε ή ενημερώνετε την ιδιότητα domain ενός Domain Config για ένα domain που χρησιμοποιείται αυτή τη στιγμή εκτός αν η απενεργοποίηση αυτού του domain είναι επιθυμητή.

Αυτό έχει την ίδια συμπεριφορά με την αφαίρεση ενός domain από το /auth/my-account/configure-domains.

Επίσης σημειώστε ότι η αφαίρεση ενός domain από τη διεπαφή My Domains θα αφαιρέσει οποιαδήποτε αντίστοιχη διαμόρφωση για αυτό το domain που μπορεί να έχει προστεθεί μέσω αυτής της διεπαφής.

Για Προσαρμογή Email

Ο σύνδεσμος διαγραφής εγγραφής στο υποσέλιδο του email, και η λειτουργία διαγραφής εγγραφής με ένα κλικ που προσφέρεται από πολλούς πελάτες email, μπορούν να διαμορφωθούν μέσω αυτού του API ορίζοντας τα footerUnsubscribeURL και emailHeaders, αντίστοιχα.

Για DKIM

Αφού ορίσετε τις εγγραφές DNS DKIM σας, απλά ενημερώστε το DomainConfig με τη διαμόρφωση DKIM σας χρησιμοποιώντας την καθορισμένη δομή.

GET /api/v1/domain-configs

Resource: Comment as GET /api/v1/domain-configs Credit Cost: 1

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

DomainConfig GET cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/domain-configs?tenantId=demo&API_KEY=DEMO_API_SECRET'

Δομή Αιτήματος DomainConfig GET

Copy

interface GetDomainConfigsRequestQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface GetDomainConfigsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    /** The configurations! **/
    configurations: DomainConfig[] | null
}

GET /api/v1/domain-configs/:domain

Resource: DomainConfig as GET /api/v1/domain-configs/:domain Credit Cost: 1

Μεμονωμένα DomainConfigs μπορούν να ανακτηθούν με βάση το αντίστοιχο domain.

Domain Config ανά Domain cURL Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET'

Δομή Αιτήματος Domain Config ανά Domain

Copy

interface DomainConfigsByDomainRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Domain Config ανά Domain

Copy

interface DomainConfigResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-domain' | 'update-would-create-duplicate' | 'domain-does-not-exist'
    /** Included on failure. **/
    reason?: string
    configuration?: DomainConfig | null
}

POST /api/v1/domain-configs

Resource: DomainConfig as POST /api/v1/domain-configs Credit Cost: 1

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

Η προσθήκη διαμόρφωσης για ένα domain εξουσιοδοτεί αυτό το domain για τον λογαριασμό FastComments.

Συνήθεις περιπτώσεις χρήσης αυτού του API είναι η αρχική ρύθμιση, αν επιθυμείται η προσθήκη πολλών domains, ή προσαρμοσμένη διαμόρφωση για αποστολή emails.

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/domain-configs?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "domain": "example.com",
    "emailFromName": "some from name",
    "emailFromEmail": "some@test.com",
    "logoSrc": "https://example.com/my-logo-big.png",
    "logoSrc100px": "https://example.com/my-logo-100px.png",
    "footerUnsubscribeURL": "http://example.com/unsubscribe-ui",
    "emailHeaders": {
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
        "List-Unsubscribe": "<https://example.com/opt-out/[userId]>"
    }
}'

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

Copy

interface DomainConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface DomainConfigPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'configuration-exists-for-domain' | 'domain-too-long' | 'domain-invalid';
    /** Included on failure. **/
    reason?: string
    /** The created configuration. **/
    configuration?: DomainConfig
}

PATCH /api/v1/domain-configs/:domain

Resource: DomainConfig as PATCH /api/v1/domain-configs/:domain Credit Cost: 1

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

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "emailFromName": "Some New From Name",
}'

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

Copy

interface DomainConfigPatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface DomainConfigPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'domain-does-not-exist' | 'update-would-create-duplicate' | 'domain-too-long' | 'domain-invalid';
    /** Included on failure. **/
    reason?: string
    /** The updated configuration. **/
    configuration?: DomainConfig
}

PUT /api/v1/domain-configs/:domain

Resource: DomainConfig as PUT /api/v1/domain-configs/:domain Credit Cost: 1

Αυτό το API endpoint παρέχει τη δυνατότητα αντικατάστασης μιας διαμόρφωσης domain.

DomainConfig PUT cURL Παράδειγμα

Copy

curl --request PUT \
  --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "domain": "new-domain-example.com",
    "emailFromName": "some from name",
    "emailFromEmail": "some@test.com",
    "logoSrc": "https://example.com/my-logo-big.png",
    "logoSrc100px": "https://example.com/my-logo-100px.png",
    "footerUnsubscribeURL": "http://example.com/unsubscribe-ui",
    "emailHeaders": {
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
        "List-Unsubscribe": "<https://example.com/opt-out/[userId]>"
    }
}'

Δομή Αιτήματος DomainConfig PUT

Copy

interface DomainConfigPutQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface DomainConfigPutResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'domain-does-not-exist' | 'update-would-create-duplicate' | 'domain-too-long' | 'domain-invalid';
    /** Included on failure. **/
    reason?: string
    /** The updated configuration. **/
    configuration?: DomainConfig
}

DELETE /api/v1/domain-configs/:domain

Resource: DomainConfig as DELETE /api/v1/domain-configs/:domain Credit Cost: 1

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

Σημείωση: Η αφαίρεση ενός DomainConfig θα αφαιρέσει την εξουσιοδότηση αυτού του domain από τη χρήση του FastComments.
Σημείωση: Η επαναπροσθήκη ενός domain μέσω του UI θα αναδημιουργήσει το αντικείμενο (με μόνο το domain συμπληρωμένο).

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface DomainConfigRequestQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface DomainConfigDeleteResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-domain' | 'domain-config-does-not-exist'
    /** Included on failure. **/
    reason?: string
}

Δομή Διαμόρφωσης Ερώτησης

Το FastComments παρέχει έναν τρόπο κατασκευής ερωτήσεων και συγκέντρωσης των αποτελεσμάτων τους. Ένα παράδειγμα ερώτησης (εφεξής QuestionConfig) μπορεί να είναι μια βαθμολογία με αστέρια, ένας ολισθητής ή μια ερώτηση NPS (καθορίζεται μέσω του type).

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

Το πλαίσιο έχει όλες τις δυνατότητες που χρειάζονται για την κατασκευή widgets πλευράς πελάτη (με τον διακομιστή σας μπροστά από αυτό το API), πίνακες ελέγχου διαχείρισης και εργαλεία αναφοράς.

Πρώτα, πρέπει να ορίσουμε ένα QuestionConfig. Η δομή είναι η ακόλουθη:

Δομή QuestionConfig

Copy

type QuestionConfigType = 'nps' | 'slider' | 'star' | 'thumbs';
interface QuestionConfig {
    id: string
    tenantId: string
    name: string
    question: string
    helpText?: string
    createdAt: string
    createdBy: string
    /** READONLY - incremented for each new response. **/
    usedCount: number
    /** A date string for when the configuration was last used (result left). **/
    lastUsed?: string
    type: QuestionConfigType
    numStars?: number
    min?: number
    max?: number
    defaultValue?: number
    labelNegative?: string
    labelPositive?: string
    subQuestionIds?: string[]
    alwaysShowSubQuestions?: boolean
    reportingOrder: number
}

GET /api/v1/question-configs

Resource: QuestionConfig as GET /api/v1/question-configs Credit Cost: 1

Αυτή η διαδρομή επιστρέφει έως 100 αντικείμενα QuestionConfig τη φορά, με σελιδοποίηση. Το κόστος είναι 1 ανά κάθε 100 αντικείμενα. Είναι ταξινομημένα κατά κείμενο ερώτησης αύξουσα (question πεδίο).

QuestionConfig Παράδειγμα

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/question-configs?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface QuestionConfigRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
    /** For pagination. Starts at 0. **/
    skip?: number
}

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

Copy

interface QuestionConfigByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    questionConfigs: QuestionConfig[]
}

GET /api/v1/question-configs/:id

Resource: QuestionConfig as GET /api/v1/question-configs/:id Credit Cost: 1

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/question-configs/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface QuestionConfigRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface QuestionConfigByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
    questionConfig?: QuestionConfig
}

POST /api/v1/question-configs

Resource: QuestionConfig as POST /api/v1/question-configs Credit Cost: 1

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/question-configs?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some name that shows on reports.",
    "question": "how much do you like this api?",
    "type": 'slider',
    "reportingOrder": 0,
    "min": 0,
    "max": 10
}'

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

Copy

interface QuestionConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface QuestionConfigPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';
    /** Included on failure. **/
    reason?: string
    /** The created object. **/
    questionConfig?: QuestionConfig
}

PATCH /api/v1/question-configs/:id

Resource: QuestionConfig as PATCH /api/v1/question-configs/:id Credit Cost: 1

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

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

Δομή QuestionConfig

Copy

interface QuestionConfigPatchBody {
    name?: string
    question?: string
    helpText?: string
    /** Beware! Changing type may throw off reporting if min/max is different. **/
    type?: QuestionConfigType
    numStars?: number
    min?: number
    max?: number
    defaultValue?: number
    labelNegative?: string
    labelPositive?: string
    subQuestionIds?: string[]
    alwaysShowSubQuestions?: boolean
    reportingOrder?: number
}

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/question-configs/my-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "question": "some new question text"
}'

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

Copy

interface QuestionConfigPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Ενημέρωσης QuestionConfig

Copy

interface QuestionConfigPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/question-configs/:id

Resource: QuestionConfig as DELETE /api/v1/question-configs/:id Credit Cost: 100

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

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

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/question-configs/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface QuestionConfigDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface QuestionConfigResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

Δομή Αποτελέσματος Ερώτησης

Για να αποθηκεύσετε αποτελέσματα για ερωτήσεις, δημιουργείτε ένα QuestionResult. Μπορείτε στη συνέχεια να συγκεντρώσετε τα αποτελέσματα ερωτήσεων, και επίσης να τα συνδέσετε με σχόλια για σκοπούς αναφοράς.

Δομή QuestionResult

Copy

interface QuestionResultMeta {
    name: string
    values: string[]
}
interface QuestionResult {
    id: string
    tenantId: string
    urlId: string
    anonUserId?: string
    userId?: string
    createdAt?: string
    value: number
    commentId?: string
    questionId: string
    meta?: QuestionResultMeta[]
}

GET /api/v1/question-results

Resource: QuestionResults as GET /api/v1/question-results Credit Cost: 1

Αυτή η διαδρομή επιστρέφει έως 1000 αντικείμενα QuestionResults τη φορά, με σελιδοποίηση. Το κόστος είναι 1 ανά κάθε 100 αντικείμενα. Είναι ταξινομημένα κατά createdAt, αύξουσα. Μπορείτε να φιλτράρετε με διάφορες παραμέτρους.

Παράδειγμα QuestionResults

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/question-results?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface QuestionResultsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** For pagination. Starts at 0. **/
    skip?: number
    /** For pagination. **/
    limit?: number
    /** Get the results from a specific page. **/
    urlId?: string
    /** Get the results from a specific user. **/
    userId?: string
    startDate?: string | number
    questionId?: string | string[]
}

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

Copy

interface QuestionResultsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    questionResults: QuestionResults[]
}

GET /api/v1/question-results/:id

Resource: QuestionResult as GET /api/v1/question-results/:id Credit Cost: 1

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

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

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/question-results/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface QuestionResultRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface QuestionResultByIdResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
    questionResult?: QuestionResult
}

POST /api/v1/question-results

Resource: QuestionResult as POST /api/v1/question-results Credit Cost: 1

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

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

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/question-results?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "urlId": "some-page-id",
    "anonUserId": 'anon-0',
    "userId": 'user-0',
    "value": 10,
    "questionId": "some-question-id",
    "meta": [
        {
            name: "example",
            values: ["value-1", "value-2"]
        }
    ]
}'

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

Copy

interface QuestionResultPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface QuestionResultPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';
    /** Included on failure. **/
    reason?: string
    /** The created object. **/
    questionResult?: QuestionResult
}

PATCH /api/v1/question-results/:id

Resource: QuestionResult as PATCH /api/v1/question-results/:id Credit Cost: 1

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

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

Δομή QuestionResult

Copy

interface QuestionResultPatchBody {
    urlId?: string
    anonUserId?: string
    userId?: string
    value?: string
    commentId?: string
    questionId?: string
    meta?: QuestionResultMeta[]
}

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

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/question-results/my-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "value": 5
}'

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

Copy

interface QuestionResultPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Δομή Απάντησης Ενημέρωσης QuestionResult

Copy

interface QuestionResultPatchResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
    /** Included on failure. **/
    reason?: string
}

DELETE /api/v1/question-results/:id

Resource: QuestionResult as DELETE /api/v1/question-results/:id Credit Cost: 1

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

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

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/question-results/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'

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

Copy

interface QuestionResultDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface QuestionResultResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Included on failure. **/
    reason?: string
}

GET /api/v1/question-results-aggregate

Resource: QuestionResultsAggregate as GET /api/v1/question-results-aggregate Credit Cost: 2

Εδώ γίνεται η συγκέντρωση των αποτελεσμάτων.

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

Δομή QuestionResultsAggregationResult

Copy

interface QuestionResultDataPoint {
    /** A map of value to count of occurrences of that value for the current data point (date bucket or page). **/
    v: Map<ValueAsString, number>
    total: number
}
interface QuestionResultsAggregationResult {
    /** Note - is null when timeBucket not specified. **/
    dataByDateBucket?: Map<DateString, QuestionResultDataPoint>
    dataByUrlId?: Map<URLIdString, QuestionResultDataPoint>
    countsByValue?: Map<ValueAsString, number>
    /** The total number of results aggregated. **/
    total: number
    /** The resulting weighted average. It is a float, usually two decimals or fewer. **/
    average: number
    /** A date string representing when this data was calculated, since it might come from cache. **/
    createdAt: string
}

Εδώ είναι οι διαθέσιμες παράμετροι ερωτήματος για συγκέντρωση:

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

Copy

interface QuestionResultsAggregateRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** You can aggregate results for one or more questions. **/
    questionId: string | string[]
    startDate?: string | number
    timeBucket?: 'day' | 'month' | 'year'
    /** Aggregate for a specific page. **/
    urlId?: string
    /** Aggregate for a specific user. **/
    userId?: string
    /** Force recalculate now and update the cache. **/
    forceRecalculate?: boolean
}

Εδώ είναι ένα παράδειγμα αιτήματος:

Παράδειγμα QuestionResultsAggregation

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/question-results-aggregation?tenantId=demo&API_KEY=DEMO_API_SECRET&questionId=some-question-id'

Παράδειγμα απάντησης:

Παράδειγμα Απάντησης QuestionResultsAggregation

Copy

    {
        "average": 8.33,
        "countsByValue": {
            "5": 1,
            "10": 2
        },
        "createdAt": "2023-08-30T00:00:00.000Z",
        "dataByUrlId": {
            "some-page": {
                "total": 3,
                "v": {
                    "5": 1,
                    "10": 2
                }
            }
        },
        "total": 3
    }

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

Copy

interface QuestionResultsAggregationResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    data: QuestionResultsAggregationResult
}

Σημειώσεις Απόδοσης

Για αστοχία προσωρινής μνήμης, οι συγκεντρώσεις γενικά χρειάζονται πέντε δευτερόλεπτα ανά εκατομμύριο αποτελέσματα.
Διαφορετικά, τα αιτήματα είναι σταθερού χρόνου.

Σημειώσεις Προσωρινής Αποθήκευσης και Κόστους

Όταν καθορίζεται το forceRecalculate, το κόστος είναι πάντα 10, αντί του κανονικού 2.
Αν η προσωρινή μνήμη λήξει και τα δεδομένα επανυπολογιστούν, το κόστος παραμένει σταθερό 2 αν δεν καθοριστεί το forceRecalculate. Η προσωρινή μνήμη λήγει με βάση το μέγεθος του συνόλου δεδομένων που συγκεντρώνεται (μπορεί να κυμαίνεται μεταξύ 30 δευτερολέπτων και 5 λεπτών).
Αυτό γίνεται για να ενθαρρύνει τη χρήση της προσωρινής μνήμης.

GET /api/v1/question-results-aggregate/combine/comments

Resource: QuestionResultsCombinedWithComments as GET /api/v1/question-results-aggregate/combine/comments Credit Cost: 2

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

Μπορείτε να αναζητήσετε μέσω ενός εύρους τιμών (συμπεριλαμβανόμενων), μιας ή περισσότερων ερωτήσεων, και με αρχική ημερομηνία (συμπεριλαμβανόμενη).

Η δομή απάντησης είναι η ακόλουθη:

Δομή QuestionResultsCombinedWithCommentsResponse

Copy

interface SimpleComment {
    id: string
    commenterName: string
    userId?: string
    date: string
    commentHTML: string
}
interface SimpleQuestionResult {
    id: string
    value: number
}
interface CommentAndResult {
    comment: SimpleComment
    result: SimpleQuestionResult
}
interface QuestionResultsCombinedWithCommentsResponse {
    /** A date string representing when this data was calculated, since it might come from cache. **/
    createdAt: string
    results: CommentAndResult[]
}

Εδώ είναι οι διαθέσιμες παράμετροι ερωτήματος για συγκέντρωση:

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

Copy

interface QuestionResultsAggregateRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** You can aggregate results for one or more questions. **/
    questionId: string | string[]
    startDate?: string | number
    urlId?: string
    minValue: number
    maxValue: number
    limit?: number
    forceRecalculate?: boolean
}

Εδώ είναι ένα παράδειγμα αιτήματος:

Παράδειγμα QuestionResultsCombineComments

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/question-results-aggregation/combine/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&questionId=some-question-id&minValue=5&maxValue=10'

Παράδειγμα απάντησης:

Παράδειγμα Απάντησης QuestionResultsCombineComments

Copy

{
    "createdAt": "2023-08-30T00:00:00.000Z",
    "results": [
        {
            "comment": {
                "id": "some-id",
                "commentHTML": "test-2",
                "commenterName": "Test",
                "date": "2023-08-30T00:00:00.000Z",
                "userId": "some-user-id"
            },
            "result": {
                "id": "some-id",
                "value": 10
            }
        },
        {
            "comment": {
                "id": "some-id",
                "commentHTML": "test-0",
                "commenterName": "Some Name",
                "date": "2023-08-30T00:00:00.000Z",
                "userId": "some-user-id"
            },
            "result": {
                "id": "some-id",
                "value": 5
            }
        }
    ]
}

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

Copy

interface QuestionResultsCombineCommentsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    data: QuestionResultsCombinedWithCommentsResponse
}

Σημειώσεις Προσωρινής Αποθήκευσης και Κόστους

Όταν καθορίζεται το forceRecalculate, το κόστος είναι πάντα 10, αντί του κανονικού 2.
Αν η προσωρινή μνήμη λήξει και τα δεδομένα επανυπολογιστούν, το κόστος παραμένει σταθερό 2 αν δεν καθοριστεί το forceRecalculate.
Αυτό γίνεται για να ενθαρρύνει τη χρήση της προσωρινής μνήμης.

Δομή Διακριτικού Χρήστη

Το UserBadge είναι ένα αντικείμενο που αντιπροσωπεύει ένα σήμα που έχει ανατεθεί σε έναν χρήστη στο σύστημα FastComments.

Τα σήματα μπορούν να ανατεθούν σε χρήστες αυτόματα με βάση τη δραστηριότητά τους (όπως αριθμός σχολίων, χρόνος απάντησης, κατάσταση βετεράνου) ή χειροκίνητα από τους διαχειριστές του ιστότοπου.

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

Δομή UserBadge

Copy

export interface UserBadge {
    /** Unique identifier for this user badge assignment */
    id: string
    /** ID of the user this badge is assigned to */
    userId: string
    /** ID of the badge definition from the tenant's badge catalog */
    badgeId: string
    /** ID of the tenant that created/assigned this badge */
    fromTenantId: string
    /** When this badge was created (milliseconds since epoch) */
    createdAt?: number
    /** When this badge was received by the user (milliseconds since epoch) */
    receivedAt?: number
    /**
     * The badge type:
     * 0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, 3=CommentsPinned,
     * 4=Veteran, 5=NightOwl, 6=FastReplyTime, 7=ModeratorCommentsDeleted,
     * 8=ModeratorCommentsApproved, 9=ModeratorCommentsUnapproved, 10=ModeratorCommentsReviewed,
     * 11=ModeratorCommentsMarkedSpam, 12=ModeratorCommentsMarkedNotSpam, 13=RepliedToSpecificPage,
     * 14=Manual
     */
    type: number
    /** For threshold-based badges, the threshold value */
    threshold?: number
    /** The name/label of the badge */
    name?: string
    /** Detailed description of the badge */
    description?: string
    /** The text shown on the badge */
    displayLabel?: string
    /** URL to an image shown on the badge */
    displaySrc?: string
    /** Background color for the badge (hex code) */
    backgroundColor?: string
    /** Border color for the badge (hex code) */
    borderColor?: string
    /** Text color for the badge (hex code) */
    textColor?: string
    /** Additional CSS class for styling */
    cssClass?: string
    /** For veteran badges, the time threshold in milliseconds */
    veteranUserThresholdMillis?: number
    /** Whether this badge is displayed on the user's comments */
    displayedOnComments: boolean
    /** The display order of the badge */
    order?: number
}

GET /api/v1/user-badges

Αυτό το endpoint σας επιτρέπει να ανακτήσετε σήματα χρηστών με βάση διάφορα κριτήρια.

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος GET

Copy

Run

curl -X GET "https://fastcomments.com/api/v1/user-badges?tenantId=demo&API_KEY=DEMO_API_SECRET"

Μπορείτε να προσθέσετε διάφορες παραμέτρους ερωτήματος για να φιλτράρετε τα αποτελέσματα:

userId - Λήψη σημάτων για συγκεκριμένο χρήστη
badgeId - Λήψη περιπτώσεων συγκεκριμένου σήματος
type - Φιλτράρισμα κατά τύπο σήματος (0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, κλπ. Δείτε τη δομή UserBadge για πλήρη λίστα)
displayedOnComments - Φιλτράρισμα κατά το αν το σήμα εμφανίζεται στα σχόλια (true/false)
limit - Μέγιστος αριθμός σημάτων που θα επιστραφούν (προεπιλογή 30, μέγιστο 200)
skip - Αριθμός σημάτων που θα παραλειφθούν (για σελιδοποίηση)

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success",
  "userBadges": [
    {
      "id": "badge123",
      "userId": "user456",
      "badgeId": "badgeDef789",
      "fromTenantId": "tenant001",
      "createdAt": 1650532511000,
      "receivedAt": 1650532511000,
      "type": 14,
      "name": "Special Contributor",
      "description": "Awarded to special contributors to our community",
      "displayLabel": "Special",
      "backgroundColor": "#4a5568",
      "textColor": "#ffffff",
      "displayedOnComments": true,
      "order": 1
    },
    {
      "id": "badge124",
      "userId": "user456",
      "badgeId": "badgeDef790",
      "fromTenantId": "tenant001",
      "createdAt": 1650532598000,
      "receivedAt": 1650532598000,
      "type": 0,
      "threshold": 100,
      "name": "Centurion",
      "description": "Made 100 comments",
      "displayLabel": "100",
      "backgroundColor": "#2b6cb0",
      "textColor": "#ffffff",
      "displayedOnComments": true,
      "order": 2
    }
  ]
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Μη Έγκυρο Limit

Copy

{
  "status": "failed",
  "code": "invalid-limit",
  "reason": "The limit (query param: limit) is too large (> 200)."
}

GET /api/v1/user-badges/:id

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

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος GET

Copy

Run

curl -X GET "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET"

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success",
  "userBadge": {
    "id": "badge123",
    "userId": "user456",
    "badgeId": "badgeDef789",
    "fromTenantId": "tenant001",
    "createdAt": 1650532511000,
    "receivedAt": 1650532511000,
    "type": 14,
    "name": "Special Contributor",
    "description": "Awarded to special contributors to our community",
    "displayLabel": "Special",
    "backgroundColor": "#4a5568",
    "textColor": "#ffffff",
    "displayedOnComments": true,
    "order": 1
  }
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Δεν Βρέθηκε

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "The user badge badge123 was not found."
}

POST /api/v1/user-badges

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

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος POST

Copy

Run

curl -X POST "https://fastcomments.com/api/v1/user-badges?tenantId=demo&API_KEY=DEMO_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "userId": "user456",
  "badgeId": "badgeDef789",
  "displayedOnComments": true
}'

Το σώμα του αιτήματος πρέπει να περιέχει τις ακόλουθες παραμέτρους:

userId (απαιτούμενο) - Το ID του χρήστη στον οποίο θα ανατεθεί το σήμα
badgeId (απαιτούμενο) - Το ID του σήματος που θα ανατεθεί
displayedOnComments (προαιρετικό) - Αν το σήμα θα πρέπει να εμφανίζεται στα σχόλια του χρήστη (προεπιλογή true)

Σημαντικές Σημειώσεις:

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

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success",
  "userBadge": {
    "id": "badge123",
    "userId": "user456",
    "badgeId": "badgeDef789",
    "fromTenantId": "tenant001",
    "createdAt": 1650532511000,
    "receivedAt": 1650532511000,
    "type": 14,
    "name": "Special Contributor",
    "description": "Awarded to special contributors to our community",
    "displayLabel": "Special",
    "backgroundColor": "#4a5568",
    "textColor": "#ffffff",
    "displayedOnComments": true,
    "order": 1
  }
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Λείπει το User ID

Copy

{
  "status": "failed",
  "code": "missing-user-id",
  "reason": "User ID (body param: userId) is required."
}

Σφάλμα: Λείπει το Badge ID

Copy

{
  "status": "failed",
  "code": "missing-badge-id",
  "reason": "Badge ID (body param: badgeId) is required."
}

Σφάλμα: Το Σήμα Δεν Βρέθηκε

Copy

{
  "status": "failed",
  "code": "badge-not-found",
  "reason": "The badge badgeDef789 was not found or is not enabled."
}

Σφάλμα: Μη Εξουσιοδοτημένος Χρήστης

Copy

{
  "status": "failed",
  "code": "unauthorized-user",
  "reason": "You can only add badges to users who belong to your tenant or have commented on your site."
}

PUT /api/v1/user-badges/:id

Αυτό το endpoint σας επιτρέπει να ενημερώσετε μια ανάθεση σήματος χρήστη.

Αυτή τη στιγμή, η μόνη ιδιότητα που μπορεί να ενημερωθεί είναι το displayedOnComments, το οποίο ελέγχει αν το σήμα εμφανίζεται στα σχόλια του χρήστη.

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος PUT

Copy

Run

curl -X PUT "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "displayedOnComments": false
}'

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success"
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Λείπει το ID

Copy

{
  "status": "failed",
  "code": "missing-id",
  "reason": "The User Badge ID (url param: id) is missing."
}

Σφάλμα: Δεν Βρέθηκε

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "The user badge badge123 was not found."
}

DELETE /api/v1/user-badges/:id

Αυτό το endpoint σας επιτρέπει να διαγράψετε μια ανάθεση σήματος χρήστη.

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος DELETE

Copy

Run

curl -X DELETE "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET"

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success"
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Λείπει το ID

Copy

{
  "status": "failed",
  "code": "missing-id",
  "reason": "The User Badge ID (url param: id) is missing."
}

Σφάλμα: Δεν Βρέθηκε

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "The user badge badge123 was not found."
}

Δομή Προόδου Διακριτικού Χρήστη

Το UserBadgeProgress είναι ένα αντικείμενο που αντιπροσωπεύει την πρόοδο ενός χρήστη προς την απόκτηση διαφόρων σημάτων στο σύστημα FastComments.

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

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

Δομή UserBadgeProgress

Copy

export interface UserBadgeProgress {
    /** Unique identifier for this progress record */
    id: string
    /** ID of the tenant this progress record belongs to */
    tenantId: string
    /** ID of the user this progress record tracks */
    userId: string
    /** ID of the user's first comment in the system */
    firstCommentId?: string
    /** Date of the user's first comment (milliseconds since epoch) */
    firstCommentDate?: number
    /** Automatically calculated trust factor based on user activity */
    autoTrustFactor?: number
    /** Manually set trust factor by administrators */
    manualTrustFactor?: number
    /** Detailed progress object with various metrics, keys match BadgeType enum */
    progress: {
        /** 0: CommentCount - Count of comments the user has made */
        '0'?: number
        /** 1: CommentUpVotes - Count of upvotes the user has received */
        '1'?: number
        /** 2: CommentReplies - Count of replies the user has made */
        '2'?: number
        /** 3: CommentsPinned - Count of pinned comments the user has */
        '3'?: number
        /** 4: Veteran - User's account age */
        '4'?: number
        /** 5: NightOwl - Times user has posted during nighttime hours */
        '5'?: number
        /** 6: FastReplyTime - Average reply time in milliseconds */
        '6'?: number
        /** 7: ModeratorCommentsDeleted - For moderator badges, comments deleted count */
        '7'?: number
        /** 8: ModeratorCommentsApproved - For moderator badges, comments approved count */
        '8'?: number
        /** 9: ModeratorCommentsUnapproved - For moderator badges, comments unapproved count */
        '9'?: number
        /** 10: ModeratorCommentsReviewed - For moderator badges, comments reviewed count */
        '10'?: number
        /** 11: ModeratorCommentsMarkedSpam - For moderator badges, comments marked as spam count */
        '11'?: number
        /** 12: ModeratorCommentsMarkedNotSpam - For moderator badges, comments marked as not spam count */
        '12'?: number
        /** 13: RepliedToSpecificPage - For each page, count of replies */
        '13'?: Record<string, number>
    }
}

GET /api/v1/user-badge-progress

Αυτό το endpoint σας επιτρέπει να ανακτήσετε εγγραφές προόδου σημάτων χρηστών με βάση διάφορα κριτήρια.

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος GET

Copy

Run

curl -X GET "https://fastcomments.com/api/v1/user-badge-progress?tenantId=demo&API_KEY=DEMO_API_SECRET"

Μπορείτε να προσθέσετε διάφορες παραμέτρους ερωτήματος για να φιλτράρετε τα αποτελέσματα:

userId - Λήψη προόδου για συγκεκριμένο χρήστη
limit - Μέγιστος αριθμός εγγραφών που θα επιστραφούν (προεπιλογή 30, μέγιστο 200)
skip - Αριθμός εγγραφών που θα παραλειφθούν (για σελιδοποίηση)

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success",
  "userBadgeProgresses": [
    {
      "id": "progress123",
      "tenantId": "tenant001",
      "userId": "user456",
      "firstCommentId": "comment789",
      "firstCommentDate": 1650532511000,
      "autoTrustFactor": 0.75,
      "progress": {
        "0": 42,
        "1": 120,
        "2": 15,
        "3": 3,
        "5": 5,
        "6": 1800000,
        "8": 0,
        "7": 0
      }
    },
    {
      "id": "progress124",
      "tenantId": "tenant001",
      "userId": "user789",
      "firstCommentId": "comment790",
      "firstCommentDate": 1650532598000,
      "autoTrustFactor": 0.5,
      "progress": {
        "0": 12,
        "1": 15,
        "2": 4
      }
    }
  ]
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Μη Έγκυρο Limit

Copy

{
  "status": "failed",
  "code": "invalid-limit",
  "reason": "The limit (query param: limit) is too large (> 200)."
}

GET /api/v1/user-badge-progress/:id

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

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος GET

Copy

Run

curl -X GET "https://fastcomments.com/api/v1/user-badge-progress/progress123?tenantId=demo&API_KEY=DEMO_API_SECRET"

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success",
  "userBadgeProgress": {
    "id": "progress123",
    "tenantId": "tenant001",
    "userId": "user456",
    "firstCommentId": "comment789",
    "firstCommentDate": 1650532511000,
    "autoTrustFactor": 0.75,
    "progress": {
      "0": 42,
      "1": 120,
      "2": 15,
      "3": 3,
      "5": 5,
      "6": 1800000,
      "8": 0,
      "7": 0
    }
  }
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Δεν Βρέθηκε

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "The user badge progress progress123 was not found."
}

GET /api/v1/user-badge-progress/user/:userId

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

Παράδειγμα Αιτήματος:

Παράδειγμα Αιτήματος GET

Copy

Run

curl -X GET "https://fastcomments.com/api/v1/user-badge-progress/user/user456?tenantId=demo&API_KEY=DEMO_API_SECRET"

Παράδειγμα Απάντησης:

Απάντηση

Copy

{
  "status": "success",
  "userBadgeProgress": {
    "id": "progress123",
    "tenantId": "tenant001",
    "userId": "user456",
    "firstCommentId": "comment789",
    "firstCommentDate": 1650532511000,
    "autoTrustFactor": 0.75,
    "progress": {
      "0": 42,
      "1": 120,
      "2": 15,
      "3": 3,
      "5": 5,
      "6": 1800000,
      "8": 0,
      "7": 0
    }
  }
}

Πιθανές Απαντήσεις Σφάλματος:

Σφάλμα: Λείπει το Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Σφάλμα: Λείπει το User ID

Copy

{
  "status": "failed",
  "code": "missing-user-id",
  "reason": "The User ID (path param: userId) is missing."
}

Σφάλμα: Δεν Βρέθηκε

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "No badge progress found for user user456 in tenant tenant001."
}

Συμπερασματικά

Ελπίζουμε ότι βρήκατε την τεκμηρίωση του API μας εκτενή και εύκολη στην κατανόηση. Αν βρείτε τυχόν κενά, ενημερώστε μας παρακάτω.

Γλώσσα 🇬🇷 Ελληνικά

Πόροι API

Συναθροίσεις

Αρχεία καταγραφής

Σχόλια

Πρότυπα Email

Hashtags

Διαχειριστές

Αριθμός Ειδοποιήσεων

Ειδοποιήσεις

Σελίδες

Εκκρεμή Συμβάντα Webhook

Χρήστες SSO

Συνδρομές

Ημερήσια Χρήση Ενοικιαστή

Ενοικιαστές

Πακέτα Ενοικιαστών

Χρήστες Ενοικιαστή

Χρήστες

Ψήφοι

Ρυθμίσεις Τομέα

Ρυθμίσεις Ερώτησης

Αποτελέσματα Ερώτησης

Συγκέντρωση Αποτελεσμάτων Ερώτησης

Διακριτικά Χρήστη

Πρόοδος Διακριτικού Χρήστη

Το API του FastComments

Παραγόμενα SDKs

Αυθεντικοποίηση

Σημείωση Ασφαλείας

Επιλογή Αυθεντικοποίησης Πρώτη - Κεφαλίδες

Επιλογή Αυθεντικοποίησης Δεύτερη - Παράμετροι Ερωτήματος

Πόροι API

Χρήση Πόρων

Σημείωση!

Συγκεντρώστε τα δεδομένα σας

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

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

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

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

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

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

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

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

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

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

Δομές

Δομή Αρχείου Καταγραφής Ελέγχου

GET /api/v1/audit-logs

Δομή Σχολίου

Δομή Κειμένου Σχολίου

Tagging

HashTags

GET /api/v1/comments

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

Threads

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

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

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

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

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

Η Απάντηση

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

URL ID

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

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

GET /api/v1/comments/:id

POST /api/v1/comments

PATCH /api/v1/comments/:id

DELETE /api/v1/comments/:id

POST /api/v1/comments/:id/flag

POST /api/v1/comments/:id/un-flag

POST /api/v1/comments/:id/block

POST /api/v1/comments/:id/un-block

Δομή Προτύπου Email

Σημειώσεις

GET /api/v1/email-templates/:id

GET /api/v1/email-templates

PATCH /api/v1/email-templates/:id

POST /api/v1/email-templates