API | FastComments Docs

FastComments API

FastComments pruža API za interakciju sa mnogim resursima. Napravite integracije sa našom platformom, ili čak izradite vlastite klijente!

U ovoj dokumentaciji naći ćete sve podržane resurse koje API dokumentuje zajedno sa tipovima zahtjeva i odgovora.

Za Enterprise korisnike, sav pristup API-ju se bilježi u Dnevniku revizije.

Generisani SDK-ovi

FastComments sada generiše API Spec iz našeg koda (ovo još nije kompletno, ali uključuje mnoge API-je).

Također sada imamo SDK-ove za popularne jezike:

Autentifikacija

API se autentifikuje tako što proslijedite svoj API ključ kao ili X-API-KEY zaglavlje ili API_KEY parametar upita. Također će vam trebati vaš tenantId za pozive API-ja. To se može dobiti na istoj stranici kao i vaš API ključ.

Napomena o sigurnosti

Ove rute su namijenjene da se pozivaju sa servera. NEMOJTE ih pozivati iz preglednika. Time ćete otkriti vaš API ključ - to će omogućiti potpuni pristup vašem nalogu svima koji mogu vidjeti izvorni kod stranice!

Authentication Option One - Headers

Zaglavlje: X-API-KEY
Zaglavlje: X-TENANT-ID

Authentication Option Two - Query Parameters

Parametar upita: API_KEY
Parametar upita: tenantId

API ресурси

Коришћење ресурса

Треба напоменути да се дохватање података са API-ја рачуна као коришћење на вашем налогу.

Сваки ресурс ће у свом одељку навести шта тачно подразумева то коришћење.

Неки ресурси су скупљи за послуживање од других. Сваки endpoint има фиксни трошак у кредитима по позиву API-ја. За неке endpoint-e, број кредита варира у зависности од опција и величине одговора.

API коришћење можете провјерити на страници Аналитика наплате и ажурира се сваких неколико минута.

Напомена!

Препоручујемо да прво прочитате документацију за Pages, како бисте смањили конфузију при одређивању које вредности проследити за urlId у Comment API.

Агрегирајте своје податке

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

Овај API агрегира документе групишући их (ако је groupBy наведен) и примјењујући више операција. Подржане су различите операције (нпр. sum, countDistinct, avg, итд).

Трошак је променљиво. Сваких 500 скенираних објеката кошта 1 API кредит.

Максимална меморија дозвољена по API позиву по подразумеваној поставци је 64MB, и по подразумеваној поставци можете имати само једну агрегaцију која се извршава у једном тренутку. Ако пошаљете више агрегaција истовремено, биће стављене у ред и извршаваће се по редослиједу слања. Очекујуће агрегaције ће чекати највише 60 секунди, након чега ће захтјев истeћи. Појединачне агрегaције могу трајати до 5 минута.

Ако имате managed tenants, можете агрегирати све child tenant ресурсе у једном позиву прослеђивањем parentTenantId query параметра.

Примјери

Примјер: Бројање јединствених

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 }
}

Примјер: Преглед по статусу (approved, reviewed, 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 }
}

Структуре

Структура Aggregate захтева

Copy

export type AggregationOpType = 'sum' | 'countDistinct' | 'distinct' | 'avg' | 'min' | 'max' | 'count';
/** Операција која ће се извршити над пољем */
export interface AggregationOperation {
    /** Поље над којим се извршава операција */
    field: string;
    /** Тип операције */
    op: AggregationOpType;
    /** Опциони алијас за излаз; ако није наведен, израчунава се подразумевани алијас */
    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
};

Структура Aggregate одговора

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 је објекат који представља ревидиран догађај за тенанте који имају приступ овој функцији.

Структура за 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;
}

Дневник ревизија је непроменљив. У њега се такође не може ручно уписивати. Само FastComments.com може одлучити када ће уписати у дневник ревизија. Међутим, ви можете читати из њега преко овог API-ја.

Записи у дневнику ревизија истичу након двије године.

GET /api/v1/audit-logs

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

Ovaj API koristi paginaciju, koja se obezbjeđuje parametrima skip, before, i after. AuditLog zapisi se vraćaju u stranicama po 1000, poredani po when i id.

Dohvatanje svake 1000 zapisa ima trošak kredita od 10.

Po zadanim postavkama dobićete listu s najnovijim stavkama na početku. Na ovaj način možete započeti preuzimanje sa skip=0, paginirati dok ne nađete posljednji zapis koji ste obradili.

Alternativno, možete sortirati od najstarijih prema najnovijim, i paginirati dok ne bude više zapisa.

Sortiranje se može uraditi postavljanjem order na ASC ili DESC. Zadano je ASC.

Upit po datumu je moguć putem before i after kao timestampova sa milisekundama. before i after NISU uključivi.

Primjer cURL zahtjeva za AuditLog

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'

Struktura zahtjeva AuditLog

Copy

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

Struktura odgovora AuditLog

Copy

interface CommentsResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Logovi! **/
    auditLogs: AuditLog[]
}

Структура коментара

Objekat Comment predstavlja komentar koji je ostavio korisnik.

Veza između roditeljskih i podkomentara definiše se preko parentId.

Struktura objekta Comment je sljedeća:

Struktura komentara

Copy

interface Comment {
    /** READONLY: Postavljeno na true ako spam mehanizam odredi da je komentar spam. **/
    aiDeterminedSpam?: boolean
    /** Da li je komentar odobren za prikaz. Postavi se na true prilikom čuvanja komentara, inače će biti skriven. **/
    approved?: boolean
    /** Avatar korisnika. **/
    avatarSrc?: string
    /** Podkomentari. Nisu popunjeni u svim scenarijima. Koristi se kada je asTree postavljeno na true preko API-ja. **/
    children: Comment[]
    /** Neobrađeni komentar koji je ostavio korisnik. **/
    comment: string
    /** READONLY: Komentar korisnika parsiran u HTML. **/
    commentHTML?: string
    /** Email komentatora. Obavezan ako je anonimno komentarisanje isključeno. **/
    commenterEmail?: string
    /** Link komentatora (npr. njihov blog). **/
    commenterLink?: string
    /** Ime komentatora. Uvijek obavezno. Ako nije dostupno, postavite npr. "Anonymous". **/
    commenterName: string
    /** Datum ostavljanja komentara, u UTC epoch formatu. **/
    date: number
    /** 'Prikazna oznaka' za komentar – npr. "Admin", "Moderator" ili nešto poput "VIP User". **/
    displayLabel?: string
    /** Domen na kojem je komentar objavljen. **/
    domain?: string
    /** READONLY: Broj puta koliko je komentar prijavljen/označen. **/
    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
}

Neka od ovih polja su označena kao READONLY - ta polja vraća API, ali ih nije moguće postaviti.

Comment Text Structure

Komentari se pišu u FastComments varijanti markdown-a, što je u suštini markdown plus tradicionalne bbcode oznake za slike, poput [img]path[/img].

Tekst se čuva u dva polja. Tekst koji je korisnik unio čuva se neizmijenjen u polju comment. Ovaj tekst se renduje i sprema u polje commentHTML.

Dozvoljene HTML oznake su b, u, i, strike, pre, span, code, img, a, strong, ul, ol, li, and br.

Preporučuje se renderovanje HTML-a, pošto je to vrlo mali podskup HTML-a i izgradnja renderer-a je prilično jednostavna. Postoji više biblioteka za React Native i Flutter, na primjer, koje u tome pomažu

Možete izabrati da renderujete nenormalizovanu vrijednost polja comment. An example parser is here..

Primjer parsera se također može prilagoditi da radi sa HTML-om i transformiše HTML oznake u očekivane elemente za renderovanje na vašoj platformi.

Tagging

Kada su korisnici označeni u komentaru, informacije se čuvaju u listi nazvanoj mentions. Svaki objekat u toj listi has the following structure.

Objekat spominjanja u komentaru

Copy

Run

interface CommentUserMention {
    /** ID korisnika. Za SSO korisnike, biće prefiksiran vašim tenant ID-jem. **/
    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

Kada se koriste hashtagovi i uspješno se parsiraju, informacije se čuvaju u listi nazvanoj hashTags. Svaki objekat u toj listi has the following structure. Hashtags can also be manually added to the comment hashTags array for querying, if retain is set.

Objekat hashtag-a komentara

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

Ovaj API se koristi za dobavljanje komentara za prikaz korisniku. Na primjer, automatski filtrira neodobrene ili spam komentare.

Pagination

Paginacija se može obaviti na jedan od dva načina, u zavisnosti od zahtjeva za performansama i slučaja upotrebe:

Fastest: Prekalkulisana paginacija:
1. Ovako FastComments radi kada koristite naše unaprijed izgrađene widgete i klijente.
2. Klik na "next" jednostavno povećava broj stranice.
3. Možete ovo smatrati dohvaćenim iz key-value skladišta.
4. Na ovaj način, jednostavno definirajte parametar page koji počinje od 0 i smjer sortiranja kao direction.
5. Veličine stranica se mogu prilagoditi putem pravila za prilagodbu.
Most Flexible: Fleksibilna paginacija:
1. Na ovaj način možete definirati prilagođene parametre limit i skip. Ne šaljite page.
2. Smjer sortiranja direction je također podržan.
3. limit je ukupan broj koji će biti vraćen nakon što se primijeni skip.
  - Primjer: postavite skip = 200, limit = 100 kada je page size = 100 i page = 2.
4. Child komentari se i dalje računaju u paginaciji. Možete zaobići ovo korištenjem opcije asTree.
  - Možete paginirati djecu putem limitChildren i skipChildren.
  - Možete ograničiti dubinu threadova koji se vraćaju putem maxTreeDepth.

Threads

Kada koristite Precalculated Pagination, komentari se grupišu po page-u i komentari u threadovima utiču na ukupnu stranicu.
1. Na ovaj način, threadovi se mogu odrediti na klijentu na osnovu parentId.
2. Na primjer, sa stranicom koja ima jedan komentar najvišeg nivoa i 29 odgovora, i postavljanjem page=0 u API-ju - dobićete samo komentar najvišeg nivoa i 29 djece.
3. Example image here illustrating multiple pages.
Kada koristite Flexible Pagination, možete definirati parametar parentId.
1. Postavite ovo na null da biste dobili samo komentare najvišeg nivoa.
2. Zatim, da biste vidjeli threadove, pozovite API ponovo i pošaljite parentId.
3. Uobičajeno rješenje je napraviti API poziv za komentare najvišeg nivoa, a zatim paralelne API pozive za dobavljanje komentara djece za svaki komentar.
NOVO (od feb 2023.)! Dohvatite kao stablo koristeći &asTree=true.
1. Možete ovo zamisliti kao Fleksibilna paginacija kao stablo.
2. Samo komentari najvišeg nivoa se računaju u paginaciji.
3. Postavite parentId=null da počnete stablo od korijena (morate postaviti parentId).
4. Postavite skip i limit za paginaciju.
5. Postavite asTree na true.
6. Troškovi kredita se povećavaju za 2x, jer naš backend mora uraditi mnogo više posla u ovom scenariju.
7. Postavite maxTreeDepth, limitChildren, i skipChildren po želji.

Trees Explained

Kada koristite asTree, može biti teško razmišljati o paginaciji. Evo korisne grafike:

Dijagram paginacije stabla

Fetching Comments in The Context of a User

API /comments se može koristiti u dva konteksta, za različite slučajeve upotrebe:

Za vraćanje komentara sortiranih i označenih informacijama za izgradnju vlastitog klijenta.
- U tom slučaju, definirajte query parametar contextUserId.
Za dohvat komentara iz vašeg backenda za prilagođene integracije.
- Platforma će podrazumijevati ovo ako nema contextUserId.

Prekalkulisana paginacija komentara

Copy

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

Fleksibilna paginacija komentara

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'

Fleksibilna paginacija komentara u kontekstu korisnika

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'

Fleksibilna paginacija komentara u korisničkom kontekstu samo za komentare najvišeg nivoa

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'

Get Comments as a Tree

Moguće je dobiti komentare vraćene kao stablo, pri čemu paginacija broji samo komentare najvišeg nivoa.

Komentari kao stablo u kontekstu korisnika

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'

Želite da dobijete samo komentare najvišeg nivoa i neposrednu djecu? Evo jednog načina:

Komentari kao stablo sa maksimalnom dubinom

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'

Međutim, u vašem UI možda ćete trebati znati da li da prikažete dugme "show replies" (prikaži odgovore) na svakom komentaru. Kada dohvaćate komentare putem stabla, postoji svojstvo hasChildren koje se dodaje na komentare kada je primjenjivo.

Get Comments as a Tree, Searching by Hash Tag

Moguće je pretraživati po hashtag-u koristeći API, preko cijelog vašeg tenant-a (nije ograničeno na jednu stranicu ili urlId).

U ovom primjeru, izostavljamo urlId, i pretražujemo po više hashtag-ova. API će vratiti samo komentare koji imaju sve tražene hashtag-ove.

Komentari kao stablo u kontekstu korisnika, po hashtag-u

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'

All Request Params

Struktura zahtjeva za komentare

Copy

interface CommentsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** urlId (URL stranice, ili ID članka) sa kojim su komentari povezani. **/
    urlId?: string
    /** Ograniči komentare vraćene za ovog korisnika. **/
    userId?: string
    /** Koristite ovo za pretragu po hashtag-u. Da biste suzili na presjek više hashtag-ova, uradite &hashTag=a&hashTag=b. **/
    hashTag?: string
    /** Smjer sortiranja. Zadano je MR (Najrelevantnije). Druge opcije su OF (Najstarije prvo) i NF (Najnovije prvo). **/
    direction?: 'MR' | 'OF' | 'NF'
    /** Prekalkulisana paginacija: Stranica koju treba dohvatiti, počevši od 0. Pošaljite -1 za sve komentare (do 250). **/
    page?: number
    /** Fleksibilna paginacija: Koliko komentara da vratimo? **/
    limit?: number
    /** Fleksibilna paginacija: Koliko dječjih komentara da vratimo za svaki parent? **/
    limitChildren?: number
    /** Fleksibilna paginacija: Koliko komentara da preskočimo? **/
    skip?: number
    /** Fleksibilna paginacija: Koliko dječjih komentara da preskočimo za svaki parent? **/
    skipChildren?: number
    /** Za određivanje blokiranih i prijavljenih komentara. **/
    contextUserId?: string
    /** Za određivanje blokiranih i prijavljenih komentara. **/
    anonUserId?: string
    /** Za dohvat podkomentara. **/
    parentId?: string
    /** Za dohvat kao stablo. **/
    asTree?: boolean
    /** Koliko duboko u stablu da vratimo podatke? 0 vraća nijedno dijete. 1 vraća neposrednu djecu, itd. **/
    maxTreeDepth?: number
}

The Response

Struktura odgovora za komentare

Copy

interface CommentsResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Komentari! **/
    comments: Comment[]
}

Helpful Tips

URL ID

Vjerojatno ćete željeti koristiti Comment API sa parametrom urlId. Možete prvo pozvati Pages API, da vidite kako izgledaju vrijednosti urlId dostupne vama.

Anonymous Actions

Za anonimno komentiranje vjerojatno ćete htjeti poslati anonUserId prilikom dohvaćanja komentara, kao i prilikom označavanja i blokiranja.

(!) Ovo je zahtjev za mnoge prodavnice aplikacija jer korisnici moraju moći prijaviti sadržaj koji su korisnici kreirali i koji mogu vidjeti, čak i ako nisu prijavljeni. Nepostupanje po tome može uzrokovati da vaša aplikacija bude uklonjena iz navedene prodavnice.

Comments Not Being Returned

Provjerite da li su vaši komentari odobreni i da nisu spam.

GET /api/v1/comments/:id

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

Овај API омогућава преузимање појединачног коментара по id-ју.

Пример cURL захтјева за добијање коментара по ID-ју

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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'missing-id'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Коментар! **/
    comment?: Comment
}

POST /api/v1/comments

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

Ова API крајња тачка омогућава креирање коментара.

Уобичајени случајеви употребе су прилагођени кориснички интерфејси, интеграције или увози.

Напомене:

Овај API може ажурирати видгет коментара „у живо“ ако је потребно (ова опција повећава creditsCost са 1 на 2).
Овај API ће аутоматски креирати објекте корисника у нашем систему ако је е-пошта обезбеђена.
Покушај да се сачувају два коментара са различитим е-поштама, али истим корисничким именом, резултираће грешком за други коментар.
Ако одредите parentId, и ако подкоментар има notificationSentForParent постављено на false, послаћемо обавештења за родитељски коментар. То се ради на сваких сат времена (групишемо обавештења заједно да бисмо смањили број послатих имејлова).
Ако желите слање добродошлих имејлова при креирању корисника, или имејлова за верификацију коментара, поставите sendEmails на true у параметрима упита.
Коментари креирани овим API-јем ће се појавити на страницама Аналитике и Модерације у административној апликацији.
„лоше речи“ су и даље маскиране у именима коментатора и тексту коментара ако је та опција укључена.
Коментари креирани овим API-јем и даље могу бити проверавани на спам ако је то потребно.
Конфигурације као што је максимална дужина коментара, ако су подешене преко странице администрације правила прилагођавања (Customization Rule), важе и овде.

Минимални подаци потребни да се пошаљу и приказују у видгету коментара су следећи:

Минимални пример 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'
    /** Да ли коментар треба да се појави "у живо" за кориснике који гледају инстанце видгета коментара са истим urlId. НАПОМЕНА: Дуплира трошак кредита са 1 на 2. **/
    isLive?: 'true' | 'false'
    sendEmails?: 'true' | 'false'
    populateNotifications?: 'true' | 'false'
}

Структура одговора POST захтева за коментар

Copy

interface CommentPostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    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';
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Креирани коментар. **/
    comment?: Comment
    /** Повезани корисник, који можда већ постоји или можда није постојао. **/
    user?: User
}

PATCH /api/v1/comments/:id

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

Овај API ендпоинт омогућава ажурирање једног коментара.

Напомене:

Овај API може ажурирати виџет коментара "live" ако је потребно (ово повећава основни creditsCost са 1 на 2).
- Ово може учинити миграције коментара између страница "live" (промјена urlId).
- Миграције коштају додатна 2 кредита јер се странице предрачунавају и то је интензивно за CPU.
За разлику од create API, овај API НЕће аутоматски креирати корисничке објекте у нашем систему ако је обезбијеђен email.
Коментари ажурирани путем овог API-ја и даље се могу провјерити на спам ако је то жељено.
Конфигурације као што је максимална дужина коментара, ако су подешене преко странице за администрацију правила прилагођавања (Customization Rule admin page), важиће овдје.
Да бисте дозволили корисницима да ажурирају текст свог коментара, можете једноставно навести comment у тијелу захтјева. Ми ћемо генерисати резултујући commentHTML.
- Ако дефинишете и comment и commentHTML, ми аутоматски нећемо генерисати HTML.
- Ако корисник дода помињања или хештегове у свом новом тексту, они ће и даље бити обрађени као код POST API-ја.
Када ажурирате commenterEmail на коментару, најбоље је такође навести userId. У супротном, морате осигурати да корисник са тим email-ом припада вашем tenant-у, иначе ће захтјев пропасти.

Минимални cURL примјер за PATCH коментара

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
    /** Корисник који врши ажурирање. По потреби се може користити за провјеру да ли могу уређивати коментар.  **/
    contextUserId?: string
    /** Да ли да провјеримо да ли нови коментар изгледа као спам?  **/
    doSpamCheck?: 'true' | 'false'
    /** Да ли коментар треба да се појави "live" корисницима који гледају инстанце виџета за коментаре са истим `urlId`. НАПОМЕНА: Удваја трошак кредита са 1 на 2. **/
    isLive?: 'true' | 'false'
}

Структура PATCH одговора за коментар

Copy

interface CommentPatchResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    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'
    /** Укључено у случају неуспјеха. **/
    reason?: string
}

DELETE /api/v1/comments/:id

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

Овај API ендпоинт омогућава брисање коментара.

Напомене:

Овај API може ажурирати видгет коментара "у реалном времену" ако је то жељено (ово повећава 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
    /** Корисник који врши ажурирање. Ако је потребно, може се користити да се провери да ли тај корисник може обрисати коментар.  **/
    contextUserId?: string
    /** Да ли би коментар требало бити обрисан "у реалном времену" за кориснике који прегледају инстанце видгета коментара са истим urlId. НАПОМЕНА: Дуплира трошак кредита са 1 на 2. **/
    isLive?: 'true' | 'false'
}

Структура одговора за брисање коментара

Copy

interface CommentDeleteResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Укључено у случају неуспјеха. **/
    reason?: string
}

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

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

Овај API ендпоинт омогућава означавање коментара за одређеног корисника.

Notes:

Овај позив увијек мора бити направљен у контексту корисника. Корисник може бити FastComments.com User, SSO User, или Tenant User.
Ако је подешен праг за означавање који сакрива, коментар ће бити аутоматски скривен у реалном времену након што буде означен дефинисани број пута.
Након што је аутоматски опозван (скривен) - коментар може поново одобрити само администратор или модератор. Уклањање ознаке неће поново одобрити коментар.

Пример 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'

For anonymous flagging, we must specify an anonUserId. This can be an ID that represents the anonymous session, or a random UUID. This allows us to support flagging and un-flagging comments even if a user is not logged in. This way, the comment can be marked as flagged when comments are fetched with the same 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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Да ли је коментар аутоматски опозван (скривен) због превеликог броја ознака? **/
    wasUnapproved?: boolean;
}

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

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

Ovaj API endpoint omogućava poništavanje označavanja (un-flag) komentara za određenog korisnika.

Napomene:

Ovaj poziv uvijek mora biti izvršen u kontekstu korisnika. Korisnik može biti FastComments.com User, SSO User, ili Tenant User.
Nakon što je komentar automatski označen kao neodobren (skriven) — komentar može ponovo biti odobren samo od strane administratora ili moderatora. Uklanjanje oznake (un-flag) neće ponovo odobriti komentar.

Primjer cURL zahtjeva za uklanjanje oznake komentara

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'

Za anonimno označavanje, moramo navesti anonUserId. To može biti ID koji predstavlja anonimnu sesiju, ili nasumični UUID.

Primjer cURL zahtjeva za uklanjanje oznake anonimnog komentara

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'

Struktura zahtjeva za uklanjanje oznake komentara

Copy

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

Struktura odgovora za uklanjanje oznake komentara

Copy

interface CommentUnFlagResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

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

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

Овај API endpoint пружа могућност блокирања корисника који је написао одређени коментар. Подржава блокирање коментара написаних од FastComments.com Users, SSO Users, и Tenant Users.

Подржава body параметар commentIdsToCheck који провјерава да ли би други потенцијално видљиви коментари на клијенту требало да буду блокирани/деблокирани након извршења ове акције.

Напомене:

Овај позив мора увијек бити направљен у контексту корисника. Корисник може бити FastComments.com User, SSO User, или Tenant User.
userId у захтјеву је корисник који извршава блокирање. На примјер: User A жели да блокира User B. Прослиједите userId=User A и id коментара који је написао User B.
Потпуно анонимни коментари (није присутан user id, нема е-поште) не могу бити блокирани и биће враћена грешка.

Примјер 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'
    /** Укључено у случају неуспјеха. **/
    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'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Ако је commentIdsToCheck дефинисан, уноси у овој мапи који имају вриједност true ће такође бити блокирани. **/
    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 ендпоинт омогућава уклањање блокаде корисника који је написао одређени коментар. Подржава уклањање блокаде за коментаре написане од стране FastComments.com Users, SSO Users, и Tenant Users.

Подржава commentIdsToCheck параметар у тијелу захтјева за провјеру да ли неки други потенцијално видљиви коментари на клијенту требају бити блокирани/одблокирани након извршења ове акције.

Напомене:

Овaј позив увијек мора бити направљен у контексту корисника. Корисник може бити FastComments.com User, SSO User, или Tenant User.
userId у захтјеву је корисник који уклања блокаду. На примјер: User A жели да уклони блокаду User B. Прослиједите userId=User A и ид коментара који је User B написао.
Потпуно анонимни коментари (без user id, без е-поште) не могу бити блокирани и вратиће се грешка.

Примјер 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'
    /** Укључено у случају неуспјеха. **/
    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'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Ако је commentIdsToCheck дефинисан, уноси у овој мапи који су true су и даље блокирани. Ако су false, можда ћете желети да поново прикажете коментаре кориснику да не мора да освежи страницу. **/
    commentStatuses?: Record<string, boolean>;
}

Структура шаблона е-поште

An EmailTemplate object represents configuration for a custom email template, for a tenant.

The system will select the email template to use via:

Its type identifier, we call this emailTemplateId. These are constants.
The domain. We will first try to find a template for the domain that the related object (like a Comment) is tied to, and if a match is not found then we will try to find a template where domain is null or *.

The structure for the EmailTemplate object is as follows:

Struktura predloška e-pošte

Copy

interface EmailTemplate {
    id: string
    tenantId: string
    emailTemplateId: string
    displayName: string
    /** SAMO ZA ČITANJE **/
    createdAt: string
    /** SAMO ZA ČITANJE **/
    updatedAt: string
    /** SAMO ZA ČITANJE **/
    updatedByUserId: string
    /** Domena s kojom predložak treba biti povezan. **/
    domain?: string | '*' | null
    /** Sadržaj email predloška u EJS sintaksi. **/
    ejs: string
    /** Mapa zamijenjenih prevodnih ključeva na vrijednosti, za svaki podržani lokal. **/
    translationOverridesByLocale: Record<string, Record<string, string>>
    /** Objekt koji predstavlja kontekst renderiranja predloška. **/
    testData: object
}

Notes

You can get the valid emailTemplateId values from the /definitions endpoint.
The /definitions endpoint also includes the default translations and test data.
Templates will fail to save with invalid structure or test data.

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

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

Pojedinačni EmailTemplates se mogu dohvatiti po odgovarajućem id-u (NE emailTemplateId).

EmailTemplate po ID cURL primjer

Copy

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

Struktura zahtjeva za EmailTemplate po ID

Copy

interface EmailTemplatesByIdRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za EmailTemplate po ID

Copy

interface EmailTemplateResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
    /** Uključeno u slučaju greške. **/
    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.

Примјер cURL за EmailTemplate

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
    /** Страница за преузимање, почиње од 0. **/
    page: number
}

Структура одговора EmailTemplate

Copy

interface EmailTemplatesResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    emailTemplates: EmailTemplate[]
}

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

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

Ovaj API endpoint omogućava ažuriranje email predloška tako što se navede samo id i atributi koje treba ažurirati.

Imajte na umu da se sve iste validacije koje važe pri kreiranju predloška također primjenjuju, na primjer:

Predložak se mora renderirati. Ovo se provjerava pri svakom ažuriranju.
Ne možete imati duplikate predložaka za istu domenu (inače bi jedan bio tiho ignorisan).

EmailTemplate PATCH cURL primjer

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 struktura zahtjeva

Copy

interface EmailTemplatePatchQueryParams {
    tenantId: string
    API_KEY: string
}

EmailTemplate PATCH struktura odgovora

Copy

interface EmailTemplatePatchResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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';  
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Ažurirani predložak e-pošte. **/
    emailTemplate?: EmailTemplate
}

POST /api/v1/email-templates

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

Овај API ендпоинт пружа могућност креирања email шаблона.

Напомене:

Не можете имати више шаблона са истим emailTemplateId за исти домен.
Међутим, можете имати wildcard шаблон (domain = * и домен-специфичан шаблон за исти emailTemplateId).
Наглашавање domain је релевантно само ако имате различите домене, или желите користити специфичне шаблоне за тестирање (domain подешен на localhost итд).
Ако наведете domain, он мора одговарати DomainConfig. У случају грешке пружа се листа валидних домена.
Синтакса шаблона је EJS и рендерује се са тајмаутом од 500ms. P99 за рендеровање је <5ms, тако да ако достигнете 500ms нешто није у реду.
Ваш шаблон мора да се рендерује са датим testData да би се сачувао. Грешке при рендеровању се агрегирају и пријављују на контролној табли (ускоро доступно и преко API).

Минимални подаци потребни за додавање шаблона су следећи:

Минимални пример POST cURL за EmailTemplate

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:

Примјер POST cURL за EmailTemplate

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",
}'

Структура захтјева POST за EmailTemplate

Copy

interface EmailTemplatePostQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора POST за EmailTemplate

Copy

interface EmailTemplatePostResponse {
    status: 'success' | 'failed'
    /** Укључено при неуспјеху. **/
    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';
    /** Укључено при неуспјеху. **/
    reason?: string
    /** Креирани шаблон. **/
    emailTemplate?: EmailTemplate
}

POST /api/v1/email-templates/render

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

Ovaj API endpoint omogućava pregled predložaka e-pošte.

Minimalni primjer POST cURL pregleda EmailTemplate

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 %>."
}'

Struktura POST zahtjeva za EmailTemplate

Copy

interface EmailTemplatePostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura POST odgovora za EmailTemplate

Copy

interface EmailTemplatePostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'does-not-render';
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Renderovani HTML u slučaju uspjeha. **/
    html?: string
}

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

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

Ova ruta omogućava uklanjanje jednog EmailTemplate po id-u.

Primjer cURL zahtjeva za uklanjanje EmailTemplate

Copy

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

Struktura zahtjeva za uklanjanje EmailTemplate

Copy

interface EmailTemplateRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje EmailTemplate

Copy

interface EmailTemplateDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

Структура хештега

Objekat HashTag predstavlja oznaku koju korisnik može ostaviti. HashTags se mogu koristiti za povezivanje sa vanjskim sadržajem ili za povezivanje povezanih komentara.

The structure for the HashTag object is as follows:

Struktura HashTag-a

Copy

interface HashTag {
    /** Treba da počinje sa "#" ili željenim znakom. **/
    tag: string
    /** Opcionalni URL na koji hashtag može upućivati. Umjesto filtriranja komentara po hashtagu, korisnički interfejs će pri kliku preusmjeriti na ovaj URL. **/
    url?: string
    /** SAMO ZA ČITANJE **/
    createdAt: string
}

Notes:

In some API endpoints you will see that the hashtag is used in the URL. Remember to URI-Encoded values. For example, # should instead be represented as %23.
Some of these fields are marked READONLY - these are returned by the API but cannot be set.

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
    /** Страница за преузимање, почиње од 0. **/
    page: number
}

Структура одговора за HashTag

Copy

interface HashTagsResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Хаштагови! **/
    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'
    /** Укључено у случају неуспјеха. **/
    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'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    hashTag?: HashTag; // На успјех враћамо потпуно ажурирани HashTag.
}

POST /api/v1/hash-tags

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

Ovaj endpoint omogućava dodavanje jednog HashTag.

Primjer cURL zahtjeva za kreiranje HashTag-a

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"
}'

Struktura zahtjeva za kreiranje HashTag-a

Copy

interface HashTagPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za kreiranje HashTag-a

Copy

interface HashTagPostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    hashTag?: HashTag; // Pri uspjehu vraćamo kompletno kreirani hashtag.
}

POST /api/v1/hash-tags/bulk

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

Ovaj endpoint omogućava dodavanje do 100 HashTag objekata odjednom.

Primjer cURL zahtjeva za masovno kreiranje HashTag-ova

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"
        }
    ]
}'

Struktura zahtjeva za masovno kreiranje HashTag-ova

Copy

interface HashTagPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za masovno kreiranje HashTag-ova

Copy

interface HashTagBulkPostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    results?: HashTagPostResponse[]; // Vraćamo listu HashTagPostResponse objekata za svaki dostavljeni tag.
}

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

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

Ovaj endpoint omogućava uklanjanje HashTag-a na osnovu proslijeđenog taga.

Imajte na umu da, osim ako automatsko kreiranje HashTag-ova nije onemogućeno, hashtagovi mogu biti ponovo kreirani od strane korisnika koji uključe hashtag prilikom komentarisanja.

Primjer cURL zahtjeva za uklanjanje HashTag-a

Copy

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

Struktura zahtjeva za uklanjanje HashTag-a

Copy

interface HashTagDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora pri uklanjanju HashTag-a

Copy

interface HashTagDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist'
    /** Uključeno u slučaju greške. **/
    reason?: string
}

Структура модератора

Objekat Moderator predstavlja konfiguraciju za moderatora.

Postoje tri tipa moderatora:

Administrator korisnici koji imaju zastavicu isCommentModeratorAdmin.
SSO korisnici sa zastavicom isCommentModeratorAdmin.
Redovni komentatori, ili FastComments.com korisnici, koji su pozvani kao moderatori.

Struktura Moderator se koristi za predstavljanje stanja moderacije u slučaju upotrebe 3.

Ako želite pozvati korisnika da bude moderator putem API-ja, koristite Moderator API kreiranjem Moderator i inviting njima.

Ako korisnik nema FastComments.com nalog, pozivni email će im pomoći da se podese. Ako već imaju nalog, biće im dodan moderacijski pristup vašem tenant-u i Moderator objektu će se ažurirati userId da pokazuje na njihovog korisnika. Nećete imati API pristup njihovom korisniku, jer u ovom slučaju nalog pripada njima i upravlja ga FastComments.com.

Ako zahtijevate potpunu kontrolu nad korisničkim nalogom, preporučujemo ili korištenje SSO-a, ili dodavanje korisnika kao Korisnik tenanta i zatim dodavanje Moderator objekta za praćenje njihove statistike.

Struktura Moderator može se koristiti kao mehanizam za praćenje statistike za slučajeve upotrebe 1 i 2. Nakon kreiranja korisnika, dodajte Moderator objekat sa definisanim userId i njihove statistike će biti praćene na Stranici za moderatore komentara.

Struktura za Moderator objekat je sljedeća:

Struktura moderatora

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-у.

Пример cURL захтева за модератора по id-у

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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    moderator?: Moderator
}

GET /api/v1/moderators

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

Овај API користи пагинацију, коју обезбјеђује параметар упита skip. Модератори се враћају у страницама по 100, сортирани по createdAt и id.

Трошак се заснива на броју враћених модератора и износи 1 credit per 10 за сваких 10 враћених модератора.

Пример cURL захтева за Модератора

Copy

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

Структура захтева за Модератора

Copy

interface ModeratorsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Број модератора које треба прескочити за пагинацију. **/
    skip?: number
}

Структура одговора за Модератора

Copy

interface ModeratorsResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспеха. **/
    reason?: string
    moderators?: Moderator[]
}

PATCH /api/v1/moderators/:id

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

Ovaj API endpoint omogućava ažuriranje Moderator po id.

Ažuriranje Moderator ima sljedeća ograničenja:

Sljedeće vrijednosti se ne smiju dostaviti prilikom ažuriranja Moderator:
- acceptedInvite
- markReviewedCount
- deletedCount
- markedSpamCount
- approvedCount
- editedCount
- bannedCount
- verificationId
- createdAt
Kada je naveden userId, taj korisnik mora postojati.
Kada je naveden userId, on mora pripadati istom tenantId koji je naveden u query parametrima.
Dva moderatora u istom tenantu ne mogu se dodati sa istim email.
Ne smijete mijenjati tenantId povezan sa Moderator.

Moderator PATCH cURL Primjer

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 Struktura zahtjeva

Copy

interface ModeratorPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Moderator PATCH Struktura odgovora

Copy

interface ModeratorPatchResponse {
    status: 'success' | 'failed'
    /** Uključeno pri neuspjehu. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';  
    /** Uključeno pri neuspjehu. **/
    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:

Пример 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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    moderator?: Moderator; // При успјеху враћамо комплетног креираног модератора.
}

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

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

Ova ruta omogućava slanje pozivnice jednom Moderatoru.

Slijedeća ograničenja postoje za slanje email pozivnice Moderatoru:

Moderator mora već postojati.
fromName ne smije biti duži od 100 characters.

Napomene:

Ako korisnik sa navedenim emailom već postoji, bit će pozvan da moderira komentare vašeg tenanta.
Ako korisnik sa navedenim emailom ne postoji link za pozivnicu će ih provesti kroz proces kreiranja naloga.
Pozivnica će isteći nakon 30 days.

Možemo kreirati Moderatora za korisnika čiji email znamo:

Primjer cURL zahtjeva za pozivnicu moderatoru

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'

Ovo će poslati e-mail poput Bob at TenantName is inviting you to be a moderator...

Struktura zahtjeva za pozivnicu moderatora

Copy

interface ModeratorSendInviteQueryParams {
    tenantId: string
    API_KEY: string
    /** E-mail poslan korisniku će izgledati kao da je poslan s ovog imena. **/
    fromName: string
}

Struktura odgovora za pozivnicu moderatora

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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
    /** Укључено у случају неуспјеха. **/
    reason?: string
}

Структура броја обавештења

Objekat NotificationCount predstavlja broj nepročitanih obaveštenja i metapodatke za korisnika.

Ako nema nepročitanih obaveštenja, za korisnika neće postojati NotificationCount.

NotificationCount objekti se kreiraju automatski i ne mogu se kreirati putem API-ja. Takođe ističu nakon jedne godine.

Možete obrisati broj nepročitanih obaveštenja korisnika brisanjem njihovog NotificationCount.

Struktura za NotificationCount objekat je sljedeća:

Struktura NotificationCount objekta

Copy

interface NotificationCount {
    id: string // ID korisnika
    count: number
    createdAt: string // datum kao string
    expireAt: string // datum isteka kao string
}

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

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

Ова рута враћа појединачни NotificationCount по user id. Са SSO-ом, user id је у формату <tenant id>:<user id>.

Ако нема непрочитаних обавијести, неће постојати NotificationCount - па ћете добити 404.

Ово се разликује од notifications/count тиме што је много брже, али не дозвољава филтрирање.

cURL примјер NotificationCount по ID

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'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
    /** Укључено у случају неуспеха. **/
    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>.

Ово ће очистити број непрочитаних обавештења корисника (црвено звонце у коментарском виџету ће избледети и број ће нестати).

Пример cURL захтева за брисање NotificationCount

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'
    /** Укључено при неуспеху. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
    /** Укључено при неуспеху. **/
    reason?: string
}

Структура обавештења

Objekat Notification predstavlja obavještenje za korisnika.

Notification objekti se stvaraju automatski i ne mogu se kreirati putem API-ja. Također ističu nakon jedne godine. Obavještenja ne mogu biti izbrisana. Međutim, mogu se ažurirati da bi se viewed postavio na false, i možete ih pretraživati po viewed.

Korisnik se također može odjaviti od obavještenja za određeni komentar tako što će u obavještenju postaviti optedOut na true. Možete se ponovo prijaviti postavljanjem na false.

Postoje različite vrste obavještenja - provjerite relatedObjectType i type.

Načini na koje se obavještenja kreiraju su prilično fleksibilni i mogu biti pokrenuti u mnogim scenarijima (pogledajte NotificationType).

Trenutno, postojanje Notification zapravo ne implicira da je e-pošta poslana ili da bi trebala biti poslana. Umjesto toga, obavještenja se koriste za feed obavještenja i povezane integracije.

Struktura objekta Notification izgleda ovako:

Struktura obavještenja

Copy

enum NotificationObjectType {
    Comment = 0,
    Profile = 1,
    Tenant = 2
}
enum NotificationType {
    /** Ako vam je neko odgovorio. **/
    RepliedToMe = 0,
    /** Ako je neko odgovorio bilo gdje u niti (čak i potomcima potomaka) niti u kojoj ste komentarisali. **/
    RepliedTransientChild = 1,
    /** Ako je vaš komentar dobio glas. **/
    VotedMyComment = 2,
    /** Ako je ostavljen novi komentar na korijenu stranice na koju ste pretplaćeni. **/
    SubscriptionReplyRoot = 3,
    /** Ako je neko komentarisao vaš profil. **/
    CommentedOnProfile = 4,
    /** Ako imate direktnu poruku. **/
    DirectMessage = 5,
    /** TrialLimits je samo za korisnike tenanta. **/
    TrialLimits = 6,
    /** Ako ste bili @spomenuti. **/
    Mentioned = 7
}
interface Notification {
    id: string
    tenantId: string
    /** Sa SSO, user id je u formatu `<tenant id>:<user id>`. **/
    userId?: string
    /** Kada radite sa SSO, morate se brinuti samo o `userId`. **/
    anonUserId?: string
    /** urlId je skoro uvijek definisan. Opcionalan je samo za notifikacije na nivou tenanta, koje su rijetke. **/
    urlId?: string
    /** URL je keširan za brzu navigaciju do izvora obavještenja. **/
    url?: string
    /** Naslov stranice je keširan za brzo čitanje izvora obavještenja. **/
    pageTitle?: string
    relatedObjectType: NotificationObjectType
    /** Na primjer, id komentara. **/
    relatedObjectId: string
    viewed: boolean
    createdAt: string // string datuma
    type: NotificationType
    fromCommentId?: string
    fromVoteId?: string
    /** fromUserName i fromUserAvatarSrc su keširani ovdje za brzo prikazivanje obavještenja. Ažuriraju se kada je korisnik ažuriran. **/
    fromUserName: string
    fromUserId: string
    fromUserAvatarSrc?: string
    /** Postavite ovo na true da prestanete primati obavještenja za ovaj objekt. **/
    optedOut?: boolean
}

GET /api/v1/notifications

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

This route returns up to 30 Notification objects sorted by createdAt, newest first.

You can filter by userId. With SSO, the user id is in the format <tenant id>:<user id>.

Primjer cURL zahtjeva za nepročitane obavijesti korisnika

Copy

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

Struktura zahtjeva za obavijesti

Copy

interface NotificationsGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Paginacija preskakanjem zapisa. **/
    skip?: number
    /** Filtriranje po korisniku. **/
    userId?: string
    /** Filtriranje po urlId. **/
    urlId?: string
    /** Filtriranje po izvornom komentaru. **/
    fromCommentId?: string
    /** Filtriranje po pročitanom/nepročitanom. **/
    viewed?: 'true' | 'false'
    /** Filtriranje po tipu. **/
    type?: NotificationType
}

Struktura odgovora za obavijesti

Copy

interface NotificationsGetResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    notifications?: Notification[]
}

GET /api/v1/notifications/count

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

Ovaj endpoint vraća objekat koji sadrži broj obavještenja u parametru count.

Ova ruta je sporija od /notification-count/ i košta dvostruko više kredita, ali omogućava filtriranje po više dimenzija.

Možete filtrirati istim parametrima kao i endpoint /notifications, npr. userId. Kod SSO, user id ima format <tenant id>:<user id>.

Primjer cURL zahtjeva za broj nepročitanih obavještenja korisnika

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'

Primjer cURL zahtjeva za broj nepročitanih obavještenja korisnika za određenu stranicu

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'

Struktura zahtjeva za broj obavještenja

Copy

interface NotificationCountGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Filtriraj po korisniku. **/
    userId?: string
    /** Filtriraj po urlId. **/
    urlId?: string
    /** Filtriraj po izvornom komentaru. **/
    fromCommentId?: string
    /** Filtriraj po pročitanom/nepročitanom. **/
    viewed?: 'true' | 'false'
    /** Filtriraj po tipu. **/
    type?: NotificationType
}

Struktura odgovora za broj obavještenja

Copy

interface NotificationCountGetResponse {
    status: 'success' | 'failed'
    /** Uključeno pri grešci. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Uključeno pri grešci. **/
    reason?: string
    count?: number
}

PATCH /api/v1/notifications/:id

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

Ovaj API endpoint omogućava ažuriranje Notification prema id.

Ažuriranje Notification ima sljedeća ograničenja:

Možete ažurirati samo sljedeća polja:
- viewed
- optedOut

Primjer cURL zahtjeva za Notification PATCH

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,
}'

Struktura PATCH zahtjeva za Notification

Copy

interface NotificationPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura PATCH odgovora za Notification

Copy

interface NotificationPatchResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';  
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

Структура странице

Објекат Page представља страницу којој може припадати много коментара. Овај однос је дефинисан помоћу urlId.

Page чува информације као што су наслов странице, број коментара и urlId.

Структура за објекат Page је следећа:

Структура странице

Copy

interface Page {
    id: string
    urlId: string
    url: string
    title?: string
    createdAt: string
    commentCount: number
    rootCommentCount: number
    /** Постављање ове вредности на null значи да сви SSO корисници могу видјети страницу. Празна листа значи да је затворена за све кориснике. **/
    accessibleByGroupIds?: string[] | null
    /** Да ли је ова страница затворена за нове коментаре? **/
    isClosed?: boolean
}

GET /api/v1/pages

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

Тренутно можете преузети само све странице (или једну страницу преко /by-url-id) повезане са вашим налогом. Ако желите прецизније претраживање, обратите нам се.

Пример cURL захтева за странице

Copy

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

Структура захтева за странице

Copy

interface PagesRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за странице

Copy

interface PagesResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспеха. **/
    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

Pojedinačne stranice se mogu dohvatiti pomoću odgovarajućeg urlId. Ovo može biti korisno za pronalaženje naslova stranica ili broja komentara.

Primjer cURL zahtjeva za stranicu po URL ID

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'

Struktura zahtjeva za stranicu po URL ID

Copy

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

Struktura odgovora za stranicu po URL ID

Copy

interface PagesResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
    /** Uključeno u slučaju greške. **/
    reason?: string
    page?: Page[] | null
}

Koristan savjet

Ne zaboravite URI enkodirati vrijednosti poput urlId.

PATCH /api/v1/pages/:id

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

Ova ruta omogućava ažuriranje jedne Page. Odgovarajući komentari će biti ažurirani.

Primjer cURL zahtjeva za ažuriranje stranice

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"
}'

Struktura zahtjeva za ažuriranje stranice

Copy

interface PagePatchQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za ažuriranje stranice

Copy

interface PagePatchResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    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'
    /** Uključeno u slučaju greške. **/
    reason?: string
    user?: Page; // U slučaju uspjeha vraćamo kompletno ažuriranu stranicu.
}

Napomena

Neki parametri u objektu Page se automatski ažuriraju. To su counts i title atributi. Counts cannot be updated via the API since they are calculated values. The page title can be set via the API, but would get overwritten if the comment widget is used on a page with the same urlId and a different page title.

POST /api/v1/pages

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

Ovaj API endpoint omogućava kreiranje stranica.

Uobičajen slučaj upotrebe je kontrola pristupa.

Notes:

Ako ste komentarisali na threadu komentara, ili pozvali API da kreirate Comment, već ste kreirali Page objekat! Možete pokušati da ga dohvatite putem /by-url-id Page rute, prosljeđujući isti urlId koji je proslijeđen widgetu za komentare.
Struktura Page sadrži neke izračunate vrijednosti. Trenutno su to commentCount i rootCommentCount. Popunjavaju se automatski i ne mogu se postaviti preko API-ja. Pokušaj postavljanja će uzrokovati da API vrati grešku.

Primjer cURL zahtjeva za Page POST

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"]
}'

Struktura zahtjeva za Page POST

Copy

interface PagePostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za Page POST

Copy

interface PagePostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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';  
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Kreirana stranica. **/
    page?: Page
}

DELETE /api/v1/pages/:id

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

Ova ruta omogućava uklanjanje pojedinačne stranice po id-u.

Imajte na umu da će interakcija sa widgetom za komentare na stranici sa istim urlId jednostavno ponovo kreirati Page.

Primjer cURL zahtjeva za uklanjanje stranice

Copy

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

Struktura zahtjeva za uklanjanje stranice

Copy

interface PageDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje stranice

Copy

interface PageDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'page-does-not-exist'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

Структура чекајућег вебхук догађаја

Објекат PendingWebhookEvent представља webhook догађај који је стављен у ред и чека.

PendingWebhookEvent објекти се аутоматски креирају и не могу се ручно креирати преко API-ја. Такође истичу након једне године. Могу се обрисати чиме се задатак уклања из реда.

Постоје различите врсте догађаја — проверите eventType (OutboundSyncEventType) и type (OutboundSyncType).

Чест случај употребе овог API-ја је имплементација прилагођеног надзора. Можда ћете желети повремено позивати /count ендпоинт да бисте периодично провјеравали број преосталих задатака за одређене филтере.

Структура објекта PendingWebhookEvent је следећа:

Структура PendingWebhookEvent

Copy

enum OutboundSyncEventType {
    Create: 0,
    Delete: 1,
    Update: 2
}
enum OutboundSyncType {
    /** Задатак синхронизације специфичан за WordPress. **/
    WP: 0,
    Webhook: 1
}
interface PendingWebhookEvent {
    id: string
    /** ИД коментара повезан са догађајем. **/
    commentId: string
    /** Објекат коментара за догађај у тренутку догађаја. Почели смо да их додајемо у новембру 2023. **/
    comment: Comment
    /** Спољни ИД који може бити повезан са коментаром. **/
    externalId: string | null
    createdAt: Date
    tenantId: string
    attemptCount: number
    /** Поставља се пре првог покушаја и након сваког неуспеха. **/
    nextAttemptAt: Date
    /** Да ли је ово догађај креирања, брисања или ажурирања... **/
    eventType: OutboundSyncEventType
    /** Врста синхронизације која ће се извршити (WordPress, позив API-ја, итд). **/
    type: OutboundSyncType
    /** Домен који је одговарао коментару. Користимо овај домен да изаберемо API кључ. **/
    domain: string
    /** Последња грешка која се десила. Овај тип није типизиран и представља "dump" онога што се десило. Обично садржи објекат са statusCode, body, и мапом headers. **/
    lastError: object | null
}

GET /api/v1/pending-webhook-events

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

Ова рута враћа листу pending webhook догађаја под параметром pendingWebhookEvents.

Овај API користи пагинацију коју обезбјеђује параметар skip. PendingWebhookEvents се враћају у страницама од 100, сортирано по createdAt од најновијих према најстаријим.

cURL пример за PendingWebhookEvent

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
    /** Претрага догађаја са бројем покушаја већим од наведеног. **/
    attemptCountGT?: number
}

Структура одговора за PendingWebhookEvent

Copy

interface PendingWebhookEventsGetResponse {
    status: 'success' | 'failed'
    /** Укључено у случају грешке. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Укључено у случају грешке. **/
    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

cURL примјер за број PendingWebhookEvent

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
    /** Упит за догађаје чији је број покушаја већи од наведене вриједности. **/
    attemptCountGT?: number
}

Структура одговора за број PendingWebhookEvent

Copy

interface PendingWebhookEventsCountResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    count?: number
}

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

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

Ova ruta omogućava brisanje jednog PendingWebhookEvent.

Ako vam treba masovno brisanje, pozovite GET API sa paginacijom, a zatim pozovite ovaj API sekvencijalno.

cURL primjer za DELETE PendingWebhookEvent

Copy

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

Struktura zahtjeva za brisanje PendingWebhookEvent

Copy

interface PendingWebhookEventDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za brisanje PendingWebhookEvent

Copy

interface PendingWebhookEventDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

Структура SSO корисника

FastComments pruža jednostavno za korištenje SSO rješenje. Ažuriranje informacija o korisniku s integracijom zasnovanom na HMAC-u je jednostavno kao da korisnik učita stranicu sa ažuriranim payload-om.

Međutim, može biti poželjno upravljati korisnikom izvan tog toka, radi bolje konzistentnosti vaše aplikacije.

SSO User API pruža način za CRUD objekata koje zovemo SSOUsers. Ovi objekti se razlikuju od regularnih Users i čuvaju se odvojeno radi tip-sigurnosti.

Struktura SSOUser objekta je sljedeća:

Struktura 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 ovlašćenje - SSO korisnici sa ovom oznakom se naplaćuju kao SSO administratori (odvojeno od regularnih SSO korisnika)
    isAdminAdmin?: boolean // Admin ovlašćenje - SSO korisnici sa ovom oznakom se naplaćuju kao SSO administratori (odvojeno od regularnih SSO korisnika)
    isCommentModeratorAdmin?: boolean // Moderator ovlašćenje - SSO korisnici sa ovom oznakom se naplaćuju kao SSO moderatori (odvojeno od regularnih SSO korisnika)
    /** Ako je null, Kontrola pristupa se neće primijeniti na korisnika. Ako je prazan spisak, ovaj korisnik neće moći vidjeti nijednu stranicu niti @mention-ovati druge korisnike. **/
    groupIds?: string[] | null
    createdFromSimpleSSO?: boolean
    /** Ne dozvoljava drugim korisnicima da vide aktivnost ovog korisnika, uključujući komentare, na njegovom profilu. Podrazumijevano je true radi sigurnih profila. **/
    isProfileActivityPrivate?: boolean
    /** Ne dozvoljava drugim korisnicima da ostavljaju komentare na korisnikovom profilu, niti da vide postojeće komentare na profilu. Podrazumijevano false. **/
    isProfileCommentsPrivate?: boolean
    /** Ne dozvoljava drugim korisnicima da šalju direktne poruke ovom korisniku. Podrazumijevano false. **/
    isProfileDMDisabled?: boolean
    karma?: number
    /** Opcionalna konfiguracija za oznake (badges) korisnika. **/
    badgeConfig?: {
        /** Niz ID-jeva oznaka koje će biti dodijeljene korisniku. Ograničeno na 30 oznaka. Redoslijed se poštuje. **/
        badgeIds: string[]
        /** Ako je true, zamjenjuje sve postojeće prikazane oznake sa navedenim. Ako je false, dodaje se postojećim oznakama. **/
        override?: boolean
        /** Ako je true, ažurira prikazne osobine oznaka iz konfiguracije tenanta. **/
        update?: boolean
    }
}

Naplata za SSO korisnike

SSO korisnici se naplaćuju različito u zavisnosti od njihovih zastavica ovlašćenja:

Regular SSO Users: Korisnici bez admin ili moderator ovlašćenja se naplaćuju kao regularni SSO korisnici
SSO Admins: Korisnici sa isAccountOwner ili isAdminAdmin zastavicom se naplaćuju odvojeno kao SSO administratori (ista cijena kao regularni tenant administratori)
SSO Moderators: Korisnici sa isCommentModeratorAdmin zastavicom se naplaćuju odvojeno kao SSO moderatori (ista cijena kao regularni moderatori)

Važno: Da bi se spriječilo dvostruko naplaćivanje, sistem automatski uklanja duplikate SSO korisnika u odnosu na regularne tenant korisnike i moderatore koristeći email adresu. Ako SSO korisnik ima istu email adresu kao regularni tenant korisnik ili moderator, neće biti naplaćen dvaput.

Kontrola pristupa

Korisnici se mogu podijeliti u grupe. Za to služi polje groupIds i opcionalno je.

@Mentions

Po zadanoj postavci @mentions će koristiti username za pretragu drugih sso korisnika kada se utipka znak @. Ako se koristi displayName, rezultati koji odgovaraju username biće ignorisani kada postoji podudaranje za displayName, i rezultati pretrage @mention će koristiti displayName.

Pretplate

Sa FastComments, korisnici se mogu pretplatiti na stranicu klikom na ikonu zvona u widgetu za komentare i klikom na Pretplati se.

Kod regularnog korisnika, šaljemo im email obavještenja na osnovu njihovih postavki obavijesti.

Kod SSO korisnika, razdvojili smo ovo radi kompatibilnosti unazad. Korisnici će dobiti ova dodatna email obavještenja o pretplatama samo ako postavite optedInSubscriptionNotifications na true.

Oznake

Možete dodijeliti oznake SSO korisnicima koristeći svojstvo badgeConfig. Oznake su vizuelni indikatori koji se pojavljuju pored imena korisnika u komentarima.

badgeIds - Niz ID-jeva oznaka koje treba dodijeliti korisniku. Moraju biti važeći ID-jevi oznaka kreirani na vašem FastComments nalogu. Ograničeno na 30 oznaka.
override - Ako je true, sve postojeće oznake prikazane u komentarima će biti zamijenjene navedenim. Ako je false ili izostavljeno, navedene oznake će biti dodane postojećim oznakama.
update - Ako je true, prikazne osobine oznaka će biti ažurirane iz konfiguracije tenanta svaki put kada se korisnik prijavi.

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'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспеха. **/
    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 пример cURL захтева по ID

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'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
    /** Укључено у случају неуспеха. **/
    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

Ovaj endpoint vraća jednog SSO korisnika po njihovoj e-pošti.

SSOUser Po E-pošti cURL Primjer

Copy

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

Struktura zahtjeva za SSOUser

Copy

interface SSOUserRequestByEmailQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za SSOUser

Copy

interface SSOUserByEmailResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-email' | 'user-does-not-exist'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    user: SSOUser
}

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

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

Ova ruta omogućava ažuriranje jednog SSO korisnika.

Primjer cURL za ažuriranje SSOUser

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"
}'

Struktura zahtjeva za ažuriranje SSOUser

Copy

interface SSOUserPatchQueryParams {
    tenantId: string
    API_KEY: string
    /** Kada se promijeni email ili korisničko ime, možete ovo postaviti na true da biste također ažurirali komentare korisnika. Ovo će udvostručiti trošak u kreditima. **/
    updateComments: 'true' | 'false'
}

Struktura odgovora za ažuriranje SSOUser

Copy

interface SSOUserPatchResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-does-not-exist'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    user?: SSOUser; // Vraćamo kompletno ažuriranog korisnika u slučaju uspjeha.
}

POST /api/v1/sso-users

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

Ова рута омогућава креирање једног SSO корисника.

Покушај креирања два корисника са истим ID-ом резултираће грешком.

Примјер cURL захтјева за SSOUser

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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    user?: SSOUser; // Враћамо креираног корисника у случају успјеха.
}

Напомена о интеграцији

Подаци прослијеђени преко API-ја могу се преписати једноставним слањем другачијег SSO User HMAC payload-а. На примјер, ако подесите корисничко име преко API-ја, али потом пошаљете друго корисничко име преко SSO тока при учитавању странице, ми ћемо аутоматски ажурирати њихово корисничко име.

Нећемо ажурирати параметре корисника у овом току осим ако их јасно не назначите или не подесите на 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
    /** Када се промијени имејл или корисничко име, овај параметар можете поставити на true да би се такође ажурирали коментари корисника. Ово ће удвостручити трошкове кредита. **/
    updateComments: 'true' | 'false'
}

SSOUser Структура одговора за ажурирање

Copy

interface SSOUserPutResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    user?: SSOUser; // Враћамо ажурираног корисника у случају успјеха.
}

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

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

Ова рута омогућава уклањање појединачног SSO корисника по његовом id-у.

Имајте на уму да поновно учитавање видгета за коментаре са подацима за овог корисника једноставно поново креира корисника без прекида.

Брисање корисникових коментара је могуће путем query параметра deleteComments. Имајте на уму да ако је ово постављено на true:

Сви корисникови коментари ће бити обрисани одмах.
Сви child (сада сирочни) коментари ће бити обрисани или анонимизовани у зависности од конфигурације странице повезане са сваким коментаром. На примјер, ако је режим брисања теме "anonymize", онда одговори ће остати, а корисникови коментари ће бити анонимизовани. Ово важи само када је commentDeleteMode постављен на Remove (подразумјевана вриједност).
creditsCost постаје 2.

Анонимизовани коментари

Можете задржати корисникове коментаре али их једноставно анонимизовати постављањем commentDeleteMode=1.

Ако су корисникови коментари анонимизовани онда се сљедеће вриједности постављају на null:

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

isDeleted и isDeletedUser су постављени на true.

При приказу, видгет за коментаре ће користити DELETED_USER_PLACEHOLDER (подразумјевано: "[deleted]") за корисниково име и DELETED_CONTENT_PLACEHOLDER за коментар. Ово се може прилагодити преко корисничког интерфејса за прилагођавање видгета.

Примјери

cURL примјер за уклањање SSO корисника

Copy

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

Структура захтјева за уклањање SSO корисника

Copy

enum SSOUserCommentDeleteMode {
    Remove = 0, // подразумјевано
    Anonymize = 1
}
interface SSOUsersDeleteQueryParams {
    tenantId: string
    API_KEY: string
    /** Можете ово поставити на true да бисте такође обрисали корисникове коментаре. Ово ће удвостручити трошак кредита. **/
    deleteComments?: 'true' | 'false'
    /** Можете ово поставити по потреби да одредите како поступити са корисниковим коментарима. **/
    commentDeleteMode?: SSOUserCommentDeleteMode
}

Структура одговора за уклањање SSO корисника

Copy

interface SSOUsersResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    user?: SSOUser; // Враћамо уклоњеног корисника у случају успјеха.
}

Структура претплате

A Subscription object predstavlja pretplatu za korisnika.

Subscription objekti se kreiraju kada korisnik klikne na zvonce za obavještenja u widgetu za komentare i izabere "Pretplati se na ovu stranicu".

Pretplate se također mogu kreirati putem API-ja.

Posjedovanje Subscription objekta uzrokuje generisanje Notification objekata i slanje emailova kada se ostave novi komentari na korijenu pridružene stranice za koju je Subscription. Slanje emailova zavisi od tipa korisnika. Za obične korisnike to zavisi od optedInNotifications. Za SSO korisnike to zavisi od optedInSubscriptionNotifications. Imajte na umu da neke aplikacije možda nemaju pojam web-pristupačne stranice, u tom slučaju jednostavno postavite urlId na id stavke na koju se pretplaćujete (istu vrijednost za urlId koju biste proslijedili widgetu za komentare).

Struktura Subscription objekta je sljedeća:

Struktura Subscription objekta

Copy

interface Subscription {
    id: string
    tenantId: string
    /** Kod SSO, user id ima format `<tenant id>:<user id>`. **/
    userId: string
    anonUserId?: string
    urlId: string
    url?: string
    pageTitle?: string
    createdAt: string // datum u obliku stringa
}

GET /api/v1/subscriptions/:id

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

Ovaj endpoint vraća do 30 Subscription objekata sortiranih po createdAt, najnovije prvo.

Možete filtrirati po userId. Uz SSO, id korisnika je u formatu <tenant id>:<user id>.

cURL primjer pretplata za korisnika

Copy

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

Struktura zahtjeva za pretplate

Copy

interface SubscriptionsGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Paginacija preskakanjem zapisa. **/
    skip?: number
    /** Filtriraj po korisniku. **/
    userId?: string
}

Struktura odgovora za pretplate

Copy

interface SubscriptionsGetResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    subscriptions?: Subscription[]
}

POST /api/v1/subscriptions

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

Ova API krajnja tačka omogućava kreiranje Subscription-a. Imajte na umu da korisnik može imati samo jednu pretplatu po stranici, jer više njih je suvišno, i pokušaj kreiranja više od jedne pretplate za istog korisnika na istoj stranici rezultirat će greškom.

Kreiranje pretplate će rezultirati stvaranjem objekata Notification kada se novi komentar ostavi na korijenu pretplaćenog urlId (kada je parentId komentara null).

Primjer cURL zahtjeva za POST Subscription

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!"
}'

Struktura POST zahtjeva za Subscription

Copy

interface SubscriptionPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura POST odgovora za Subscription

Copy

interface SubscriptionPostResponse {
    status: 'success' | 'failed'
    /** Uključeno pri neuspjehu. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';  
    /** Uključeno pri neuspjehu. **/
    reason?: string
}

DELETE /api/v1/subscriptions/:id

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

Ova ruta briše jedan Subscription objekat po id-u.

Primjer cURL zahtjeva za uklanjanje Subscription objekta

Copy

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

Struktura zahtjeva za uklanjanje Subscription objekta

Copy

interface SubscriptionsDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje Subscription objekta

Copy

interface SubscriptionDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    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: boolean
}

GET /api/v1/tenant-daily-usage

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

Ovaj endpoint omogućava pretragu upotrebe tenanta po godini, mjesecu i danu. Može se vratiti do 365 objekata, a cijena je 1 API kredit na svakih 10 objekata.

Objekti u odgovoru su sortirani po datumu kreiranja (najstariji prvi).

TenantDailyUsage Pretraga cURL Primjer

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 Struktura zahtjeva

Copy

interface TenantDailyUsageQueryParams {
    tenantId: string
    API_KEY: string
    /** Bazirano na UTC. **/
    yearNumber?: number
    /** Indeksirano od 0. Bazirano na UTC. **/
    monthNumber?: number
    /** Indeksirano od 1. Bazirano na UTC. **/
    dayNumber?: number
}

TenantDailyUsage Struktura odgovora

Copy

interface TenantDailyUsageResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenantDailyUsages: TenantDailyUsage[]
}

Структура тенанта

The Tenant дефинише FastComments.com купца. Они се могу креирати преко API-ја од стране тенаната који имају white-label приступ. Тенанти са white-label приступом не могу креирати друге тенанте са white-label (дозвољен је само један ниво угнежђивања).

Структура за објекат Tenant је следећа:

Структура Tenant-а

Copy

export enum SiteType {
    Unknown = 0,
    WordPress = 1
}
/** Ово се такође може обрадити преко DomainConfig API. **/
export interface TenantDomainConfig {
    domain: string
    emailFromName?: string
    emailFromEmail?: string
    createdAt?: string,
    siteType?: FastCommentsSiteType, // највероватније ћете желети Unknown
    logoSrc?: string, // необрађена путања до слике
    logoSrc100px?: string, // прилагођено за минијатуре
    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; // број због "legacy" разлога
    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 - Израчунава се на основу packageId. **/
    hasFlexPricing?: boolean
    /** @readonly **/
    flexLastBilledAmount?: number
    /** @readonly - Израчунава се на основу packageId. **/
    hasAuditing?: boolean
    /** Можете похранити пар кључ-вриједност уз тенанта који можете користити за упит. Кључеви не могу садржати "." или "$", нити бити дужи од 100 знакова. Вриједности не могу бити дужи од 2k знакова. **/
    meta?: Record<string, string | null>
}

GET /api/v1/tenants/:id

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

Ова рута враћа појединачног Tenant-а по ID-у.

Примјер cURL захтјева за Tenant по ID-у

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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    tenant?: Tenant
}

GET /api/v1/tenants

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

Ovaj API vraća tenante kojima upravlja vaš tenant.

Paginacija se obezbjeđuje pomoću query parametra skip. Tenanti se vraćaju u stranicama po 100, poredani po signUpDate i id.

Trošak se zasniva na broju vraćenih tenanata i iznosi 1 credit per 10 vraćenih tenanata.

Primjer cURL zahtjeva

Copy

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

Možete definirati meta parametre na Tenant objektima i pretraživati odgovarajuće tenante. Na primjer, za ključ someKey i meta vrijednost some-value, možemo konstruisati JSON objekat sa ovim parom ključ/vrijednost i zatim ga URI enkodovati kao query parametar za filtriranje:

Primjer cURL upita po meta parametrima

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'

Struktura zahtjeva za Tenant

Copy

interface TenantsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Broj tenanata koje treba preskočiti za paginaciju. **/
    skip?: number
    /** Filtriraj po meta parametrima. **/
    meta?: string
}

Struktura odgovora za Tenant

Copy

interface TenantsResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenants?: Tenant[]
}

POST /api/v1/tenants

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

Ovaj endpoint omogućava dodavanje jednog Tenant.

Kreiranje Tenant ima sljedeća ograničenja:

Polje name je obavezno.
Polje domainConfiguration je obavezno.
Sljedeće vrijednosti se ne smiju navesti pri kreiranju Tenant:
- hasFlexPricing
- lastBillingIssueReminderDate
- flexLastBilledAmount
Vrijednost signUpDate ne smije biti u budućnosti.
Polje name ne smije biti duže od 200 characters.
Polje email ne smije biti duže od 300 characters.
Vrijednost email mora biti jedinstvena među svim tenantima na FastComments.com.
Ne smijete kreirati tenant-e ako roditeljski tenant nema definisan važeći TenantPackage.
- Ako je vaš tenant kreiran putem FastComments.com, ovo ne bi trebao biti problem.
Ne smijete kreirati više tenant-a nego što je definirano u maxWhiteLabeledTenants u vašem paketu.
Morate navesti query parametar tenantId koji je id vašeg parent tenant sa uključenim white labeling-om.

Možemo kreirati Tenant sa samo nekoliko parametara:

Primjer cURL zahtjeva za kreiranje Tenanta

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" } ]
}'

Struktura zahtjeva za kreiranje Tenanta

Copy

interface TenantPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za kreiranje Tenanta

Copy

interface TenantPostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenant?: Tenant; // Vraćamo kompletan kreirani tenant u slučaju uspjeha.
}

PATCH /api/v1/tenants/:id

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

Ова API крајња тачка омогућава ажурирање Tenant по id.

Ажурирање Tenant има следећа ограничења:

Следеће вредности се не могу ажурирати:
- hasFlexPricing
- lastBillingIssueReminderDate
- flexLastBilledAmount
- managedByTenantId
signUpDate не смије бити у будућности.
name не може бити дуже од 200 characters.
email не може бити дуже од 300 characters.
email мора бити јединствен међу свим FastComments.com tenant-има.
Када се billingInfoValid постави на true, billingInfo мора бити укључен у истом захтјеву.
Не можете ажурирати packageId повезан са вашим сопственим tenant-ом.
Не можете ажурирати paymentFrequency повезан са вашим сопственим tenant-ом.

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'
    /** Укључено при неуспјеху. **/
    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'; 
    /** Укључено при неуспјеху. **/
    reason?: string
}

DELETE /api/v1/tenants/:id

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

Ova ruta omogućava uklanjanje Tenant i svih pridruženih podataka (korisnici, komentari, itd.) po id-u.

Sljedeća ograničenja postoje prilikom uklanjanja Tenanta:

Tenant mora biti vaš, ili white-labeled tenant koji vi upravljate.
Parametar upita sure mora biti postavljen na true.

Primjer cURL zahtjeva za uklanjanje Tenanta

Copy

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

Struktura zahtjeva za uklanjanje Tenanta

Copy

interface TenantDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje Tenanta

Copy

interface TenantDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'unsure'
    /** Uključeno u slučaju greške. **/
    reason?: string
}

Структура пакета тенанта

The TenantPackage definiše informacije o paketu dostupnom Tenant-u. Tenant može imati mnogo dostupnih paketa, ali se samo jedan može koristiti u datom trenutku.

A Tenant se ne može koristiti za nikakve proizvode dok njegov packageId ne pokazuje na važeći TenantPackage.

Postoje dvije vrste TenantPackage objekata:

Paketi sa fiksnom cijenom - gdje je hasFlexPricing false.
Fleksibilno određivanje cijene - gdje je hasFlexPricing true.

U oba slučaja ograničenja su definirana na nalogu koji koristi paket, međutim kod Flex paketa tenantu se naplaćuje osnovna cijena plus ono što su koristili, definirano flex* parametrima.

Tenant može imati više tenant paketa i može sam promijeniti paket sa Stranice za informacije o naplati.

Ako ćete sami upravljati naplatom za tenante, i dalje ćete morati definirati paket za svakog tenanta kako biste odredili njihova ograničenja. Jednostavno postavite billingHandledExternally na true na Tenant i oni neće moći sami mijenjati svoje informacije o naplati ili aktivni paket.

Ne smijete kreirati pakete sa većim ograničenjima od roditeljskog tenanta.

Struktura TenantPackage objekta je sljedeća:

Struktura 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 // Trošak po običnom SSO korisniku (bez administratorskih/moderatorskih ovlaštenja)
    flexSSOUserUnit?: null
    flexAPICreditCostCents?: null
    flexAPICreditUnit?: null
    flexModeratorCostCents?: null
    flexModeratorUnit?: null
    flexAdminCostCents?: null
    flexAdminUnit?: null
    flexDomainCostCents?: null
    flexDomainUnit?: null
    flexSSOAdminCostCents?: null // Trošak po SSO korisniku sa administratorskim ovlaštenjima (oznake isAccountOwner ili isAdminAdmin)
    flexSSOAdminUnit?: null
    flexSSOModeratorCostCents?: null // Trošak po SSO korisniku sa moderatorskim ovlaštenjima (oznaka isCommentModeratorAdmin)
    flexSSOModeratorUnit?: null
    flexMinimumCostCents?: null
}

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

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

Ova ruta vraća pojedinačni Tenant Package po id-u.

Primjer cURL zahtjeva za TenantPackage po id-u

Copy

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

Struktura zahtjeva za TenantPackage

Copy

interface TenantPackageByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za TenantPackage

Copy

interface TenantPackageByIdResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenantPackage: TenantPackage
}

GET /api/v1/tenant-packages

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

Ovaj API koristi paginaciju, koja se obezbjeđuje putem query parametra skip. TenantPackages se vraćaju u stranicama po 100, poredane po createdAt i id.

Trošak se zasniva na broju vraćenih tenant paketa, i iznosi 1 kredit za svakih 10 vraćenih tenant paketa.

Primjer cURL zahtjeva za TenantPackage

Copy

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

Struktura zahtjeva za TenantPackage

Copy

interface TenantPackagesRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Broj tenant paketa koje treba preskočiti za paginaciju. **/
    skip?: number
}

Struktura odgovora za TenantPackage

Copy

interface TenantPackagesResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Uključeno u slučaju greške. **/
    reason?: string
    tenantPackages?: TenantPackage[]
}

POST /api/v1/tenant-packages

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

Ovaj endpoint pruža mogućnost dodavanja jednog TenantPackage.

Kreiranje TenantPackage ima sljedeća ograničenja:

Sljedeći parametri su obavezni:
- name
- tenantId
- monthlyCostUSD - Može biti null.
- yearlyCostUSD - Može biti null.
- maxMonthlyPageLoads
- maxMonthlyAPICredits
- maxMonthlyComments
- maxConcurrentUsers
- maxTenantUsers
- maxSSOUsers
- maxModerators
- maxDomains
- hasDebranding
- forWhoText
- featureTaglines
- hasFlexPricing - Ako je true, onda su svi flex* parametri obavezni.
name ne smije biti duže od 50 characters.
Svaki forWhoText item ne smije biti duži od 200 characters.
Svaki featureTaglines item ne smije biti duži od 100 characters.
TenantPackage mora biti "manji" od roditeljskog tenanta. Na primjer, svi max* parametri moraju imati niže vrijednosti od roditeljskog tenanta.
Tenanti sa white-label opcijom mogu imati maksimalno pet paketa.
Samo tenant-i sa pristupom white labeling-u mogu kreirati TenantPackage.
Ne možete dodavati pakete svom vlastitom tenant-u. :)

Možemo kreirati TenantPackage na sljedeći način:

Primjer cURL zahtjeva za kreiranje TenantPackage putem e-maila

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

Struktura zahtjeva za kreiranje TenantPackage

Copy

interface TenantPackagePostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za kreiranje TenantPackage

Copy

interface TenantPackagePostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenantPackage?: TenantPackage; // Vraćamo kompletan kreirani tenant paket pri uspjehu.
}

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

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

Ovaj API endpoint pruža mogućnost ažuriranja TenantPackage po id.

Ažuriranje TenantPackage ima sljedeća ograničenja:

Ako postavite hasFlexPricing na true, tada su svi flex* parametri obavezni u tom istom zahtjevu.
Polje name ne može biti duže od 50 characters.
Svaki element forWhoText ne može biti duži od 200 characters.
Svaki element featureTaglines ne može biti duži od 100 characters.
TenantPackage mora biti "manji" od roditeljskog tenanta. Na primjer, svi max* parametri moraju imati niže vrijednosti nego kod roditeljskog tenanta.
Ne smijete promijeniti tenantId povezan s TenantPackage.

Primjer cURL PATCH za TenantPackage

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",
}'

Struktura PATCH zahtjeva za TenantPackage

Copy

interface TenantPackagePatchQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora PATCH za TenantPackage

Copy

interface TenantPackagePatchResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'; 
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

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

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

Ова рута омогућава уклањање TenantPackage по id.

Не можете уклонити TenantPackage који је у употреби (tenant-ов packageId указује на пакет). Прво ажурирајте Tenant.

cURL пример за уклањање TenantPackage

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'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'package-in-use'
    /** Укључено у случају неуспеха. **/
    reason?: string
}

Структура корисника тенанта

The TenantUser дефинише User који је управљан одређеним tenant-ом. Налог је у потпуној контроли tenant-а са којим је повезан, и њихов налог може бити ажуриран или избрисан преко UI или API-ја.

Tenant корисници могу бити администратори са свим дозволама и приступом Tenant-у, или им могу бити ограничене дозволе само за одређене радње као што су модерација коментара, приступ API кључевима, итд.

Структура за TenantUser објекат је следећа:

Структура TenantUser објекта

Copy

/** Ово је за обавештења. **/
export enum UserDigestEmailFrequency {
    Disabled = -1,
    Daily = 0,
    Weekly = 1,
    Monthly = 2
}
export interface TenantUser {
    id: string
    tenantId: string
    username: string
    /** Веза до блога особе која је коментарисала, на пример. **/
    websiteUrl?: string
    email: string
    signUpDate: number
    createdFromUrlId: string
    createdFromTenantId: string
    verified: boolean
    loginCount: number
    optedInNotifications: boolean
    optedInTenantNotifications: boolean
    hideAccountCode: boolean
    avatarSrc?: string
    /** Да ли корисник прима захтјеве за помоћ од коментатора? **/
    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.

Пример cURL захтева за TenantUser по id

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'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** Укључено у случају неуспеха. **/
    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.

Трошкови се заснивају на броју враћених TenantUsers, и износе 1 credit per 10 враћених TenantUsers.

Пример cURL захтева за TenantUser

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
    /** Број TenantUsers које треба прескочити за пагинацију. **/
    skip?: number
}

Структура одговора TenantUser

Copy

interface TenantUsersResponse {
    status: 'success' | 'failed'
    /** Укључено при неуспеху. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено при неуспеху. **/
    reason?: string
    tenantUsers?: TenantUser[]
}

POST /api/v1/tenant-users

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

Ovaj endpoint omogućava dodavanje jednog TenantUser.

Kreiranje TenantUser-a ima sljedeća ograničenja:

username je obavezno.
email je obavezno.
signUpDate ne smije biti u budućnosti.
locale mora biti na listi Supported Locales.
username mora biti jedinstven na cijelom FastComments.com. Ako je to problem, preporučujemo korištenje SSO umjesto toga.
email mora biti jedinstven na cijelom FastComments.com. Ako je to problem, preporučujemo korištenje SSO umjesto toga.
Ne smijete kreirati više tenant korisnika nego što je definirano u maxTenantUsers u vašem paketu.

Možemo kreirati TenantUser na sljedeći način

Primjer cURL zahtjeva za kreiranje TenantUser-a

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"
}'

Struktura zahtjeva za kreiranje TenantUser-a

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora pri kreiranju TenantUser-a

Copy

interface TenantUserPostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenantUser?: TenantUser; // U slučaju uspjeha vraćamo kompletno kreiranog TenantUser-a.
}

Resource: TenantUser as POST /api/v1/tenant-users/:id/send-login-link Credit Cost: 10

Ова рута омогућава слање линка за пријаву једном TenantUser-у.

Корисно када се корисници масовно креирају и не морате да им објашњавате како да се пријаве на FastComments.com. Ово ће им једноставно послати „магични линк“ за пријаву који истиче након 30 days.

Постоје следећа ограничења за слање линка за пријаву TenantUser-у:

TenantUser мора већ постојати.
Морате имати приступ за управљање Tenant-ом коме TenantUser припада.

Линк за пријаву TenantUser-у можемо послати на следећи начин:

Пример cURL захтева за линк за пријаву TenantUser-а

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'

Ово ће послати имејл попут Bob at TenantName is inviting you to be a moderator...

Структура захтева за линк за пријаву TenantUser-а

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за линк за пријаву TenantUser-а

Copy

interface TenantUserPostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found'
    /** Укључено у случају неуспеха. **/
    reason?: string
}

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

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

Ова рута омогућава ажурирање појединачног TenantUser.

Ажурирање TenantUser има сљедећа ограничења:

signUpDate не смије бити у будућности.
locale мора бити на листи Podržane lokalne postavke.
username мора бити јединствен на цијелом FastComments.com. Ако је то проблем, предлажемо кориштење SSO уместо тога.
email мора бити јединствен на цијелом FastComments.com. Ако је то проблем, предлажемо кориштење SSO уместо тога.
Не можете ажурирати tenantId корисника.

Можемо креирати TenantUser на сљедећи начин

Primjer cURL zahtjeva za ažuriranje TenantUser-a

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"
}'

Struktura zahtjeva za ažuriranje TenantUser-a

Copy

interface TenantUserPatchQueryParams {
    tenantId: string
    API_KEY: string
    /** Kada se промијени email или username, можете поставити ово на 'true' да такође ажурирате коментаре корисника. Ово ће удвостручити трошак кредита. **/
    updateComments: 'true' | 'false'
}

Struktura odgovora za ažурирање TenantUser-a

Copy

interface TenantUserPatchResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    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'
    /** Укључено у случају неуспјеха. **/
    reason?: string
}

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

Resource: TenantUser as DELETE /api/v1/tenant-users/:id Credit Cost: 5

Ovaj endpoint omogućava uklanjanje TenantUser po id-u.

Brisanje komentara korisnika je moguće putem query parametra deleteComments. Imajte na umu da ako je ovo true:

Svi komentari korisnika će biti obrisani uživo.
Svi podređeni (sada siročadi) komentari će biti obrisani ili anonimizirani na osnovu konfiguracije stranice povezanе sa svakim komentarom. Na primjer, ako je način brisanja niti "anonymize", onda će odgovori ostati, a komentari korisnika će biti anonimizirani. Ovo se primjenjuje samo kada je commentDeleteMode postavljen na Remove (podrazumijevana vrijednost).
Vrijednost creditsCost postaje 2.

Anonimizirani komentari

Možete zadržati komentare korisnika, ali ih jednostavno anonimizirati postavljanjem commentDeleteMode=1.

Ako su komentari korisnika anonimizirani, sljedeće vrijednosti se postavljaju na null:

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

isDeleted i isDeletedUser su postavljeni na true.

Pri prikazu, widget komentara će koristiti DELETED_USER_PLACEHOLDER (zadano: "[deleted]") za ime korisnika i DELETED_CONTENT_PLACEHOLDER za sadržaj komentara. Ovo se može prilagoditi putem UI za prilagođavanje widgeta.

Primjeri

Primjer cURL zahtjeva za uklanjanje TenantUser

Copy

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

Struktura zahtjeva za uklanjanje TenantUser

Copy

enum TenantUserCommentDeleteMode {
    Remove = 0, // podrazumijevano
    Anonymize = 1
}
interface TenantUserDeleteQueryParams {
    tenantId: string
    API_KEY: string
    /** Možete ovo postaviti na true da biste također izbrisali komentare korisnika. Ovo će uduplati trošak kredita. **/
    deleteComments?: 'true' | 'false'
    /** Možete ovo postaviti po želji da odredite kako tretirati komentare korisnika. **/
    commentDeleteMode?: TenantUserCommentDeleteMode
}

Struktura odgovora za uklanjanje TenantUser

Copy

interface TenantUserDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

Структура корисника

User je objekat koji predstavlja najčešći zajednički imenitelj svih korisnika.

Imajte na umu da u FastComments imamo više različitih slučajeva upotrebe za korisnike:

Secure SSO
Simple SSO
Tenant Users (For example: Administrators)
Commenters

Ovaj API je za Commenters i korisnike kreirane putem Simple SSO. U suštini, bilo koji korisnik kreiran kroz vašu stranicu može se pristupiti putem ovog API-ja. Tenant Users se također mogu dohvatiti na ovaj način, ali ćete dobiti više informacija koristeći /tenant-users/ API.

Za Secure SSO koristite /sso-users/ API.

Ne možete ažurirati ove tipove korisnika. Oni su kreirali svoj nalog kroz vašu stranicu, pa pružamo osnovni pristup samo za čitanje, ali ne možete praviti izmjene. Ako želite imati ovaj tip toka - morate podesiti Secure SSO.

Struktura za the User object je sljedeća:

Struktura korisnika

Copy

export interface User {
    /** Ovo je također id koji se koristi kao userId na objektima komentara. **/
    id: string
    username: string
    /** Link do bloga komentatora, na primjer. **/
    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

Ова рута враћа једног корисника по ИД-у.

cURL примјер за корисника по ИД-у

Copy

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

Структура захтјева за корисника

Copy

interface UserByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за корисника

Copy

interface UserByIdResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    user?: User
}

Структура гласа

Objekat Vote predstavlja glas koji je ostavio korisnik.

Veza između komentara i glasa je definisana putem commentId.

Struktura objekta Vote je sljedeća:

Struktura objekta 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

Glasovi se moraju dohvatiti pomoću urlId.

Vrste glasova

Postoje tri vrste glasova:

Autentifikovani glasovi, koji se primjenjuju na odgovarajući komentar. Možete ih kreirati putem ovog API-ja.
Autentifikovani glasovi, koji su na čekanju verifikacije, i stoga još nisu primijenjeni na komentar. Ovi se kreiraju kada korisnik koristi FastComments.com mehanizam prijave za glasanje.
Anonimni glasovi, koji se primjenjuju na odgovarajući komentar. Oni se kreiraju zajedno sa anonimnim komentiranjem.

Oni se vraćaju u odvojenim listama u API-ju kako bi se smanjila zabuna.

Primjer cURL zahtjeva

Copy

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

Struktura zahtjeva za glasove

Copy

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

Struktura odgovora za glasove

Copy

interface VotesResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
    /** Uključeno u slučaju greške. **/
    reason?: string
    /** Autorizovani, verifikovani glasovi, primijenjeni na odgovarajuće komentare. **/
    appliedAuthorizedVotes: Vote[]
    /** Anonimni glasovi, primijenjeni na odgovarajuće komentare. **/
    appliedAnonymousVotes: Vote[]
    /** Glasovi koji čekaju verifikaciju, još nisu primijenjeni na odgovarajuće komentare. **/
    pendingVotes: Vote[]
}

Napomene o anonimnim glasovima

Imajte na umu da će anonimni glasovi kreirani putem ovog API-ja pojaviti u listi appliedAuthorizedVotes. Smatraju se autorizovanim jer su kreirani putem API-ja sa API key-om.

Struktura appliedAnonymousVotes je za glasove kreirane bez emaila, API key-a, itd.

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'
    /** Укључено у случају грешке. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'invalid-user-id'
    /** Укључено у случају грешке. **/
    reason?: string
    /** Ауторизовани, верификовани гласови, примењени на одговарајуће коментаре. **/
    appliedAuthorizedVotes: Vote[]
    /** Гласови који чекају верификацију, још нису примењени на одговарајуће коментаре. **/
    pendingVotes: Vote[]
}

POST /api/v1/votes

Resource: Vote as POST /api/v1/votes Credit Cost: 1

Ova ruta omogućava dodavanje jednog autorizovanog Vote. Glasovi mogu biti up (+1) ili down (-1).

Primjer cURL zahtjeva za kreiranje glasa

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'

Primjer cURL zahtjeva za kreiranje anonimnog glasa

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'

Struktura zahtjeva za kreiranje glasa

Copy

interface VotePostQueryParams {
    tenantId: string
    API_KEY: string
    userId?: string
    anonUserId?: string
    commentId: string
    direction: 'up' | 'down'
}

Struktura odgovora za kreiranje glasa

Copy

interface VotePostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    voteId?: string
}

Kreiranje anonimnih glasova

Anonimni glasovi se mogu kreirati postavljanjem anonUserId u parametrima upita umjesto userId.

Ovaj id ne mora odgovarati nijednom korisničkom objektu bilo gdje (otuda anonimno). To je jednostavno identifikator za sesiju, tako da možete ponovo dohvatiti glasove u istoj sesiji, kako biste provjerili je li komentar dobio glas.

Ako nemate nešto što biste nazvali "anonimne sesije" kao što to ima FastComments - možete jednostavno postaviti ovo na nasumični ID, poput UUID-a (iako cijenimo manje identifikatore radi uštede prostora).

Ostale napomene

Ovaj API poštuje postavke na nivou tenant-a. Na primjer, ako onemogućite glasanje za određenu stranicu, i pokušate kreirati glas putem API-ja, to će završiti neuspjehom sa kodom greške voting-disabled.
Ovaj API je prema zadanim postavkama aktivan.
Ovaj API će ažurirati votes odgovarajućeg Comment.

DELETE /api/v1/votes/:id

Resource: Vote as DELETE /api/v1/votes/:id Credit Cost: 1

Ова рута омогућава брисање појединачног 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'

Структура захтјева за брисање гласа

Copy

interface VoteDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за брисање гласа

Copy

interface VoteDeleteResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id'
    /** Укључено у случају неуспјеха. **/
    reason?: string
}

Напомене:

Овај API се придржава подешавања на нивоу тенанта. На примјер, ако онемогућите гласање за одређену страницу, и покушате кроз API да креирате глас, он ће неуспјети са кодом грешке voting-disabled.
Овај API је по подразумјеваном активан.
Овај API ће ажурирати votes одговарајућег Comment.

Структура конфигурације домена

Објекат DomainConfig представља конфигурацију домена за тенанта.

Структура објекта DomainConfig је следећа:

Структура DomainConfig

Copy

interface DomainConfig {
    /** Домен, не URL, као што су "fastcomments.com" или "www.example.com". Може се укључити поддомен ако желите ограничити на поддомен. Максимум 1000 карактера. **/
    domain: string
    /** Име пошиљаоца које се користи при слању е-поште. **/
    emailFromName?: string
    /** From-Email који се користи при слању е-поште. Осигурајте да је SPF подешен тако да mail.fastcomments.com може слати мејлове у име домена коришћеног у овом атрибуту. **/
    emailFromEmail?: string
    /** Само за читање. Када је објекат креиран. **/
    createdAt: string
    /** Лого повезан са овим доменом. Користи се у е-порукама. Користите HTTPS. **/
    logoSrc?: string
    /** Мањи лого повезан са овим доменом. Користите HTTPS. **/
    logoSrc100px?: string
    /** SAMO за SSO. URL који се користи у подножју сваког послатог мејла. Подржава променљиву "[userId]". **/
    footerUnsubscribeURL?: string
    /** SAMO за SSO. Хедери који се користе у сваком послатом мејлу. Корисно, на пример, за подешавање хедера повезаних са отписивањем ради побољшања испоруке. Унос List-Unsubscribe у овом запису, ако постоји, подржава променљиву "[userId]". **/
    emailHeaders?: Record<string, string>
    /** Онемогућити све линкове за отписивање. Не препоручује се, може негативно утицати на стопе испоруке. **/
    disableUnsubscribeLinks?: boolean
    /** DKIM конфигурација. **/
    dkim?: DomainConfigDKIM
}

Структура DKIM конфигурације

Copy

interface DomainConfigDKIM {
    /** Име домена у вашем DKIM запису. **/
    domainName: string
    /** Селектор DKIM кључа који ће се користити. **/
    keySelector: string
    /** Ваш приватни кључ. Почinje са -----BEGIN PRIVATE KEY----- и завршава са -----END PRIVATE KEY----- **/
    privateKey: string
}

За аутентификацију

Конфигурација домена се користи за одређивање који сајтови могу да хостују FastComments видгет за ваш налог. Ово је основни облик аутентификације, што значи да додавање или уклањање било које конфигурације домена може утицати на доступност ваше FastComments инсталације у продукцији.

Не уклањајте и не ажурирајте својство domain објекта Domain Config за домен који је тренутно у употреби, осим ако није намера да се тај домен онемогући.

Ово има исто понашање као уклањање домена из /auth/my-account/configure-domains.

Такође имајте на уму да уклањање домена из My Domains корисничког интерфејса уклониће било коју одговарајућу конфигурацију за тај домен која је можда додата преко тог интерфејса.

За прилагођавање е-поште

Линк за отписивање у подножју е-поруке и функција једнокликовног отписивања коју нуди много клијената за електронску пошту могу се конфигурисати преко овог API-ја дефинисањем footerUnsubscribeURL и emailHeaders, редом.

За DKIM

Након дефинисања ваших DKIM DNS записа, једноставно ажурирајте DomainConfig са вашом DKIM конфигурацијом користећи дефинисану структуру.

GET /api/v1/domain-configs

Resource: Comment as GET /api/v1/domain-configs Credit Cost: 1

Овај API омогућава преузимање свих објеката DomainConfig за тенанта.

Пример cURL захтјева за DomainConfig GET

Copy

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

Структура GET захтјева за DomainConfig

Copy

interface GetDomainConfigsRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Структура GET одговора за DomainConfig

Copy

interface GetDomainConfigsResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Конфигурације! **/
    configurations: DomainConfig[] | null
}

GET /api/v1/domain-configs/:domain

Resource: DomainConfig as GET /api/v1/domain-configs/:domain Credit Cost: 1

Pojedinačni DomainConfigs se mogu dohvatiti po odgovarajućoj domain.

Primjer cURL zahtjeva za konfiguraciju domene

Copy

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

Struktura zahtjeva za konfiguraciju domene

Copy

interface DomainConfigsByDomainRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za konfiguraciju domene

Copy

interface DomainConfigResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    configuration?: DomainConfig | null
}

POST /api/v1/domain-configs

Resource: DomainConfig as POST /api/v1/domain-configs Credit Cost: 1

Ovaj API endpoint omogućava kreiranje konfiguracija domena.

Dodavanje konfiguracije za domen ovlašćuje taj domen za FastComments nalog.

Uobičajeni slučajevi upotrebe ovog API-ja su početno postavljanje, kada je potrebno dodati više domena, ili prilagođena konfiguracija za slanje e-pošte.

Primjer cURL zahtjeva za DomainConfig POST

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]>"
    }
}'

Struktura POST zahtjeva za DomainConfig

Copy

interface DomainConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura POST odgovora za DomainConfig

Copy

interface DomainConfigPostResponse {
    status: 'success' | 'failed'
    /** Uključeno pri neuspjehu. **/
    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';  
    /** Uključeno pri neuspjehu. **/
    reason?: string
    /** Kreirana konfiguracija. **/
    configuration?: DomainConfig
}

PATCH /api/v1/domain-configs/:domain

Resource: DomainConfig as PATCH /api/v1/domain-configs/:domain Credit Cost: 1

Ovaj API endpoint omogućava ažuriranje konfiguracije domena tako što se navode samo domen i atribut koji se ažurira.

DomainConfig PATCH cURL Primjer

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 Struktura zahtjeva

Copy

interface DomainConfigPatchQueryParams {
    tenantId: string
    API_KEY: string
}

DomainConfig PATCH Struktura odgovora

Copy

interface DomainConfigPatchResponse {
    status: 'success' | 'failed'
    /** Uključeno pri neuspjehu. **/
    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';  
    /** Uključeno pri neuspjehu. **/
    reason?: string
    /** Ažurirana konfiguracija. **/
    configuration?: DomainConfig
}

PUT /api/v1/domain-configs/:domain

Resource: DomainConfig as PUT /api/v1/domain-configs/:domain Credit Cost: 1

Ovaj API endpoint omogućava zamjenu konfiguracije domena.

Primjer cURL zahtjeva za DomainConfig PUT

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]>"
    }
}'

Struktura PUT zahtjeva za DomainConfig

Copy

interface DomainConfigPutQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura PUT odgovora za DomainConfig

Copy

interface DomainConfigPutResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    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';  
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Ažurirana konfiguracija. **/
    configuration?: DomainConfig
}

DELETE /api/v1/domain-configs/:domain

Resource: DomainConfig as DELETE /api/v1/domain-configs/:domain Credit Cost: 1

Ova ruta omogućava uklanjanje pojedinačnog DomainConfig po id-u.

Napomena: Uklanjanjem DomainConfig autorizacija te domene za korištenje FastComments će biti opozvana.
Napomena: Ponovnim dodavanjem domene preko UI-ja objekt će biti ponovo kreiran (sa samo poljem domain popunjenim).

Primjer cURL zahtjeva za uklanjanje DomainConfig-a

Copy

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

Struktura zahtjeva za uklanjanje DomainConfig-a

Copy

interface DomainConfigRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje DomainConfig-a

Copy

interface DomainConfigDeleteResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-domain' | 'domain-config-does-not-exist'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

Структура конфигурације питања

FastComments пружа начин за конструисање питања и агрегирање њихових резултата. Пример питања (у даљем тексту названо QuestionConfig) може бити оцена у звездицама, клизач или NPS питање (одређено помоћу type).

Подаци о питањима могу се агрегирати појединачно, заједно, током времена, укупно, по страници итд.

Фрејмворк има све могућности потребне за изградњу клијентских видгета (са вашим сервером испред овог 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
    /** САМО ЗА ЧИТАЊЕ - увећава се за сваки нови одговор. **/
    usedCount: number
    /** Низ датума који означава када је конфигурација последњи пут коришћена (остављен резултат). **/
    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
    /** За пагинацију. Почиње од 0. **/
    skip?: number
}

Структура одговора за QuestionConfig

Copy

interface QuestionConfigByIdResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспеха. **/
    reason?: string
    questionConfigs: QuestionConfig[]
}

GET /api/v1/question-configs/:id

Resource: QuestionConfig as GET /api/v1/question-configs/:id Credit Cost: 1

Ova ruta vraća jedan QuestionConfig prema njegovom id-u.

Primjer cURL zahtjeva za QuestionConfig prema ID-u

Copy

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

Struktura zahtjeva za QuestionConfig

Copy

interface QuestionConfigRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za QuestionConfig

Copy

interface QuestionConfigByIdResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    questionConfig?: QuestionConfig
}

POST /api/v1/question-configs

Resource: QuestionConfig as POST /api/v1/question-configs Credit Cost: 1

Ова API крајња тачка омогућава креирање 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
}'

Структура POST захтева за QuestionConfig

Copy

interface QuestionConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

Структура POST одговора за QuestionConfig

Copy

interface QuestionConfigPostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';  
    /** Укључено у случају неуспеха. **/
    reason?: string
    /** Креирани објекат. **/
    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
    /** Пазите! Промјена type може пореметити извјештавање ако су min/max различити. **/
    type?: QuestionConfigType
    numStars?: number
    min?: number
    max?: number
    defaultValue?: number
    labelNegative?: string
    labelPositive?: string
    subQuestionIds?: string[]
    alwaysShowSubQuestions?: boolean
    reportingOrder?: number
}

cURL примјер за ажурирање QuestionConfig

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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
    /** Укључено у случају неуспјеха. **/
    reason?: string
}

DELETE /api/v1/question-configs/:id

Resource: QuestionConfig as DELETE /api/v1/question-configs/:id Credit Cost: 100

Ovaj endpoint omogućava uklanjanje QuestionConfig po id-u.

Ovo će izbrisati sve odgovarajuće rezultate pitanja (ali ne i komentare). Ovo je dio visokog troška kredita.

Primjer cURL zahtjeva za uklanjanje QuestionConfig

Copy

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

Struktura zahtjeva za uklanjanje QuestionConfig

Copy

interface QuestionConfigDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje QuestionConfig

Copy

interface QuestionConfigResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    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

Овај рутa враћа до 1000 QuestionResults објеката одједном, пагинирано. Трошак је 1 за свакaких 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
    /** За пагинацију. Почиње од 0. **/
    skip?: number
    /** За пагинацију. **/
    limit?: number
    /** Добијте резултате за одређену страницу. **/
    urlId?: string
    /** Добијте резултате од одређеног корисника. **/
    userId?: string
    startDate?: string | number
    questionId?: string | string[]
}

QuestionResults Структура одговора

Copy

interface QuestionResultsResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспеха. **/
    reason?: string
    questionResults: QuestionResults[]
}

GET /api/v1/question-results/:id

Resource: QuestionResult as GET /api/v1/question-results/:id Credit Cost: 1

Ова рута враћа један QuestionResult по његовом id.

Пример cURL захтева за QuestionResult по ID

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'
    /** Укључено у случају неуспеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Укључено у случају неуспеха. **/
    reason?: string
    questionResult?: QuestionResult
}

POST /api/v1/question-results

Resource: QuestionResult as POST /api/v1/question-results Credit Cost: 1

Ovaj API endpoint omogućava kreiranje QuestionResult.

Primjer cURL zahtjeva za QuestionResult POST

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"]
        }
    ]
}'

Struktura POST zahtjeva za QuestionResult

Copy

interface QuestionResultPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura POST odgovora za QuestionResult

Copy

interface QuestionResultPostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';  
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Kreirani objekat. **/
    questionResult?: QuestionResult
}

PATCH /api/v1/question-results/:id

Resource: QuestionResult as PATCH /api/v1/question-results/:id Credit Cost: 1

Ovaj endpoint omogućava ažuriranje pojedinačnog QuestionResult.

Sljedeća struktura predstavlja sve vrijednosti koje se mogu promijeniti:

Struktura QuestionResult

Copy

interface QuestionResultPatchBody {
    urlId?: string
    anonUserId?: string
    userId?: string
    value?: string
    commentId?: string
    questionId?: string
    meta?: QuestionResultMeta[]
}

Primjer cURL zahtjeva za ažuriranje QuestionResult

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

Struktura zahtjeva za ažuriranje QuestionResult

Copy

interface QuestionResultPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za ažuriranje QuestionResult

Copy

interface QuestionResultPatchResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

DELETE /api/v1/question-results/:id

Resource: QuestionResult as DELETE /api/v1/question-results/:id Credit Cost: 1

Ova ruta omogućava brisanje QuestionResult prema id-u.

Primjer cURL zahtjeva za brisanje QuestionResult

Copy

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

Struktura zahtjeva za brisanje QuestionResult

Copy

interface QuestionResultDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za brisanje QuestionResult

Copy

interface QuestionResultResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** Uključeno u slučaju greške. **/
    reason?: string
}

GET /api/v1/question-results-aggregate

Resource: QuestionResultsAggregate as GET /api/v1/question-results-aggregate Credit Cost: 2

Овдје се врши агрегирање резултата.

Структура одговора агрегирања је следећа:

Структура QuestionResultsAggregationResult

Copy

interface QuestionResultDataPoint {
    /** Мапа вриједности на број појављивања те вриједности за тренутну тачку података (датумски сегмент или страница). **/
    v: Map<ValueAsString, number>
    total: number
}
interface QuestionResultsAggregationResult {
    /** Напомена - је null када timeBucket није наведен. **/
    dataByDateBucket?: Map<DateString, QuestionResultDataPoint>
    dataByUrlId?: Map<URLIdString, QuestionResultDataPoint>
    countsByValue?: Map<ValueAsString, number>
    /** Укупни број агрегираних резултата. **/
    total: number
    /** Резултујући важећи просјек. То је float, обично са највише двије децимале. **/
    average: number
    /** Стринг датума који представља када су ови подаци израчунати, јер могу доћи из кеша. **/
    createdAt: string
}

Ово су параметри упита доступни за агрегирање:

Структура захтјева QuestionResultsAggregation

Copy

interface QuestionResultsAggregateRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Можете агрегирати резултате за једно или више питања. **/
    questionId: string | string[]
    startDate?: string | number
    timeBucket?: 'day' | 'month' | 'year'
    /** Агрегирати за одређену страницу. **/
    urlId?: string
    /** Агрегирати за одређеног корисника. **/
    userId?: string
    /** Принуди поновно израчунавање сада и ажурирај кеш. **/
    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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    data: QuestionResultsAggregationResult
}

Напомене о перформансама

Ако нема података у кешу (cache miss), агрегирање обично траје пет секунди по милиону резултата.
Иначе, захтјеви су константног времена.

Напомене о кеширању и трошковима

Када је 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 {
    /** Низ који представља датум када су ови подаци израчунати, јер могу доћи из кеша. **/
    createdAt: string
    results: CommentAndResult[]
}

Ево параметара упита доступних за агрегирање:

Структура захтева QuestionResultsCombineComments

Copy

interface QuestionResultsAggregateRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Можете агрегирати резултате за једно или више питања. **/
    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'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    data: QuestionResultsCombinedWithCommentsResponse
}

Напомене о кеширању и трошковима

When forceRecalculate is specified the cost is always 10, instead of the normal 2.
If the cache expires and data is recalculated, the cost is still a constant 2 if forceRecalculate is not specified.
Ово је да би се подстакло коришћење кеша.

Структура значке корисника

UserBadge је објекат који представља ознаку додељену кориснику у FastComments систему.

Ознаке могу бити аутоматски додељене корисницима на основу њихове активности (као што су број коментара, време одговора, статус ветерана) или ручно од стране администратора сајта.

Структура објекта UserBadge је следећа:

Структура UserBadge

Copy

export interface UserBadge {
    /** Јединствени идентификатор ове додјеле ознаке кориснику */
    id: string
    /** ID корисника којем је ова ознака додељена */
    userId: string
    /** ID дефиниције ознаке из каталога ознака тенанта */
    badgeId: string
    /** ID тенанта који је креирао/доделио ову ознаку */
    fromTenantId: string
    /** Када је ова ознака креирана (милисекунде од епохе) */
    createdAt?: number
    /** Када је корисник примио ову ознаку (милисекунде од епохе) */
    receivedAt?: number
    /** 
     * Тип ознаке: 
     * 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
    /** За ознаке засноване на прагу, вредност прага */
    threshold?: number
    /** Назив/натпис ознаке */
    name?: string
    /** Детаљан опис ознаке */
    description?: string
    /** Текст који се приказује на ознаци */
    displayLabel?: string
    /** URL до слике која се приказује на ознаци */
    displaySrc?: string
    /** Боја позадине ознаке (хекс код) */
    backgroundColor?: string
    /** Боја границе ознаке (хекс код) */
    borderColor?: string
    /** Боја текста на ознаци (хекс код) */
    textColor?: string
    /** Додатна CSS класа за стилизацију */
    cssClass?: string
    /** За ветеранске ознаке, временски праг у милисекундама */
    veteranUserThresholdMillis?: number
    /** Да ли се ова ознака приказује на корисниковим коментарима */
    displayedOnComments: boolean
    /** Редослед приказа ознаке */
    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."
}

Грешка: Неважећи лимит

Copy

{
  "status": "failed",
  "code": "invalid-limit",
  "reason": "The limit (query param: limit) is too large (> 200)."
}

GET /api/v1/user-badges/:id

Овај ендпоинт вам омогућава да преузмете одређену корисничку значку по њеном јединственом 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 (required) - The ID of the user to assign the badge to
badgeId (required) - The ID of the badge to assign
displayedOnComments (optional) - Whether the badge should be displayed on the user's comments (defaults to 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
  }
}

Могући одговори са грешком:

Грешка: Недостаје ID тенанта

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Грешка: Недостаје ID корисника

Copy

{
  "status": "failed",
  "code": "missing-user-id",
  "reason": "User ID (body param: userId) is required."
}

Грешка: Недостаје 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

Ovaj endpoint vam omogućava ažuriranje dodjele korisničke značke.

Trenutno, jedino svojstvo koje se može ažurirati je displayedOnComments, koje upravlja time da li se značka prikazuje na korisnikovim komentarima.

Primjer zahtjeva:

Primjer PUT zahtjeva

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

Primjer odgovora:

Odgovor

Copy

{
  "status": "success"
}

Mogući odgovori o greškama:

Greška: Nedostaje Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Greška: Nedostaje ID

Copy

{
  "status": "failed",
  "code": "missing-id",
  "reason": "The User Badge ID (url param: id) is missing."
}

Greška: Nije pronađeno

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "The user badge badge123 was not found."
}

DELETE /api/v1/user-badges/:id

Ovaj endpoint vam omogućava brisanje dodjele korisničke značke.

Primjer zahtjeva:

Primjer DELETE zahtjeva

Copy

Run

curl -X DELETE "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET"

Primjer odgovora:

Odgovor

Copy

{
  "status": "success"
}

Mogući odgovori na greške:

Greška: Nedostaje ID zakupca

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Greška: Nedostaje ID

Copy

{
  "status": "failed",
  "code": "missing-id",
  "reason": "The User Badge ID (url param: id) is missing."
}

Greška: Nije pronađeno

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "The user badge badge123 was not found."
}

Структура напретка значке корисника

UserBadgeProgress je objekat koji predstavlja napredak korisnika u sticanju različitih značaka u FastComments sistemu.

Ovo praćenje pomaže odrediti kada korisnici treba da dobiju automatske značke na osnovu svoje aktivnosti i učešća u vašoj zajednici.

Struktura objekta UserBadgeProgress je sledeća:

Struktura UserBadgeProgress

Copy

export interface UserBadgeProgress {
    /** Jedinstveni identifikator za ovaj zapis o napretku */
    id: string
    /** ID tenant-a kojem ovaj zapis o napretku pripada */
    tenantId: string
    /** ID korisnika kojeg ovaj zapis o napretku prati */
    userId: string
    /** ID prvog komentara korisnika u sistemu */
    firstCommentId?: string
    /** Datum prvog komentara korisnika (milisekunde od epohe) */
    firstCommentDate?: number
    /** Automatski izračunat faktor poverenja zasnovan na aktivnosti korisnika */
    autoTrustFactor?: number
    /** Ručno postavljen faktor poverenja od strane administratora */
    manualTrustFactor?: number
    /** Detaljan objekat napretka sa raznim metrikama, ključevi odgovaraju BadgeType enumu */
    progress: {
        /** 0: CommentCount - Broj komentara koje je korisnik ostavio */
        '0'?: number
        /** 1: CommentUpVotes - Broj upvota koje je korisnik primio */
        '1'?: number
        /** 2: CommentReplies - Broj odgovora koje je korisnik napisao */
        '2'?: number
        /** 3: CommentsPinned - Broj zakačenih (pinned) komentara koje korisnik ima */
        '3'?: number
        /** 4: Veteran - Starost korisničkog naloga */
        '4'?: number
        /** 5: NightOwl - Broj puta kada je korisnik objavio tokom noćnih sati */
        '5'?: number
        /** 6: FastReplyTime - Prosečno vreme odgovora u milisekundama */
        '6'?: number
        /** 7: ModeratorCommentsDeleted - Za moderatorške značke, broj izbrisanih komentara */
        '7'?: number
        /** 8: ModeratorCommentsApproved - Za moderatorške značke, broj odobrenih komentara */
        '8'?: number
        /** 9: ModeratorCommentsUnapproved - Za moderatorške značke, broj neodobrenih komentara */
        '9'?: number
        /** 10: ModeratorCommentsReviewed - Za moderatorške značke, broj pregledanih komentara */
        '10'?: number
        /** 11: ModeratorCommentsMarkedSpam - Za moderatorške značke, broj komentara označenih kao spam */
        '11'?: number
        /** 12: ModeratorCommentsMarkedNotSpam - Za moderatorške značke, broj komentara označenih kao ne-spam */
        '12'?: number
        /** 13: RepliedToSpecificPage - Za svaku stranicu, broj odgovora */
        '13'?: Record<string, number>
    }
}

---

GET /api/v1/user-badge-progress

Ова крајња тачка вам омогућава да преузмете записе напретка значки корисника на основу различитих критеријума.

Пример захтева:

Пример 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
      }
    }
  ]
}

Могући одговори са грешком:

Грешка: Недостаје идентификатор тенанта

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

Ovaj endpoint vam omogućava da dohvatite specifičan zapis napretka korisničke značke po njegovom jedinstvenom ID-u.

Primjer zahtjeva:

Primjer GET zahtjeva

Copy

Run

curl -X GET "https://fastcomments.com/api/v1/user-badge-progress/progress123?tenantId=demo&API_KEY=DEMO_API_SECRET"

Primjer odgovora:

Odgovor

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
    }
  }
}

Mogući odgovori u slučaju greške:

Greška: Nedostaje Tenant ID

Copy

{
  "status": "failed",
  "code": "missing-tenant-id",
  "reason": "Tenant ID (query param: tenantId) is missing."
}

Greška: Nije pronađeno

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "The user badge progress progress123 was not found."
}

GET /api/v1/user-badge-progress/user/:userId

Ова крајња тачка вам омогућава да преузмете запис о напретку значке корисника по његовом 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."
}

U zaključku

Nadamo se da ste našu API dokumentaciju smatrali sveobuhvatnom i lako razumljivom. Ako primijetite bilo kakve nedostatke, javite nam ispod.

Језик 🇧🇦 Српски (БиХ)

API ресурси

Агрегације

Ревизијски дневници

Коментари

Шаблони е-поште

Хештегови

Модератори

Број обавештења

Обавештења

Странице

Чекајући вебхук догађаји

SSO корисници

Претплате

Дневна употреба тенанта

Тенанти

Пакети тенанта

Корисници тенанта

Корисници

Гласови

Конфигурације домена

Конфигурације питања

Резултати питања

Агрегација резултата питања

Значке корисника

Напредак значке корисника

FastComments API

Generisani SDK-ovi

Autentifikacija

Napomena o sigurnosti

Authentication Option One - Headers

Authentication Option Two - Query Parameters

API ресурси

Коришћење ресурса

Напомена!

Агрегирајте своје податке

Примјери

Примјер: Бројање јединствених

Примјер: Бројање различитих

Примјер: Сума вриједности више поља

Примјер: Просјечне вриједности више поља

Примјер: Минималне/Максималне вриједности више поља

Примјер: Бројање јединствених вриједности више поља

Примјер: Креирање упита

Примјер: Бројање коментара који чекају рецензију

Примјер: Преглед по статусу (approved, reviewed, spam)

Структуре

Структура ревизијског дневника

GET /api/v1/audit-logs

Структура коментара

Comment Text Structure

Tagging

HashTags

GET /api/v1/comments

Pagination

Threads

Trees Explained

Fetching Comments in The Context of a User

Get Comments as a Tree

Get Comments as a Tree, Searching by Hash Tag

All Request Params

The Response

Helpful Tips

URL ID

Anonymous Actions

Comments Not Being Returned

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

Структура шаблона е-поште

Notes

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

GET /api/v1/email-templates

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

POST /api/v1/email-templates