API | FastComments Docs

FastComments API

FastComments pruža API za interakciju sa mnogim resursima. Izgradite integracije sa našom platformom, ili čak napravite svoje klijente!

U ovoj dokumentaciji naći ćete sve podržane resurse API-ja dokumentovane sa njihovim tipovima zahteva i odgovora.

Za Enterprise korisnike, sav pristup API-ju se beleži u Dnevniku audita.

Generisani SDK-ovi

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

We also now have SDKs for popular languages:

Autentifikacija

API se autentifikuje prosleđivanjem vašeg API ključa kao ili X-API-KEY zaglavlje ili API_KEY parametar upita. Takođe će vam trebati vaš tenantId za pozive API-ju. Možete ga pronaći na istoj stranici kao i vaš API ključ.

Sigurnosna napomena

Ove rute su namenjene da se pozivaju sa servera. NE POZIVAJTE ih iz pregledača. To će otkriti vaš API ključ — to će omogućiti potpun pristup vašem nalogu svima koji mogu videti izvorni kod stranice!

Opcija autentifikacije 1 - Zaglavlja

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

Opcija autentifikacije 2 - Parametri upita

Parametar upita: API_KEY
Parametar upita: tenantId

API ресурси

Korišćenje resursa

Treba napomenuti da se dohvat podataka sa API-ja računa kao upotreba na vašem nalogu.

Svaki resurs navodi koja se upotreba evidentira u svojoj sekciji.

Neki resursi koštaju više za posluživanje nego drugi. Svaki endpoint ima fiksan trošak kredita po API pozivu. Za neke endpoint-e, broj kredita varira u zavisnosti od opcija i veličine odgovora.

Upotreba API-ja se može proveriti na stranici Analitika naplate i ažurira se svakih nekoliko minuta.

Napomena!

Preporučujemo da prvo pročitate dokumentaciju za Pages, kako biste smanjili zabunu pri određivanju koje vrijednosti treba proslijediti za urlId u Comment API.

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

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

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

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

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

Ако имате управљане тенанте, можете агрегирати све ресурсе дјечијих тенаната у једном позиву прослиједивши query параметар parentTenantId.

Примери

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

Пример cURL захтева — бројање јединствених вредности

Copy

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

Одговор — бројање јединствених вредности

Copy

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

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

Пример cURL захтева — бројање различитих вредности

Copy

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

Одговор:

Одговор — бројање различитих вредности

Copy

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

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

Пример cURL захтева — сума вредности

Copy

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

Одговор:

Одговор — сума вредности

Copy

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

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

Пример cURL захтева — просек вредности

Copy

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

Одговор:

Одговор — просек вредности

Copy

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

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

Пример cURL захтева — минималне/максималне вредности

Copy

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

Одговор:

Одговор — минималне/максималне вредности

Copy

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

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

Пример cURL захтева — бројање јединствених вредности

Copy

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

Одговор:

Одговор — бројање јединствених вредности

Copy

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

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

Пример cURL захтева — креирање упита

Copy

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

Одговор:

Одговор — креирање упита

Copy

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

Пример: Број коментара на чекању за преглед

Пример cURL захтева — бројање коментара на чекању за преглед

Copy

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

Одговор:

Одговор — бројање коментара на чекању за преглед

Copy

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

Пример: Расподела одобрених, прегледаних и спам коментара

Пример cURL захтева — расподела коментара

Copy

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

Одговор:

Одговор — расподела коментара

Copy

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

Структуре

Структура захтева за агрегирање

Copy

export type AggregationOpType = 'sum' | 'countDistinct' | 'distinct' | 'avg' | 'min' | 'max' | 'count';
/** Операција која ће се применити на поље */
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
};

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

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 je objekat koji predstavlja revizirani događaj za tenantima koji imaju pristup ovoj funkciji.

Struktura AuditLog objekta je sljedeća:

Struktura AuditLog objekta

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

Dnevnik revizije je nepromjenjiv. Ne može se ručno upisivati. FastComments.com jedino može odlučiti kada će unijeti zapise u dnevnik revizije. Međutim, možete ga čitati putem ovog API-ja.

Događaji u dnevniku revizije ističu nakon dvije godine.

GET /api/v1/audit-logs

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

Овај API користи пагинацију, обезбијеђену параметрима skip, before и after. AuditLogs се враћају у страницама од 1000, поређани по when и id.

Преузимање сваких 1000 логова кошта 10 кредита.

По подразумеваној поставци, добићете листу са најновијим ставкама на почетку. На овај начин можете започети са skip=0 и пагинирати док не пронађете последњи запис који сте обрадили.

Алтернативно, можете сортирати тако да најстарији буду први и пагинирати док не буде више записа.

Сортирање се врши подешавањем order на ASC или DESC. Подразумевано је ASC.

Претраживање по датуму је могуће преко before и after као временских ознака са милисекундама. before и after нису укључени.

Примјер cURL захтјева за 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'

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

Copy

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

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

Copy

interface CommentsResponse {
    status: 'success' | 'failed'
    /** Укључено у случају грешке. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају грешке. **/
    reason?: string
    /** Логови! **/
    auditLogs: AuditLog[]
}

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

Објекат Comment представља коментар који је оставио корисник.

Веза између родитељских и подређених коментара дефинише се преко parentId.

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

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

Copy

interface Comment {
    /** READONLY: Поставити на true ако је спам механизам утврдио да је коментар спам. **/
    aiDeterminedSpam?: boolean
    /** Да ли је коментар одобрен за приказ. Поставити на true приликом чувања коментара, иначе ће бити скривен. **/
    approved?: boolean
    /** Аватар корисника. **/
    avatarSrc?: string
    /** Подређени коментари. Нису попуњавани у свим сценаријима. Користи се када је asTree постављено на true преко API-ја. **/
    children: Comment[]
    /** Сирови текст коментара аутора. **/
    comment: string
    /** READONLY: Коментар аутора парсиран у HTML. **/
    commentHTML?: string
    /** Е-пошта аутора. Захтевана ако је анонимно коментарисање искључено. **/
    commenterEmail?: string
    /** Линк аутора (на пример, њихов блог). **/
    commenterLink?: string
    /** Име аутора. Увек обавезно. Ако није доступно, поставити нешто као "Anonymous". **/
    commenterName: string
    /** Датум када је коментар остављен, у UTC епохи. **/
    date: number
    /** "Приказна ознака" за коментар - на пример "Admin", "Moderator", или нешто као "VIP User". **/
    displayLabel?: string
    /** Домен на ком је коментар објављен. **/
    domain?: string
    /** READONLY: Број пута колико је коментар пријављен. **/
    flagCount?: number
    /** Хештегови написани у коментару који су успешно парсирани. Можете и ручно додати хештегове, за упите, али они се неће аутоматски приказати у тексту коментара. **/
    hashTags?: CommentHashTag[]
    /** READONLY: Да ли коментар садржи слике? **/
    hasImages?: boolean
    /** READONLY: Да ли коментар садржи линкове? **/
    hasLinks?: boolean
    /** READONLY: Јединствени id коментара. **/
    id: string
    /** Само приликом креирања! Ово се хешира за похрану. **/
    ip?: string
    /** READONLY: Да ли је тренутни корисник блокирао корисника који је написао овај коментар? **/
    isBlocked?: boolean
    /** READONLY: Да ли је коментар од администратора? Аутоматски се поставља на основу userId. **/
    isByAdmin?: boolean
    /** READONLY: Да ли је коментар од модератора? Аутоматски се поставља на основу userId. **/
    isByModerator?: boolean
    /** Поставити на true ако је коментар делимично обрисан (морао је остати плейсхолдер због неке друге конфигурације). **/
    isDeleted?: boolean
    /** Поставити на true ако је кориснички налог обрисан, а коментар је морао бити сачуван. **/
    isDeletedUser?: boolean
    /** READONLY: Да ли је коментар пријавио тренутно пријављени корисник (contextUserId)? **/
    isFlagged?: boolean
    /** Да ли је коментар прикачен? **/
    isPinned?: boolean
    /** Да ли је коментар закључан за нове одговоре (модератори и даље могу одговарати)? **/
    isLocked?: boolean
    /** Да ли је коментар спам? **/
    isSpam?: boolean
    /** READONLY: Да ли је коментар означен негативним гласом од стране тренутног корисника (contextUserId)? **/
    isVotedDown?: boolean
    /** READONLY: Да ли је коментар означен позитивним гласом од стране тренутног корисника (contextUserId)? **/
    isVotedUp?: boolean
    /** Локал у којем је коментар. Ако није наведен, биће изведено из Accept-Language HTTP заглавља. **/
    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: @помене написане у коментару које су успешно парсиране. **/
    mentions?: CommentUserMention[]
    /** Опционални метаподаци повезани са коментаром. **/
    meta?: Record<string, string | number | boolean>
    /** Опционална листа модерацијских група id-јева повезаних са овим коментаром. **/
    moderationGroupIds?: string[]|null
    /** READONLY: ID објекта гласа који одговара гласу тренутног корисника (contextUserId) за овај коментар. **/
    myVoteId?: string
    /** Да ли су обавештења послата за овај коментар коментаторима. Да бисте спречили слање обавештења при увозу, поставите ово на true. **/
    notificationSentForParent?: boolean
    /** Да ли су обавештења послата за овај коментар tenant корисницима. Да бисте спречили слање обавештења при увозу, поставите ово на true. **/
    notificationSentForParentTenant?: boolean
    /** Наслов странице на којој је овај коментар. **/
    pageTitle?: string
    /** Ако одговарамо на коментар, ово је ID на који одговарамо. **/
    parentId?: string|null
    /** Да ли је коментар означен као прегледан. **/
    reviewed: boolean
    /** ID тенанта коме коментар припада. **/
    tenantId: string
    /** Корисник који је написао коментар. Аутоматски се креира када се коментар сачува са именом/е-поштом. **/
    userId?: string|null
    /** URL локације на којој је овај коментар видљив, као на пример блог пост. **/
    url: string
    /** "Очишћена" верзија urlId коју сте нам проследили. При чувању специфичирате ово поље, али када вратите коментар ово ће бити "очишћено" и ваша оригинална вредност премештена у "urlIdRaw". **/
    urlId: string
    /** READONLY: Оригинални urlId који сте нам проследили. **/
    urlIdRaw?: string
    /** Да ли је корисник и овај коментар верификован? **/
    verified: boolean
    /** Број позитивних гласова. **/
    votesUp?: number
    /** Број негативних гласова. **/
    votesDown?: number
    /** "Карма" коментара (= гласови за - гласови против). **/
    votes?: number
}

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

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

Коментари су написани у FastComments верзији markdown-а, што је обичан markdown плус традиционални bbcode стил тагова за слике, као што су [img]path[/img].

Текст је складиштен у два поља. Текст који је корисник унео је сачуван неизмењен у пољу comment. Ово се рендерује и чува у пољу commentHTML.

Дозвољени HTML тагови су b, u, i, strike, pre, span, code, img, a, strong, ul, ol, li, and br.

Препоручује се рендеровање HTML-а, с обзиром на то да је то веома мали подсет HTML-а, прављење renderer-а је прилично једноставно. Постоји више библиотека за React Native и Flutter, на пример, које могу помоћи у томе

Можете изабрати да рендерујете ненормализовану вредност поља comment. Пример parser-а је овде..

Пример parser-а се такође може прилагодити да ради са HTML-ом и трансформише HTML тагове у очекиване елементе за рендеровање на вашој платформи.

Ознаке (Tagging)

Када су корисници означени у коментару, информација се чува у листи која се зове mentions. Сваки објекат у тој листи има следећу структуру.

Објекат помена у коментару

Copy

Run

interface CommentUserMention {
    /** ID корисника. За SSO кориснике, ово ће имати префикс вашег tenant id-а. **/
    id: string
    /** Коначни @mention текст тега, укључујући @ симбол. **/
    tag: string
    /** Оригинални @mention текст тега, укључујући @ симбол. **/
    rawTag: string
    /** Који тип корисника је означен. user = FastComments.com налог. sso = SSOUser. **/
    type: 'user'|'sso'
    /** Ако се корисник определи да не прима обавештења, ово ће и даље бити постављено на true. **/
    sent: boolean
}

Хештегови

Када се хештеговa користе и успешно парсирају, информација се чува у листи која се зове hashTags. Сваки објекат у тој листи има следећу структуру. Хештегови се такође могу ручно додати у hashTags низ коментара за упите, ако је retain постављено.

Објекат хештега коментара

Copy

Run

interface CommentHashTag {
    /** ID хештега. **/
    id: string
    /** Коначни #hashtag текст тега, укључујући # симбол. **/
    tag: string
    /** Ако је хештег повезан са прилагођеним URL-ом, ово ће бити дефинисано. **/
    url?: string
    /** Ако треба задржати хештег, чак и ако не постоји у тексту коментара приликом ажурирања. Корисно за означавање коментара без мењања текста коментара. **/
    retain?: boolean
}

GET /api/v1/comments

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

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

Paginacija

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

Najbrže: Prekalkulisana paginacija:
1. Ovako FastComments radi kada koristite naše prethodno izgrađene widgete i klijente.
2. Klik na 'next' jednostavno povećava broj stranice.
3. Možete to zamisliti kao da se dobija iz skladišta ključ-vrijednost.
4. Na ovaj način, jednostavno definišite parametar page koji počinje od 0 i smjer sortiranja kao direction.
5. Veličine stranica se mogu prilagoditi pravilima za prilagođavanje.
Najfleksibilnije: Fleksibilna paginacija:
1. Na ovaj način možete definirati prilagođene parametre limit i skip. Nemojte slati page.
2. Podržan je i smjer sortiranja direction.
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. Podkomentari i dalje se računaju u paginaciji. Možete to izbjeći koristeći opciju asTree.
  - Podkomentare možete paginirati preko limitChildren i skipChildren.
  - Možete ograničiti dubinu niti koje se vraćaju putem maxTreeDepth.

Niti

Kada koristite Precalculated Pagination, komentari su grupisani po stranici i komentari u nitima utiču na ukupnu stranicu.
1. Na ovaj način, niti se mogu odrediti na klijentu na osnovu parentId.
2. Na primjer, na stranici sa jednim komentarom najvišeg nivoa i 29 odgovora, ako postavite page=0 u API-ju — dobićete samo komentar najvišeg nivoa i 29 djece.
3. Primjer slike koja ilustruje više stranica.
Kada koristite Flexible Pagination, možete definirati parametar parentId.
1. Postavite ovo na null da dobijete samo komentare najvišeg nivoa.
2. Zatim, da biste vidjeli niti, pozovite API ponovo i prosledite parentId.
3. Uobičajeno rješenje je napraviti API poziv za komentare najvišeg nivoa, a zatim napraviti paralelne API pozive za dobijanje komentara za podkomentare svakog komentara.
NOVO od Feb 2023! Dohvatite kao stablo koristeći &asTree=true.
1. Možete to zamisliti kao Flexible Pagination as a Tree.
2. Samo komentari najvišeg nivoa se računaju u paginaciji.
3. Postavite parentId=null da započnete stablo od korijena (morate postaviti parentId).
4. Postavite skip i limit za paginaciju.
5. Postavite asTree na true.
6. Trošak kredita se udvostručuje (2x), jer naš backend mora obaviti mnogo više posla u ovom scenariju.
7. Postavite maxTreeDepth, limitChildren i skipChildren po želji.

Objašnjenje stabala

Kada koristite asTree, može biti teško razumjeti paginaciju. Evo korisnog grafikona:

Tree Pagination Diagram

Dohvatanje komentara u kontekstu korisnika

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

Za vraćanje komentara sortirano i označeno informacijama za izgradnju vašeg klijenta.
- U ovom slučaju, definišite query parametar contextUserId.
Za dobijanje komentara sa vašeg backend-a za prilagođene integracije.
- Platforma će koristiti ovo kao zadato 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 kontekstu korisnika (samo komentari 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'

Dohvati komentare kao stablo

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 neposredne odgovore? 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 treba da znate da li da prikažete dugme "show replies" na svakom komentaru. Kada dohvatate komentare putem stabla postoji svojstvo hasChildren koje se dodaje komentarima kada je primjenjivo.

Dohvati komentare kao stablo, pretraga po haštagu

Moguće je pretraživati po haštagu koristeći API, kroz cijeli vaš tenant (nije ograničeno na jednu stranicu ili urlId).

U ovom primjeru izostavljamo urlId, i pretražujemo po više haštagova. API će vratiti samo komentare koji imaju sve tražene haštagove.

Komentari kao stablo u kontekstu korisnika, po haštagu

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'

Svi parametri zahteva

Struktura zahteva za komentare

Copy

interface CommentsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** ID stranice (url stranice ili ID članka) sa kojom su komentari povezani. **/
    urlId?: string
    /** Ograniči komentare koji se vraćaju na one od ovog korisnika. **/
    userId?: string
    /** Koristite ovo za pretragu po haštagu. Da biste dublje povukli presjek više haštagova, koristite &hashTag=a&hashTag=b. **/
    hashTag?: string
    /** Smjer sortiranja. Zadano je MR (Most Relevant). Ostale opcije su OF (Oldest First) i NF (Newest First). **/
    direction?: 'MR' | 'OF' | 'NF'
    /** Prekalkulisana paginacija: Stranica za dohvat, počevši od 0. Prosledite -1 za sve komentare (do 250). **/
    page?: number
    /** Fleksibilna paginacija: Koliko komentara treba da vratimo? **/
    limit?: number
    /** Fleksibilna paginacija: Koliko podkomentara treba da vratimo za svaki roditelj? **/
    limitChildren?: number
    /** Fleksibilna paginacija: Koliko komentara treba da preskočimo? **/
    skip?: number
    /** Fleksibilna paginacija: Koliko podkomentara treba da preskočimo za svakog roditelja? **/
    skipChildren?: number
    /** Za određivanje blokiranih i flagovanih komentara. **/
    contextUserId?: string
    /** Za određivanje blokiranih i flagovanih komentara. **/
    anonUserId?: string
    /** Za dohvatanje dječijih komentara. **/
    parentId?: string
    /** Za dohvatanje kao stablo. **/
    asTree?: boolean
    /** Koliko duboko u stablu treba da vraćamo podatke? 0 vraća nijedno dijete. 1 vraća neposredna djeca, itd. **/
    maxTreeDepth?: number
}

Odgovor

Struktura odgovora za komentare

Copy

interface CommentsResponse {
    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-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 greške. **/
    reason?: string
    /** Komentari! **/
    comments: Comment[]
}

Korisni savjeti

URL ID

Vjerovatno ćete htjeti koristiti Comment API sa parametrrom urlId. Možete prvo pozvati Pages API, da vidite kako izgledaju vrijednosti urlId koje su vam na raspolaganju.

Anonimne radnje

Za anonimno komentarisanje vjerovatno želite poslati anonUserId prilikom dohvatanja komentara, kao i prilikom prijavljivanja i blokiranja.

(!) Ovo je zahtjev za mnoge prodavnice aplikacija jer korisnici moraju biti u mogućnosti da prijave sadržaj kreiran od strane korisnika koji mogu vidjeti, čak i ako nisu prijavljeni. Nepoštovanje ovoga može uzrokovati uklanjanje vaše aplikacije iz navedene prodavnice.

Komentari se ne vraćaju

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

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

Copy

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

Структура захтева за добијање коментара по ИД-у

Copy

interface CommentsGetByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за добијање коментара по ИД-у

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-ја ће се појавити на страницама Analytics и Moderation админ апликације.
"bad words" су и даље маскиране у именима коментатора и тексту коментара ако је то подешавање укључено.
Коментари креирани преко овог API-ја и даље се могу проверавати на спам ако је потребно.
Конфигурације као што је максимална дужина коментара, ако су подешене преко странице Customization Rule у админ панелу, примењиваће се овде.

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

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

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

Реалнији захтев може изгледати овако:

cURL пример за POST коментара

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 може, по жељи, ажурирати видгет коментара у реалном времену (ово повећава основни creditsCost са 1 на 2).
- Ово може омогућити миграцију коментара између страница у реалном времену (промена urlId).
- Миграције коштају додатна 2 кредита јер се странице претходно израчунавају и то је захтјевно за CPU.
За разлику од API-ја за креирање, овај API НЕће аутоматски креирати корисничке објекте у нашем систему ако је наведена е-пошта.
Коментари ажурирани преко овог API-ја и даље могу бити провјерени на спам, по жељи.
Конфигурације као што је максимална дужина коментара, ако су постављене преко странице администрације правила прилагођавања, примјењиваће се овдје.
Да бисте омогућили корисницима да ажурирају текст свог коментара, можете једноставно навести comment у тијелу захтјева. Ми ћемо генерисати резултујући commentHTML.
- Ако дефинишете и comment и commentHTML, нећемо аутоматски генерисати HTML.
- Ако корисник дода помињања или хештегове у новом тексту, они ће се и даље обрађивати као код POST API-ја.
Када ажурирате commenterEmail на коментару, најбоље је такође навести userId. У супротном, морате осигурати да корисник са том е-поштом припада вашем 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'
    /** Да ли коментар треба да се појави у реалном времену корисницима који гледају инстанце видгета коментара са истим 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 крајња тачка омогућава означавање коментара за одређеног корисника.

Напомене:

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

Примјер cURL захтјева за означавање коментара

Copy

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

За анонимно означавање морамо навести anonUserId. Ово може бити ИД који представља анонимну сесију, или насумични UUID. Ово нам омогућава да подржимо означавање и уклањање означавања коментара чак и ако корисник није пријављен. На тај начин, коментар може бити означен као прозначен када се коментари преузму са истим anonUserId.

Примјер cURL захтјева за означавање анонимног коментара

Copy

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

Структура захтјева за означавање коментара

Copy

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

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

Copy

interface CommentFlagResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    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 uklanjanje oznake ("un-flag") komentara za određenog korisnika.

Notes:

Ovaj poziv mora uvijek biti napravljen u kontekstu korisnika. Korisnik može biti FastComments.com User, SSO User, ili Tenant User.
Nakon što je komentar automatski un-approved (sakriven) - komentar može ponovo biti odobren samo od strane administratora ili moderatora. Un-flagging 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'

For anonymous flagging, we must specify an anonUserId. This can be an ID that represents the anonymous session, or a random UUID.

Primjer cURL: anonimno 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&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 корисници, SSO корисници и корисници тенанта.

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

Напомене:

Овај позив увек мора бити направљен у контексту корисника. Корисник може бити FastComments.com корисник, SSO корисник, или корисник тенанта.
У захтеву, 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

Ovaj API endpoint omogućava uklanjanje blokade korisniku koji je napisao određeni komentar. Podržava uklanjanje blokade za komentare koje su napisali FastComments.com korisnici, SSO korisnici, i Tenant korisnici.

Podržava body parametar commentIdsToCheck koji provjerava da li bi ostali potencijalno vidljivi komentari na klijentu trebali biti blokirani/otblokirani nakon izvršene akcije.

Napomene:

Ovaj poziv mora uvijek biti napravljen u kontekstu korisnika. Korisnik može biti FastComments.com korisnik, SSO korisnik, ili Tenant korisnik.
Polje userId u zahtjevu je korisnik koji je izvodi otblokiranje. Na primjer: User A želi otblokirati User B. Proslijedite userId=User A i id komentara koji je napisao User B.
Potpuno anonimni komentari (bez user id, bez email) ne mogu biti blokirani i biće vraćena greška.

Primjer cURL zahtjeva za otblokiranje komentara

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'

Primjer cURL zahtjeva za otblokiranje anonimnog komentara

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'

Struktura zahtjeva za otblokiranje komentara

Copy

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

Struktura odgovora za otblokiranje komentara

Copy

interface CommentUnBlockResponse {
    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' | 'comment-cannot-be-blocked'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    /** Ako je commentIdsToCheck definisan, unosi u ovoj mapi sa vrijednošću true su i dalje blokirani. Ako su false, možda ćete htjeti ponovo prikazati komentare korisniku kako ne bi morali osvježavati. **/
    commentStatuses?: Record<string, boolean>;
}

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

Објекат EmailTemplate представља конфигурацију за прилагођени имејл шаблон, за tenant.

Систем ће одабрати имејл шаблон који ће се користити путем:

Његовог идентификатора типа, називамо га emailTemplateId. Ово су константе.
domain. Прво ћемо покушати пронаћи шаблон за домен уз који је повезан релевантни објекат (попут Comment), а ако се поклапање не пронађе онда ћемо покушати пронаћи шаблон где је domain null или *.

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

Структура имејл шаблона

Copy

interface EmailTemplate {
    id: string
    tenantId: string
    emailTemplateId: string
    displayName: string
    /** САМО ЗА ЧИТАЊЕ **/
    createdAt: string
    /** САМО ЗА ЧИТАЊЕ **/
    updatedAt: string
    /** САМО ЗА ЧИТАЊЕ **/
    updatedByUserId: string
    /** Домен са којим шаблон треба бити повезан. **/
    domain?: string | '*' | null
    /** Садржај имејл шаблона у EJS синтакси. **/
    ejs: string
    /** Мапа преписаних кључева превода у вредности за сваки подржани локал. **/
    translationOverridesByLocale: Record<string, Record<string, string>>
    /** Објекат који представља контекст рендеровања шаблона. **/
    testData: object
}

Напомене

You can get the valid emailTemplateId values from the /definitions endpoint.
The /definitions endpoint also includes the default translations and test data.
Шаблони неће бити сачувани ако структура или тестни подаци нису валидни.

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

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

Pojedinačni EmailTemplate-ovi se mogu dohvatiti pomoću odgovarajućeg id (NE emailTemplateId).

Primjer cURL zahtjeva za EmailTemplate po ID-u

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

Copy

interface EmailTemplatesByIdRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za EmailTemplate po ID-u

Copy

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

GET /api/v1/email-templates

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

Ovaj API koristi paginaciju, koju obezbjeđuje query parametar page. EmailTemplates se vraćaju u stranicama od 100, poredani po createdAt i zatim po id.

Primjer cURL zahtjeva za EmailTemplate

Copy

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

Struktura zahtjeva za EmailTemplate

Copy

interface EmailTemplatesRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Stranica za dohvat, počinje od 0. **/
    page: number
}

Struktura odgovora za EmailTemplate

Copy

interface EmailTemplatesResponse {
    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
    emailTemplates: EmailTemplate[]
}

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

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

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

Имајте у виду да се исте валидације које важе при креирању шаблона такође примењују, на пример:

Шаблон мора да се рендерује. Ово се проверава при сваком ажурирању.
Не можете имати дупликатне шаблоне за исти домен (иначе би један био тихо игнорисан).

EmailTemplate PATCH cURL пример

Copy

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

EmailTemplate PATCH Структура захтева

Copy

interface EmailTemplatePatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

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

POST /api/v1/email-templates

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

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

Напомене:

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

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

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

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

You may want to have templates per-site, in which case you define domain:

cURL пример за EmailTemplate POST

Copy

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

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

Copy

interface EmailTemplatePostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

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

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

Минимални пример POST cURL захтева за преглед 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 %>."
}'

Структура 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' | 'does-not-render';
    /** Укључено у случају неуспеха. **/
    reason?: string
    /** Рендеровани HTML у случају успеха. **/
    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-a

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

Copy

interface EmailTemplateRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje EmailTemplate-a

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
}

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

Објекат HashTag представља ознаку коју може оставити корисник. HashTags се могу користити за повезивање са спољним садржајем или за повезивање повезаних коментара.

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

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

Copy

interface HashTag {
    /** Треба да почиње са "#" или жељеним знаком. **/
    tag: string
    /** Опциони URL на који хаштег може да упућује. Уместо филтрирања коментара по хаштегу, UI ће при клику преусмерити на овај URL. **/
    url?: string
    /** САМО ЗА ЧИТАЊЕ **/
    createdAt: string
}

Напомене:

У неким API endpoints видећете да се хаштег користи у URL-у. Запамтите да вредности буду URI-Encoded. На пример, # треба да буде представљен као %23.
Нека од ових поља су означена као READONLY - враћа их API, али се не могу поставити.

GET /api/v1/hash-tags

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

Ovaj API koristi paginaciju, koju obezbjeđuje parametar upita page. Heštegovi se vraćaju u stranicama po 100, poredani po tag.

HashTag cURL Primjer

Copy

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

HashTag Struktura zahtjeva

Copy

interface HashTagsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Stranica koju treba dohvatiti, počevši od 0. **/
    page: number
}

HashTag Struktura odgovora

Copy

interface HashTagsResponse {
    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
    /** Heštegovi! **/
    hashTags: HashTag[]
}

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

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

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

Пример cURL захтева за ажурирање HashTag-а

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; // На успех враћамо комплетан ажурирани хештег.
}

POST /api/v1/hash-tags

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

Ова рута омогућава додавање једног HashTag-а.

Примјер cURL захтјева за креирање HashTag-а

Copy

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

Структура захтјева за креирање HashTag-а

Copy

interface HashTagPostQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за креирање HashTag-а

Copy

interface HashTagPostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    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'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    hashTag?: HashTag; // У случају успјеха враћамо потпуно креирани хештег.
}

POST /api/v1/hash-tags/bulk

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

Ова рута омогућава додавање до 100 HashTag објеката одједном.

HashTag Масовно креирање cURL пример

Copy

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

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

Copy

interface HashTagPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface HashTagBulkPostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    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'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    results?: HashTagPostResponse[]; // Враћамо листу HashTagPostResponse објеката за сваки достављени таг.
}

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

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

Ова рута омогућава уклањање HashTag-а по наведеном тагу.

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

Пример cURL захтева за уклањање HashTag-а

Copy

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

Структура захтева за уклањање HashTag-а

Copy

interface HashTagDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за уклањање HashTag-а

Copy

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

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

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

Постоје три типа модератора:

Администраторски корисници који имају isCommentModeratorAdmin ознаку.
SSO корисници са isCommentModeratorAdmin ознаком.
Редовни коментатори, или FastComments.com корисници, који су позвани као модератори.

Структура Moderator се користи за представљање стања модерације у случају употребе 3.

Ако желите да позовете корисника да постане модератор преко API-ја, користите Moderator API креирањем Moderator и њиховим inviting.

Ако корисник нема FastComments.com налог, e-mail позив ће им помоћи да се подесе. Ако већ има налог, добиће приступ модерацији за ваш tenant и Moderator објект ће имати ажуриран userId да показује на њихов корисник. Нећете имати API приступ њиховом кориснику, јер у том случају он припада њима и управља њим FastComments.com.

Ако вам треба потпуна управљања корисничким налогом, препоручујемо или коришћење SSO, или додавање њих као Корисник тенанта и затим додавање Moderator објекта да бисте пратили њихове статистике.

Структура Moderator може да се користи као механизам за праћење статистике за случајеве употребе 1 и 2. Након креирања корисника, додајте Moderator објекат са дефинисаним userId и њихове статистике ће се пратити на Страница модератора коментара.

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

Структура Moderator

Copy

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

GET /api/v1/moderators/:id

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

Ovaj endpoint vraća jednog moderatora po njihovom id.

Primjer cURL zahtjeva: Moderator po ID

Copy

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

Struktura zahtjeva za moderatora

Copy

interface ModeratorByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za moderatora

Copy

interface ModeratorByIdResponse {
    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
    moderator?: Moderator
}

GET /api/v1/moderators

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

Ovaj API koristi paginaciju, koju obezbjeđuje parametar upita skip. Moderatori se vraćaju u stranicama po 100, poredani po createdAt i id.

Trošak se zasniva na broju vraćenih moderatora i iznosi 1 kredit na svakih 10 vraćenih moderatora.

Primjer cURL zahtjeva za moderatora

Copy

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

Struktura zahtjeva za moderatora

Copy

interface ModeratorsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Broj moderatora koji se preskaču za paginaciju. **/
    skip?: number
}

Struktura odgovora za moderatora

Copy

interface ModeratorsResponse {
    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
    moderators?: Moderator[]
}

PATCH /api/v1/moderators/:id

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

Ova API krajnja tačka omogućava ažuriranje Moderator po id.

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

Sljedeće vrijednosti ne smiju biti proslijeđene pri ažuriranju Moderator-a:
- acceptedInvite
- markReviewedCount
- deletedCount
- markedSpamCount
- approvedCount
- editedCount
- bannedCount
- verificationId
- createdAt
Kada je specificiran userId, taj korisnik mora postojati.
Kada je specificiran userId, on mora pripadati istom tenantId navedenom u query parametrima.
Dva moderatora u istom tenantu ne mogu imati isti email.
Ne smijete mijenjati tenantId povezan s Moderator-om.

Primjer PATCH cURL zahtjeva za Moderator

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

Struktura PATCH zahtjeva za Moderator

Copy

interface ModeratorPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura PATCH odgovora za Moderator

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

Ova ruta omogućava dodavanje jednog Moderator.

Kreiranje Moderator ima sljedeća ograničenja:

name i email uvijek moraju biti navedeni. userId je opciono.
Sljedeće vrijednosti se ne smiju navoditi prilikom kreiranja Moderator:
- acceptedInvite
- markReviewedCount
- deletedCount
- markedSpamCount
- approvedCount
- editedCount
- bannedCount
- verificationId
- createdAt
Kada je userId naveden, taj korisnik mora postojati.
Kada je userId naveden, mora pripadati istom tenantId navedenom u parametrima upita.
Dva moderatora u istom tenantu ne mogu imati isti email.

Možemo kreirati Moderator za korisnika za kojeg znamo samo email:

Primjer kreiranja Moderator-a putem e-pošte (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"
}'

Ili možemo kreirati Moderator za korisnika koji pripada našem tenantu, kako bismo pratili njihove statistike moderacije:

Primjer kreiranja Moderator-a za korisnika iz tenanta (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"
}'

Struktura zahtjeva za kreiranje Moderator-a

Copy

interface ModeratorPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora pri kreiranju Moderator-a

Copy

interface ModeratorPostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju neuspjeha. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    moderator?: Moderator; // Vraćamo kompletno kreiranog moderatora u slučaju uspjeha.
}

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

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

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

Постоје сљедећа ограничења за слање позива путем е-поште Moderator-у:

Moderator мора већ постојати.
fromName не може бити дужи од 100 characters.

Напомене:

Ако корисник са датом е-поштом већ постоји, биће позван да модерира коментаре вашег тенанта.
Ако корисник са датом е-поштом не постоји, линк за позив ће их провести кроз креирање налога.
Позив истиче након 30 days.

Можемо креирати Moderator за корисника чију адресу е-поште једино знамо:

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

Copy

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

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

Структура захтјева за позив модератора

Copy

interface ModeratorSendInviteQueryParams {
    tenantId: string
    API_KEY: string
    /** Е-порука послана кориснику ће изгледати као да је послата од овог имена. **/
    fromName: string
}

Структура одговора за позив модератора

Copy

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

DELETE /api/v1/moderators/:id

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

Ova ruta omogućava uklanjanje Moderator po id-u.

Primjer cURL zahtjeva za uklanjanje moderatora

Copy

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

Struktura zahtjeva za uklanjanje moderatora

Copy

interface ModeratorDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje moderatora

Copy

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

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

A NotificationCount object predstavlja број непрочитаних обавјештења и метаподатке за корисника.

Ако нема непрочитаних обавјештења, за корисника неће постојати NotificationCount.

NotificationCount објекти се креирају аутоматски и не могу се креирати преко API-ја. Такођер истичу након једне године.

Можете очистити број непрочитаних обавјештења корисника брисањем његовог NotificationCount.

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

Структура NotificationCount

Copy

interface NotificationCount {
    id: string // ид корисника
    count: number
    createdAt: string // датум у облику низа
    expireAt: string // датум у облику низа
}

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

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

Ova ruta vraća jednu NotificationCount po ID-ju korisnika. Kod SSO, ID korisnika je u formatu <tenant id>:<user id>.

Ako nema nepročitanih obavještenja, NotificationCount neće postojati - dobićete 404.

Ovo se razlikuje od notifications/count po tome što je mnogo brže, ali ne omogućava filtriranje.

cURL primjer za NotificationCount po ID-ju

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

Struktura zahtjeva za NotificationCount

Copy

interface NotificationCountGetQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za NotificationCount

Copy

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

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

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

Ова рута брише један NotificationCount по ID-ју корисника. При коришћењу SSO-а, ID корисника је у формату <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
}

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

Објекат Notification представља обавјештење за корисника.

Notification објекти се креирају аутоматски и не могу се креирати преко API-ja. Они такође истичу након једне године. Обавјештења не могу бити обрисана. Међутим, могу се ажурирати тако да се viewed постави на false, и можете да правите упит по viewed.

Корисник такође може да се одкаже од обавјештења за одређени коментар постављањем optedOut у обавјештењу на true. Можете се поново пријавити постављањем на false.

Постоје различити типови обавјештења - погледајте relatedObjectType и type.

Начини на које се обавјештења креирају су прилично флексибилни и могу бити покренути у многим сценаријама (погледајте NotificationType).

У данашње вријеме, постојање Notification објекта не имплицира да је е-порука послата или да би требало да буде послата. Умјесто тога, обавјештења се користе за фид обавјештења и повезане интеграције.

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

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

Copy

enum NotificationObjectType {
    Comment = 0,
    Profile = 1,
    Tenant = 2
}
enum NotificationType {
    /** Ако вам је неко одговорио. **/
    RepliedToMe = 0,
    /** Ако је неко одговорио било гдје у нити (укључујући потомке више нивоа) на којој сте коментарисали. **/
    RepliedTransientChild = 1,
    /** Ако је ваш коментар добио позитиван глас. **/
    VotedMyComment = 2,
    /** Ако је нови коментар остављен на корјену странице на коју сте претплаћени. **/
    SubscriptionReplyRoot = 3,
    /** Ако је неко коментарисао на вашем профилу. **/
    CommentedOnProfile = 4,
    /** Ако имате директну поруку. **/
    DirectMessage = 5,
    /** TrialLimits is for tenant users only. **/
    TrialLimits = 6,
    /** Ако сте били @поменути. **/
    Mentioned = 7
}
interface Notification {
    id: string
    tenantId: string
    /** Са SSO-ом, user id је у формату `<tenant id>:<user id>`. **/
    userId?: string
    /** Када радите са SSO-ом, морате да бринете само о `userId`. **/
    anonUserId?: string
    /** urlId је готово увијек дефинисан. Он је опционалан само за обавјештења на нивоу tenant, што је ријетко. **/
    urlId?: string
    /** URL је кеширан за брзу навигацију до извора обавјештења. **/
    url?: string
    /** Наслов странице је кеширан за брзо читање извора обавјештења. **/
    pageTitle?: string
    relatedObjectType: NotificationObjectType
    /** На примјер, id коментара. **/
    relatedObjectId: string
    viewed: boolean
    createdAt: string // низ датума
    type: NotificationType
    fromCommentId?: string
    fromVoteId?: string
    /** fromUserName и fromUserAvatarSrc су кеширани овдје ради брзог приказивања обавјештења. Ажурирају се када се корисник ажурира. **/
    fromUserName: string
    fromUserId: string
    fromUserAvatarSrc?: string
    /** Поставите ово на true да бисте престали примати обавјештења за овај објекат. **/
    optedOut?: boolean
}

GET /api/v1/notifications

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

Ovaj endpoint vraća do 30 Notification objekata sortiranih po createdAt, najnoviji prvi.

Možete filtrirati po userId. Kod SSO-a, ID korisnika je u formatu <tenant id>:<user id>.

Primjer cURL zahtjeva za nepročitane notifikacije 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 notifikacije

Copy

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

Struktura odgovora za notifikacije

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

Ова рута враћа објекат који садржи број обавештења у параметру count.

Спорији је од /notification-count/ и кошта двоструко више кредита, али омогућава филтрирање по већем броју димензија.

Можете филтрирати истим параметрима као и ендпоинт /notifications, као што је userId. Са SSO, кориснички id је у формату <tenant id>:<user id>.

Пример cURL захтева за број непрочитаних обавештења за корисника

Copy

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

Пример cURL захтева за број непрочитаних обавештења корисника за одређену страницу

Copy

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

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

Copy

interface NotificationCountGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Филтрирај по кориснику. **/
    userId?: string
    /** Филтрирај по urlId. **/
    urlId?: string
    /** Филтрирај по изворном коментару. **/
    fromCommentId?: string
    /** Филтрирај по прочитано/непрочитано. **/
    viewed?: 'true' | 'false'
    /** Филтрирај по типу. **/
    type?: NotificationType
}

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

Copy

interface NotificationCountGetResponse {
    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
}

PATCH /api/v1/notifications/:id

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

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

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

Можете ажурирати само следећа поља:
- viewed
- optedOut

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

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

Структура PATCH захтјева за Notification

Copy

interface NotificationPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Структура PATCH одговора за Notification

Copy

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

Trenutno možete dohvatiti samo sve stranice (ili pojedinačnu stranicu putem /by-url-id) povezane sa vašim nalogom. Ako želite preciznije pretraživanje, kontaktirajte nas.

Primjer cURL zahtjeva

Copy

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

Struktura zahtjeva za stranice

Copy

interface PagesRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za stranice

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'
    /** Uključeno u slučaju greške. **/
    reason?: string
    pages: Page[]
}

Koristan savjet

The Comment API requires a urlId. You can call the Pages API first, to see what the urlId values available to you look like.

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

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

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

Пример cURL захтева за страницу по 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'

Структура захтева за страницу по URL ID

Copy

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

Структура одговора за страницу по URL ID

Copy

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

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

Запамтите да URI-енкодујете вредности као што је urlId.

PATCH /api/v1/pages/:id

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

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

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

Copy

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

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

Copy

interface PagePatchQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

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

Напомена

Неке параметре у објекту Page се аутоматски ажурирају. То су атрибути бројача и атрибут title. Атрибути бројача се не могу ажурирати путем API-ја, јер су то израчунате вредности. Поље странице title може бити подешено путем API-ја, али ће бити преписано ако се видгет за коментаре користи на страници са истим urlId и другачијим насловом странице.

POST /api/v1/pages

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

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

Чест случај употребе је контрола приступа.

Напомене:

Ако сте коментарисали у нити коментара, или позвали API да креирате Comment, већ сте креирали објекат Page! Можете покушати да га преузмете преко Page руте /by-url-id, просљеђујући исти urlId који је прослијеђен коментарском видгету.
Структура Page садржи неке израчунате вриједности. Тренутно су то commentCount и rootCommentCount. Попуњавају се аутоматски и не могу се поставити преко API-ја. Покушај постављања ће узроковати да API врати грешку.

Page POST cURL примјер

Copy

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

Page POST структура захтева

Copy

interface PagePostQueryParams {
    tenantId: string
    API_KEY: string
}

Page POST структура одговора

Copy

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

DELETE /api/v1/pages/:id

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

Ovaj endpoint omogućava uklanjanje jedne stranice po id-u.

Imajte na umu da će interakcija sa widgetom komentara za stranicu sa istim urlId jednostavno ponovo kreirati Page bez problema.

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 greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'page-does-not-exist'
    /** Uključeno u slučaju greške. **/
    reason?: string
}

Структура непроцесираног вебхук догађаја

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

Објекти 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

Ова рута враћа списак 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.

Можете филтрирати помоћу истих параметара као и на /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

Ovaj endpoint omogućava brisanje jednog PendingWebhookEvent.

Ako trebate masovno brisanje, pozovite GET API sa paginacijom, a zatim uzastopno pozovite ovaj API.

DELETE PendingWebhookEvent cURL primjer

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 lako za korišćenje SSO rešenje. Ažuriranje informacija o korisniku pomoću HMAC-bazirane integracije je jednostavno kao učitavanje stranice od strane korisnika sa ažuriranim payload-om.

Međutim, može biti poželjno upravljati korisnikom izvan tog toka, kako bi se poboljšala konzistentnost vaše aplikacije.

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

Struktura SSOUser objekta je sledeć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 // Administratorska dozvola - SSO korisnici sa ovom oznakom se naplaćuju kao SSO administratori (odvojeno od regularnih SSO korisnika)
    isAdminAdmin?: boolean // Administratorska dozvola - SSO korisnici sa ovom oznakom se naplaćuju kao SSO administratori (odvojeno od regularnih SSO korisnika)
    isCommentModeratorAdmin?: boolean // Moderator dozvola - SSO korisnici sa ovom oznakom se naplaćuju kao SSO moderatori (odvojeno od regularnih SSO korisnika)
    /** Ako je null, Kontrola pristupa se neće primjenjivati na korisnika. Ako je prazan spisak, ovaj korisnik neće moći vidjeti nijednu stranicu niti @pomenuti druge korisnike. **/
    groupIds?: string[] | null
    createdFromSimpleSSO?: boolean
    /** Ne dozvoljava drugim korisnicima da vide aktivnost ovog korisnika, uključujući komentare, na profilu. Podrazumevana vrednost je true da bi profili bili sigurni. **/
    isProfileActivityPrivate?: boolean
    /** Ne dozvoljava drugim korisnicima da ostavljaju komentare na korisnikovom profilu, niti da vide postojeće komentare na profilu. Podrazumevano false. **/
    isProfileCommentsPrivate?: boolean
    /** Ne dozvoljava drugim korisnicima da šalju direktne poruke ovom korisniku. Podrazumevano false. **/
    isProfileDMDisabled?: boolean
    karma?: number
    /** Opcionalna konfiguracija za bedževe korisnika. **/
    badgeConfig?: {
        /** Niz ID-jeva bedževa koji se dodeljuju korisniku. Ograničeno na 30 bedževa. Redosled se poštuje. **/
        badgeIds: string[]
        /** Ako je true, zamenjuje sve postojeće prikazane bedževe sa ovim. Ako je false, dodaje ih postojećim bedževima. **/
        override?: boolean
        /** Ako je true, ažurira osobine prikaza bedževa iz konfiguracije tenanta. **/
        update?: boolean
    }
}

Naplata za SSO korisnike

SSO korisnici se naplaćuju drugačije na osnovu njihovih dozvola:

Regular SSO Users: Korisnici bez administrativnih ili moderatorskih dozvola se naplaćuju kao regularni SSO korisnici
SSO Admins: Korisnici sa isAccountOwner ili isAdminAdmin oznakama se naplaćuju odvojeno kao SSO administratori (ista tarifa kao regularni administratori tenanta)
SSO Moderators: Korisnici sa isCommentModeratorAdmin oznakom se naplaćuju odvojeno kao SSO moderatori (ista tarifa kao regularni moderatori)

Važno: Da bi se izbegla dupla naplata, sistem automatski deduplikuje SSO korisnike naspram regularnih korisnika tenanta i moderatora po email adresi. Ako SSO korisnik ima isti email kao regularni korisnik tenanta ili moderator, neće biti naplaćen dvaput.

Kontrola pristupa

Korisnici mogu biti razvrstani u grupe. Za to služi polje groupIds, i opcionalno je.

@Mentions

Po defaultu @mentions će koristiti username za pretragu drugih sso korisnika kada se unese karakter @. Ako se koristi displayName, tada će rezultati koji odgovaraju username biti ignorisani kada postoji podudaranje za displayName, i rezultati pretrage za @mention će koristiti displayName.

Pretplate

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

Kod regularnog korisnika, šaljemo im email obaveštenja na osnovu njihovih podešavanja obaveštenja.

Kod SSO korisnika, razdvajamo ovo radi kompatibilnosti unazad. Korisnici će dobijati ova dodatna email obaveštenja o pretplati samo ako postavite optedInSubscriptionNotifications na true.

Bedževi

Možete dodeljivati bedževe SSO korisnicima koristeći svojstvo badgeConfig. Bedževi su vizuelni indikatori koji se pojavljuju pored imena korisnika u komentarima.

badgeIds - Niz ID-jeva bedževa koji se dodeljuju korisniku. Oni moraju biti validni ID-jevi bedževa kreirani na vašem FastComments nalogu. Ograničeno na 30 bedževa.
override - Ako je true, svi postojeći bedževi prikazani na komentarima biće zamenjeni sa navedenim. Ako je false ili izostavljeno, navedeni bedževi će biti dodati postojećim bedževima.
update - Ako je true, osobine prikaza bedževa će biti ažurirane iz konfiguracije tenanta kad god se korisnik prijavi.

GET /api/v1/sso-users

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

Ова рута враћа SSO Users по страницама од 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

Ova ruta vraća jednog SSO korisnika prema njihovoj email adresi.

SSOUser po emailu - 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'

SSOUser Struktura zahtjeva

Copy

interface SSOUserRequestByEmailQueryParams {
    tenantId: string
    API_KEY: string
}

SSOUser Struktura odgovora

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

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

Пример cURL захтева за ажурирање SSO корисника

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

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

Copy

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

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

Copy

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

POST /api/v1/sso-users

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

Ova ruta omogućava kreiranje jednog SSO korisnika.

Pokušaj kreiranja dva korisnika sa istim ID-jem rezultiraće greškom.

SSOUser kreiranje — primjer cURL zahtjeva

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

U ovom primjeru navodimo groupIds za kontrolu pristupa, ali ovo je opciono.

Struktura zahtjeva za kreiranje SSOUser

Copy

interface SSOUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za kreiranje SSOUser

Copy

interface SSOUserPostResponse {
    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-exists'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    user?: SSOUser; // U slučaju uspjeha vraćamo kreiranog korisnika.
}

Napomena za integraciju

Podaci poslati putem API-ja mogu biti prebrisani jednostavnim slanjem drugačijeg SSO User HMAC payload. Na primjer, ako postavite username putem API-ja, ali zatim pošaljete drugačiji putem SSO toka pri učitavanju stranice, mi ćemo automatski ažurirati njihov username.

Nećemo ažurirati parametre korisnika u ovom toku osim ako ih izričito ne navedete ili ih ne postavite na null (ne undefined).

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

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

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

SSOUser Ažuriranje cURL Primjer

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

U ovom primjeru navodimo groupIds za kontrolu pristupa, ali ovo je opcionalno.

Struktura zahtjeva za ažuriranje SSOUsera

Copy

interface SSOUserPutQueryParams {
    tenantId: string
    API_KEY: string
    /** Kada se promijeni email ili korisničko ime, možete ovo postaviti na 'true' da ažurirate i korisnikove komentare. Ovo će udvostručiti trošak kredita. **/
    updateComments: 'true' | 'false'
}

Struktura odgovora za ažuriranje SSOUsera

Copy

interface SSOUserPutResponse {
    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-exists'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    user?: SSOUser; // Vraćamo ažuriranog korisnika u slučaju uspjeha.
}

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

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

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

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

Брисање корисникових коментара је могуће преко 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 захтјева за уклањање SSOUser

Copy

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

Структура захтјева за уклањање SSOUser

Copy

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

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

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; // Враћамо уклоњеног корисника у случају успјеха.
}

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

Објекат Subscription представља претплату за корисника.

Subscription објекти се креирају када корисник кликне на звоно обавештења у видгету за коментаре и изабере "Претплати се на ову страницу".

Претплате се такође могу креирати путем API-ја.

Поседовање објекта Subscription узрокује да се генеришу Notification објекти и да се шаљу мејлови када се оставе нови коментари на корену повезане странице за коју та Subscription важи. Слање мејлова зависи од типа корисника. За обичне кориснике то зависи од optedInNotifications. За SSO кориснике то зависи од optedInSubscriptionNotifications. Имајте у виду да неке апликације можда немају концепт веб-приступачне странице, у ком случају једноставно поставите urlId на id ставке на коју се претплаћујете (иста вредност за urlId коју бисте проследили видгету за коментаре).

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

Структура Subscription

Copy

interface Subscription {
    id: string
    tenantId: string
    /** За SSO, кориснички id је у формату `<tenant id>:<user id>`. **/
    userId: string
    anonUserId?: string
    urlId: string
    url?: string
    pageTitle?: string
    createdAt: string // стринг датума
}

GET /api/v1/subscriptions/:id

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

Ова рута враћа до 30 Subscription објеката сортираних по createdAt, најновији први.

Можете филтрирати по userId. Код SSO, userId је у формату <tenant id>:<user id>.

Пример cURL захтева за претплате корисника

Copy

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

Структура захтева за претплате

Copy

interface SubscriptionsGetQueryParams {
    tenantId: string
    API_KEY: string
    /** Пагинација прескакањем записа. **/
    skip?: number
    /** Филтрирање по кориснику. **/
    userId?: string
}

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

Copy

interface SubscriptionsGetResponse {
    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
    subscriptions?: Subscription[]
}

POST /api/v1/subscriptions

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

Ovaj API endpoint omogućava kreiranje Subscription. Imajte na umu da korisnik može imati samo jednu pretplatu po stranici, jer je više njih suvišno, a pokušaj kreiranja više od jedne pretplate za istog korisnika na istoj stranici rezultiraće greškom.

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

Primjer POST cURL za 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 u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';  
    /** Uključeno u slučaju greške. **/
    reason?: string
}

DELETE /api/v1/subscriptions/:id

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

Ova ruta briše jednu Subscription instancu po id-u.

Primjer cURL zahtjeva za brisanje Subscription

Copy

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

Struktura zahtjeva za brisanje Subscription

Copy

interface SubscriptionsDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za brisanje Subscription

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 представља употребу за тeнанта за одређени дан. Ако није било активности за одређеног тeнанта на одређеном дану, тај дан неће имати 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 biti vraćeno do 365 objekata, a cijena je 1 API kredit na svakih 10 objekata.

Objekti odgovora su sortirani po datumu kada su kreirani (najstariji prvi).

Primjer cURL pretrage TenantDailyUsage

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'

Struktura zahtjeva TenantDailyUsage

Copy

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

Struktura odgovora TenantDailyUsage

Copy

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

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

The Tenant дефинише FastComments.com клијента. Они се могу креирати преко API-ја од стране tenants који имају приступ за white labeling. White labeled tenants cannot create other white labeled tenants (only one level of nesting is allowed).

The structure for the Tenant object is as follows:

Структура 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
    /** You can store a key value pair with the tenant which you can use to query. Keys cannot contain "." or "$", or be longer than 100 chars. Values may not be longer than 2k chars. **/
    meta?: Record<string, string | null>
}

GET /api/v1/tenants/:id

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

Ovaj route vraća jednog Tenant po id-u.

cURL primjer: Tenant po ID-u

Copy

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

Struktura zahtjeva za Tenant

Copy

interface TenantByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za Tenant

Copy

interface TenantByIdResponse {
    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' | 'unauthorized'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenant?: Tenant
}

GET /api/v1/tenants

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

Овај API враћа tenants којима управља ваш tenant.

Пагинација се обезбеђује помоћу query параметра skip. Tenants се враћају страницама по 100, сортирано по signUpDate и id.

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

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

Copy

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

Можете дефинисати meta параметре на Tenant објектима и тражити одговарајуће tenants. На пример, за кључ someKey и meta вредност some-value, можемо конструисати JSON објекат са тим паром кључ/вредност и потом га URI енкодовати као query параметар за филтрирање:

Пример cURL захтева за претрагу Tenant по meta

Copy

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

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

Copy

interface TenantsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Број tenants које треба прескочити за потребе пагинације. **/
    skip?: number
    /** Филтрирање по meta параметрима. **/
    meta?: string
}

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

Copy

interface TenantsResponse {
    status: 'success' | 'failed'
    /** Укључено у случају грешке. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Укључено у случају грешке. **/
    reason?: string
    tenants?: Tenant[]
}

POST /api/v1/tenants

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

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

Креирање Tenant-а има следећа ограничења:

Потребно је поље name.
Потребно је поље domainConfiguration.
Следеће вредности не смеју бити прослеђене приликом креирања Tenant-а:
- hasFlexPricing
- lastBillingIssueReminderDate
- flexLastBilledAmount
signUpDate не сме бити у будућности.
name не сме бити дужи од 200 characters.
email не сме бити дужи од 300 characters.
email мора бити јединствен међу свим најмодавцима на FastComments.com.
Не можете креирати најмодавце ако родитељски најмодавац нема дефинисан важећи TenantPackage.
- Ако је ваш најмодавац креиран преко FastComments.com, ово не би требало бити проблем.
Не можете креирати више најмодавaца него што је дефинисано у maxWhiteLabeledTenants у вашем пакету.
Морате назначити query параметар tenantId, који је id вашег родитељског најмодавца са омогућеним white labeling-ом.

Можемо креирати Tenant само са неколико параметара:

Пример cURL захтева за креирање најмодавца

Copy

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

Структура захтева за креирање најмодавца

Copy

interface TenantPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPostResponse {
    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
    tenant?: Tenant; // Враћамо комплетан креирани tenant у случају успеха.
}

PATCH /api/v1/tenants/:id

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

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

Ažuriranje Tenant-a ima sljedeća ograničenja:

Sljedeće vrijednosti se ne mogu ažurirati:
- hasFlexPricing
- lastBillingIssueReminderDate
- flexLastBilledAmount
- managedByTenantId
signUpDate ne može biti u budućnosti.
name ne može biti duže od 200 characters.
email ne može biti duže od 300 characters.
email mora biti jedinstven među svim tenantima na FastComments.com.
Kada postavite billingInfoValid na true, billingInfo mora biti dostavljen u istom zahtjevu.
Ne možete ažurirati packageId povezan sa svojim tenantom.
Ne možete ažurirati paymentFrequency povezan sa svojim tenantom.

Primjer cURL zahtjeva za Tenant PATCH

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

Struktura zahtjeva za Tenant PATCH

Copy

interface TenantPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za Tenant PATCH

Copy

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

DELETE /api/v1/tenants/:id

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

Ова рута омогућава уклањање Tenant и свих повезаних података (корисници, коментари, итд.) по id.

Постоје следећа ограничења у вези са брисањем tenant-а:

Tenant мора бити ваш, или брандирани tenant који ви управљате.
Параметар упита sure мора бити постављен на true.

Пример cURL захтева за уклањање Tenant-а

Copy

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

Структура захтева за уклањање Tenant-а

Copy

interface TenantDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за уклањање Tenant-а

Copy

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

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

The TenantPackage дефинише информације о пакету доступном за Tenant. Тенант може имати више пакета доступних, али се у датом тренутку користи само један.

A Tenant не може да се користи за било који производ док његов packageId не упућује на важећи TenantPackage.

Постоје две врсте објеката TenantPackage:

Пакети са фиксним ценама - где је hasFlexPricing false.
Пакети са флексибилним ценама - где је hasFlexPricing true.

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

Тенант може имати више пакета и има могућност да сам промијени пакет преко Странице са информацијама о наплати.

Ако ћете сами обрађивати наплату за тенанте, и даље морате дефинисати пакет за сваког тенанта како бисте дефинисали њихове лимите. Једноставно подесите billingHandledExternally на true на Tenant и они неће моћи сами да мењају своје податке за наплату, или активни пакет.

Не смете креирати пакете са већим лимитима од матичног тенанта.

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

Структура TenantPackage

Copy

export interface TenantPackage {
    id: string
    name: string
    tenantId: string
    createdAt: string
    monthlyCostUSD: number
    yearlyCostUSD: number
    monthlyStripePlanId?: string
    yearlyStripePlanId?: string
    maxMonthlyPageLoads: number
    maxMonthlyAPICredits: number
    maxMonthlyComments: number
    maxConcurrentUsers: number
    maxTenantUsers: number
    maxSSOUsers: number
    maxModerators: number
    maxDomains: number
    maxWhiteLabeledTenants: number
    hasWhiteLabeling: boolean
    hasDebranding: boolean
    forWhoText: string
    featureTaglines: string[]
    hasAuditing: boolean
    hasFlexPricing: boolean
    flexPageLoadCostCents?: null
    flexPageLoadUnit?: null
    flexCommentCostCents?: null
    flexCommentUnit?: null
    flexSSOUserCostCents?: null // Цена по редовном SSO кориснику (без админ/модераторских дозвола)
    flexSSOUserUnit?: null
    flexAPICreditCostCents?: null
    flexAPICreditUnit?: null
    flexModeratorCostCents?: null
    flexModeratorUnit?: null
    flexAdminCostCents?: null
    flexAdminUnit?: null
    flexDomainCostCents?: null
    flexDomainUnit?: null
    flexSSOAdminCostCents?: null // Цена по SSO кориснику са администраторским дозволама (ознаке isAccountOwner или isAdminAdmin)
    flexSSOAdminUnit?: null
    flexSSOModeratorCostCents?: null // Цена по SSO кориснику са модераторским дозволама (ознака isCommentModeratorAdmin)
    flexSSOModeratorUnit?: null
    flexMinimumCostCents?: null
}

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

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

Ова рута враћа један Tenant Package према id-у.

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

Copy

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

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

Copy

interface TenantPackageByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

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

GET /api/v1/tenant-packages

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

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

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

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

Copy

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

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

Copy

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

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

Copy

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

POST /api/v1/tenant-packages

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

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

Креирање TenantPackage има следећа ограничења:

Следећи параметри су обавезни:
- name
- tenantId
- monthlyCostUSD - Може бити null.
- yearlyCostUSD - Може бити null.
- maxMonthlyPageLoads
- maxMonthlyAPICredits
- maxMonthlyComments
- maxConcurrentUsers
- maxTenantUsers
- maxSSOUsers
- maxModerators
- maxDomains
- hasDebranding
- forWhoText
- featureTaglines
- hasFlexPricing - Ако је true, онда су сви flex* параметри обавезни.
name не може бити дужи од 50 characters.
Сваки forWhoText елемент не може бити дужи од 200 characters.
Сваки featureTaglines елемент не може бити дужи од 100 characters.
TenantPackage мора бити „мањи“ од родитељског тенанта. На пример, сви max* параметри морају имати ниже вредности од родитељског тенанта.
Тенант са white labeling-ом може имати највише пет пакета.
Само тенанти са приступом white labeling могу креирати TenantPackage.
Не можете додавати пакете на сопствени tenant. :)

Можемо креирати TenantPackage на следећи начин:

Пример cURL захтева за креирање TenantPackage путем е-поште

Copy

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

Структура захтева за креирање TenantPackage

Copy

interface TenantPackagePostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantPackagePostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    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'
    /** Укључено у случају неуспеха. **/
    reason?: string
    tenantPackage?: TenantPackage; // Враћамо комплетно креирани tenantPackage при успеху.
}

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

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

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

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

Ако постављате hasFlexPricing на true, онда су сви flex* параметри обавезни у истом захтеву.
name не сме бити дужи од 50 characters.
Сваки forWhoText ставка не сме бити дужа од 200 characters.
Сваки featureTaglines ставка не сме бити дужи од 100 characters.
TenantPackage мора бити "smaller" од родитељског тенанта. На пример, сви max* параметри морају имати ниже вредности од родитељског тенанта.
Не можете променити tenantId повезан са TenantPackage.

TenantPackage PATCH cURL Пример

Copy

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

TenantPackage PATCH Структура захтева

Copy

interface TenantPackagePatchQueryParams {
    tenantId: string
    API_KEY: string
}

TenantPackage PATCH Структура одговора

Copy

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

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

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

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

Не можете уклонити TenantPackage који се користи (параметар packageId у Tenant указује на пакет). Прво ажурирајте 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
}

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

TenantUser дефинише User којим управља одређени 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

Ova ruta vraća jednog TenantUser-a po id-u.

Primjer cURL zahtjeva za TenantUser po id-u

Copy

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

Struktura zahtjeva za TenantUser

Copy

interface TenantUserByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za TenantUser

Copy

interface TenantUserByIdResponse {
    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' | 'unauthorized'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    tenantUser?: TenantUser
}

GET /api/v1/tenant-users

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

Ovaj API koristi paginaciju, omogućenu putem query parametra skip. TenantUsers se vraćaju u stranicama od 100, poredani po signUpDate, username i id.

Trošak se zasniva na broju TenantUsers koji se vrate, i iznosi 1 credit per 10 vraćenih TenantUsers.

Primjer cURL zahtjeva za TenantUser

Copy

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

Struktura zahtjeva za TenantUser

Copy

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

Struktura odgovora za TenantUser

Copy

interface TenantUsersResponse {
    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
    tenantUsers?: TenantUser[]
}

POST /api/v1/tenant-users

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

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

Креирање TenantUser има следећа ограничења:

username је обавезан.
email је обавезан.
signUpDate не може бити у будућности.
locale мора бити у листи Подржани локали.
username мора бити јединствен на целој FastComments.com. Ако је ово проблем, препоручујемо коришћење SSO-а.
email мора бити јединствен на целој FastComments.com. Ако је ово проблем, препоручујемо коришћење SSO-а.
Не смете креирати више tenant корисника него што је дефинисано под maxTenantUsers у вашем пакету.

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

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

Copy

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

Структура захтева за креирање TenantUser

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface TenantUserPostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    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'
    /** Укључено у случају неуспеха. **/
    reason?: string
    tenantUser?: TenantUser; // Враћамо комплетан TenantUser који је креиран у случају успеха.
}

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

Ova ruta omogućava slanje linka za prijavu pojedinačnom TenantUser.

Koristan kada se korisnici kreiraju u batch režimu i ne želite da im objašnjavate kako da se prijave na FastComments.com. Ovo će im jednostavno poslati "magic link" za prijavu koji ističe nakon 30 days.

Postoje sljedeća ograničenja za slanje linka za prijavu TenantUser-u:

TenantUser mora već postojati.
Morate imati pristup upravljanju Tenant-om kojem TenantUser pripada.

Možemo poslati link za prijavu TenantUser-u na sljedeći način:

Primjer cURL zahtjeva za link za prijavu TenantUser-a

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'

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

Struktura zahtjeva za link za prijavu TenantUser-a

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za link za prijavu 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' | 'unauthorized' | 'not-found'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
}

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

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

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

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

signUpDate не смије бити у будућности.
locale мора бити на листи Подржаних локала.
username мора бити јединствен на целом FastComments.com. Ако је то проблем, предлажемо коришћење SSO-а.
email мора бити јединствен на целом FastComments.com. Ако је то проблем, предлажемо коришћење SSO-а.
Не можете ажурирати tenantId корисника.

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

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

Copy

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

Структура захтева за ажурирање TenantUser

Copy

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

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

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

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

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

Сви корисникови коментари ће бити обрисани одмах.
Сви 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 захтјева за уклањање TenantUser

Copy

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

Структура захтјева за уклањање TenantUser

Copy

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

Структура одговора за уклањање TenantUser

Copy

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

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

User је објекат који представља најчешћи заједнички именитељ свих корисника.

Имајте на уму да у FastComments имамо неколико различитих сценарија коришћења за кориснике:

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

Овај API је за Commenters и кориснике креиране преко Simple SSO. У основи, сваки корисник креиран преко вашег сајта може се приступити преко овог API-ја. Tenant Users се такође могу дохватити на овај начин, али ћете добити више информација интеракцијом са /tenant-users/ API-јем.

За Secure SSO користите /sso-users/ API.

Немате могућност да ажурирате ову врсту корисника. Они су креирали налог преко вашег сајта, па пружамо само основни приступ само за читање, али не можете правити измене. Ако желите да имате овакав ток - морате да подесите Secure SSO.

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

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

Copy

export interface User {
    /** Ово је такође id који се користи као userId на comment објектима. **/
    id: string
    username: string
    /** Линк до блога коментатора, на пример. **/
    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

Ova ruta vraća jednog korisnika po ID-u.

Primjer cURL zahtjeva za korisnika po ID-u

Copy

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

Struktura zahtjeva za korisnika

Copy

interface UserByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za korisnika

Copy

interface UserByIdResponse {
    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' | 'unauthorized'
    /** Uključeno u slučaju neuspjeha. **/
    reason?: string
    user?: User
}

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

Objekat Vote predstavlja glas koji je ostavio korisnik.

Odnos između komentara i glasa je definisan 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

Гласови се морају дохватити по urlId.

Типови гласова

Постоје три врсте гласова:

Аутентификовани гласови, који се примјењују на одговарајући коментар. Можете их креирати преко овог API-ја.
Аутентификовани гласови, који чекају верификацију (pending), и стога још нису примјењени на коментар. Ови се креирају када корисник користи FastComments.com механизм пријава за гласање.
Анонимни гласови, који се примјењују на одговарајући коментар. Они се креирају уз анонимно коментарисање.

Они се враћају у посебним списковима у API-ју да би се смањила конфузија.

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

Copy

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

Структура захтјева за гласове

Copy

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

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

Copy

interface VotesResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Овлашћени, верификовани гласови, примјењени на одговарајуће коментаре. **/
    appliedAuthorizedVotes: Vote[]
    /** Анонимни гласови, примјењени на одговарајуће коментаре. **/
    appliedAnonymousVotes: Vote[]
    /** Гласови који чекају верификацију, још нису примјењени на одговарајуће коментаре. **/
    pendingVotes: Vote[]
}

Напомене о анонимним гласовима

Имајте у виду да ће анонимни гласови креирани преко овог API-ја појавити у листи appliedAuthorizedVotes. Они се сматрају овлашћеним јер су креирани преко API-ја уз API key.

Структура appliedAnonymousVotes је за гласове креиране без е-поште, API key-а итд.

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 greške. **/
    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 greške. **/
    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 objektu korisnika bilo gdje (otuda anonimno). To je jednostavno identifikator za sesiju, tako da možete ponovo dohvatiti glasove u istoj sesiji, da provjerite da li je komentar već glasovan.

Ako nemate nešto poput "anonimnih sesija" kao što ih FastComments ima - možete jednostavno postaviti ovo na slučajan ID, poput UUID-a (iako preferiramo manje identifikatore kako bismo uštedjeli prostor).

Ostale napomene

Ovaj API poštuje postavke na nivou tenanta. Na primjer, ako onemogućite glasanje za određenu stranicu, i pokušate kreirati glas putem API-ja, to će propasti sa kodom greške voting-disabled.
Ovaj API je podrazumevano 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
}

Notes:

This API obeys tenant-level settings. For example, if you disable voting for a given page, and you attempt to create a vote via the API, it will fail with error code voting-disabled.
This API is live by default.
This API will update the votes of the corresponding Comment.

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

Objekat DomainConfig predstavlja konfiguraciju za domen za zakupca.

Struktura objekta DomainConfig je sljedeća:

Struktura konfiguracije domena

Copy

interface DomainConfig {
    /** Domen, ne URL, poput "fastcomments.com" ili "www.example.com". Poddomen može biti uključen ako je cilj ograničiti na određeni poddomen. Maksimalno 1000 karaktera. **/
    domain: string
    /** Ime pošiljaoca (From-Name) koje se koristi pri slanju e-mailova. **/
    emailFromName?: string
    /** From-Email koji se koristi pri slanju e-mailova. Osigurajte da je SPF podešen da dozvoli mail.fastcomments.com da šalje e-mailove u ime domena koji se koristi u ovom svojstvu. **/
    emailFromEmail?: string
    /** SAMO ZA ČITANJE. Kada je objekat kreiran. **/
    createdAt: string
    /** Logo povezan sa ovim domenom. Koristi se u e-mailovima. Koristite HTTPS. **/
    logoSrc?: string
    /** Manji logo povezan sa ovim domenom. Koristite HTTPS. **/
    logoSrc100px?: string
    /** SAMO SSO. URL koji se koristi u podnožju svakog poslatog e-maila. Podržava varijablu "[userId]". **/
    footerUnsubscribeURL?: string
    /** SAMO SSO. Zaglavlja koja se koriste u svakom poslatom e-mailu. Korisno, na primjer, za postavljanje zaglavlja vezanih za odjavu kako bi se poboljšala isporuka. Unos List-Unsubscribe u ovom zapisu, ako postoji, podržava varijablu "[userId]". **/
    emailHeaders?: Record<string, string>
    /** Onemogući sve linkove za odjavu. Ne preporučuje se, može negativno uticati na stope isporuke. **/
    disableUnsubscribeLinks?: boolean
    /** DKIM konfiguracija. **/
    dkim?: DomainConfigDKIM
}

Struktura DKIM konfiguracije

Copy

interface DomainConfigDKIM {
    /** Naziv domena u vašem DKIM zapisu. **/
    domainName: string
    /** DKIM selektor ključa koji se koristi. **/
    keySelector: string
    /** Vaš privatni ključ. Počinje sa -----BEGIN PRIVATE KEY----- i završava sa -----END PRIVATE KEY----- **/
    privateKey: string
}

Za autentifikaciju

Konfiguracija domena se koristi za određivanje koji sajtovi mogu hostovati FastComments widget za vaš nalog. Ovo je osnovni oblik autentifikacije, što znači da dodavanje ili uklanjanje bilo kojih konfiguracija domena može uticati na dostupnost vaše FastComments instalacije u produkciji.

Ne uklanjajte niti ažurirajte svojstvo domain objekta Domain Config za domen koji se trenutno koristi, osim ako ne namjeravate onemogućiti taj domen.

Ovo ima isto ponašanje kao uklanjanje domena sa /auth/my-account/configure-domains.

Takođe imajte na umu da uklanjanje domena iz My Domains UI ukloniće svaku odgovarajuću konfiguraciju za taj domen koja je možda dodata putem tog sučelja.

Za prilagođavanje e-mailova

Link za odjavu u podnožju e-maila i funkcija jednim klikom za odjavu koju nude mnogi e-mail klijenti mogu se konfigurirati putem ovog API-ja definisanjem footerUnsubscribeURL i emailHeaders, redom.

Za DKIM

Nakon što definišete svoje DKIM DNS zapise, jednostavno ažurirajte DomainConfig sa vašom DKIM konfiguracijom koristeći definisanu strukturu.

GET /api/v1/domain-configs

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

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

DomainConfig GET cURL Примјер

Copy

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

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

Појединачне DomainConfigs се могу преузети по одговарајућем domain.

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

Copy

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

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

Copy

interface DomainConfigsByDomainRequestQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

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

POST /api/v1/domain-configs

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

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

Додавање конфигурације за домен овлашћава тај домен за FastComments налог.

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

Пример cURL захтева за 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]>"
    }
}'

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

Copy

interface DomainConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

interface DomainConfigPostResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспеха. **/
    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';  
    /** Укључено у случају неуспеха. **/
    reason?: string
    /** Креирана конфигурација. **/
    configuration?: DomainConfig
}

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

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

Ova API krajnja tačka omogućava ažuriranje konfiguracije domena navodeći 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",
}'

Struktura zahtjeva za DomainConfig PATCH

Copy

interface DomainConfigPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za DomainConfig PATCH

Copy

interface DomainConfigPatchResponse {
    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
}

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

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

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

DomainConfig PUT cURL Пример

Copy

curl --request PUT \
  --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "domain": "new-domain-example.com",
    "emailFromName": "some from name",
    "emailFromEmail": "some@test.com",
    "logoSrc": "https://example.com/my-logo-big.png",
    "logoSrc100px": "https://example.com/my-logo-100px.png",
    "footerUnsubscribeURL": "http://example.com/unsubscribe-ui",
    "emailHeaders": {
        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
        "List-Unsubscribe": "<https://example.com/opt-out/[userId]>"
    }
}'

DomainConfig PUT Структура захтева

Copy

interface DomainConfigPutQueryParams {
    tenantId: string
    API_KEY: string
}

DomainConfig PUT Структура одговора

Copy

interface DomainConfigPutResponse {
    status: 'success' | 'failed'
    /** Укључено у случају неуспјеха. **/
    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';  
    /** Укључено у случају неуспјеха. **/
    reason?: string
    /** Ажурирана конфигурација. **/
    configuration?: DomainConfig
}

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

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

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

Напомена: Уклањање DomainConfig ће поништити овлашћење тог домена за коришћење FastComments.
Напомена: Поновним додавањем домена преко корисничког интерфејса објекат ће бити поново креиран (са попуњеним само пољем domain).

Пример cURL захтева за уклањање DomainConfig

Copy

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

Структура захтева за уклањање DomainConfig

Copy

interface DomainConfigRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Структура одговора за уклањање DomainConfig

Copy

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

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

FastComments pruža način za konstruisanje pitanja i agregiranje njihovih rezultata. Primjer pitanja (u daljem tekstu nazvan QuestionConfig) može biti ocjena sa zvjezdicama, klizač, ili NPS pitanje (određeno putem type).

Podaci o pitanjima mogu se agregirati pojedinačno, zajedno, tokom vremena, ukupno, po stranici, i tako dalje.

Okvir ima sve mogućnosti potrebne za izgradnju klijentskih vidžeta (sa vašim serverom ispred ovog API-ja), administratorskih kontrolnih tabli i alata za izvještavanje.

Prvo, moramo definisati QuestionConfig. Struktura je sljedeća:

Struktura QuestionConfig

Copy

type QuestionConfigType = 'nps' | 'slider' | 'star' | 'thumbs';
interface QuestionConfig {
    id: string
    tenantId: string
    name: string
    question: string
    helpText?: string
    createdAt: string
    createdBy: string
    /** SAMO ZA ČITANJE - povećava se za svaki novi odgovor. **/
    usedCount: number
    /** String datuma koji označava kada je konfiguracija posljednji put korišćena (ostavljen rezultat). **/
    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

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

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

Copy

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

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

Copy

interface QuestionConfigRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

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

POST /api/v1/question-configs

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

Ova krajnja tačka API-ja omogućava kreiranje QuestionConfig.

QuestionConfig POST cURL primer

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

Struktura POST zahteva za QuestionConfig

Copy

interface QuestionConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura POST odgovora za QuestionConfig

Copy

interface QuestionConfigPostResponse {
    status: 'success' | 'failed'
    /** Uključeno u slučaju greške. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';  
    /** Uključeno u slučaju greške. **/
    reason?: string
    /** Kreirani objekat. **/
    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

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

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

Пример cURL захтева за уклањање QuestionConfig

Copy

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

Структура захтева за уклањање QuestionConfig

Copy

interface QuestionConfigDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

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

Copy

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

Структура резултата питања

Да бисте сачували резултате за питања, креирате QuestionResult. Затим можете агрегирати резултате питања, и такође их повезати са коментарима у сврху извештавања.

Struktura QuestionResult

Copy

interface QuestionResultMeta {
    name: string
    values: string[]
}
interface QuestionResult {
    id: string
    tenantId: string
    urlId: string
    anonUserId?: string
    userId?: string
    createdAt?: string
    value: number
    commentId?: string
    questionId: string
    meta?: QuestionResultMeta[]
}

GET /api/v1/question-results

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

Ова рута враћа до 1000 QuestionResults објеката одједном, у пагинираном облику. Цена је 1 на сваких 100 објеката. Они су сортирани по createdAt, у растућем редослиједу. Можете филтрирати по различитим параметрима.

Пример QuestionResults

Copy

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

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

Copy

interface QuestionResultsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** За пагинацију. Почиње од 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.

QuestionResult POST cURL Primjer

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/question-results?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "urlId": "some-page-id",
    "anonUserId": 'anon-0',
    "userId": 'user-0',
    "value": 10,
    "questionId": "some-question-id",
    "meta": [
        {
            name: "example",
            values: ["value-1", "value-2"]
        }
    ]
}'

QuestionResult POST Struktura zahtjeva

Copy

interface QuestionResultPostQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionResult POST Struktura odgovora

Copy

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

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

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

Ova ruta omogućava ažuriranje jednog QuestionResult.

Sljedeća struktura prikazuje 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 greške. **/
    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 greške. **/
    reason?: string
}

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

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

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

Primjer cURL zahtjeva za uklanjanje QuestionResult

Copy

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

Struktura zahtjeva za uklanjanje QuestionResult

Copy

interface QuestionResultDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Struktura odgovora za uklanjanje QuestionResult

Copy

interface QuestionResultResponse {
    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
}

GET /api/v1/question-results-aggregate

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

Ovo je mjesto gdje se vrši agregacija rezultata.

Struktura odgovora agregacije je sljedeća:

Struktura QuestionResultsAggregationResult

Copy

interface QuestionResultDataPoint {
    /** Mapa vrijednosti na broj pojavljivanja te vrijednosti za trenutnu tačku podataka (grupa po datumu ili stranica). **/
    v: Map<ValueAsString, number>
    total: number
}
interface QuestionResultsAggregationResult {
    /** Napomena - null je kada timeBucket nije naveden. **/
    dataByDateBucket?: Map<DateString, QuestionResultDataPoint>
    dataByUrlId?: Map<URLIdString, QuestionResultDataPoint>
    countsByValue?: Map<ValueAsString, number>
    /** Ukupan broj agregiranih rezultata. **/
    total: number
    /** Dobijeni ponderisani prosek. To je float, obično sa dvije decimale ili manje. **/
    average: number
    /** String datuma koji predstavlja kada su ovi podaci izračunati, jer mogu doći iz keša. **/
    createdAt: string
}

Ovo su parametri upita dostupni za agregaciju:

Struktura zahtjeva QuestionResultsAggregation

Copy

interface QuestionResultsAggregateRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** Možete agregirati rezultate za jedno ili više pitanja. **/
    questionId: string | string[]
    startDate?: string | number
    timeBucket?: 'day' | 'month' | 'year'
    /** Agregacija za određenu stranicu. **/
    urlId?: string
    /** Agregacija za određenog korisnika. **/
    userId?: string
    /** Prisiliti ponovno izračunavanje sada i ažurirati keš. **/
    forceRecalculate?: boolean
}

Evo primjera zahtjeva:

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

Primjer odgovora:

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

Struktura odgovora QuestionResultsAggregation

Copy

interface QuestionResultsAggregationResponse {
    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
    data: QuestionResultsAggregationResult
}

Napomene o performansama

Ako nema podataka u kešu, agregacije obično traju pet sekundi po milionu rezultata.
U suprotnom, zahtjevi se izvršavaju u konstantnom vremenu.

Napomene o keširanju i troškovima

Kada je forceRecalculate naveden, trošak je uvijek 10, umjesto uobičajenih 2.
Ako keš istekne i podaci se ponovo izračunaju, trošak je i dalje konstantan 2 ako forceRecalculate nije naveden. Keš ističe na osnovu veličine agregiranog skupa podataka (može varirati između 30 sekundi i 5 minuta).
Ovo je da bi se podstaklo korišćenje keša.

GET /api/v1/question-results-aggregate/combine/comments

Resource: QuestionResultsCombinedWithComments as GET /api/v1/question-results-aggregate/combine/comments Credit Cost: 2

Ovo je mjesto gdje se kombinuju rezultati sa komentarima. Korisno za kreiranje, na primjer, grafikona "nedavni pozitivni i negativni komentari" za proizvod.

Možete pretraživati po rasponu vrijednosti (uključivo), jednoj ili više pitanja, i po početnom datumu (uključivo).

The response structure is as follows:

Struktura 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 {
    /** Datum u obliku stringa koji predstavlja kada su ovi podaci izračunati, pošto mogu doći iz keša. **/
    createdAt: string
    results: CommentAndResult[]
}

Here are the query parameters available for aggregation:

Struktura zahtjeva QuestionResultsCombineComments

Copy

interface QuestionResultsAggregateRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** You can aggregate results for one or more questions. **/
    questionId: string | string[]
    startDate?: string | number
    urlId?: string
    minValue: number
    maxValue: number
    limit?: number
    forceRecalculate?: boolean
}

Here's an example request:

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

Example response:

Primjer odgovora 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
            }
        }
    ]
}

Struktura odgovora QuestionResultsCombineComments

Copy

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

Caching and Cost Notes

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.
This is to incentivize using the cache.

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

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
    /** Боја позадине за значку (hex код) */
    backgroundColor?: string
    /** Боја ивице значке (hex код) */
    borderColor?: string
    /** Боја текста значке (hex код) */
    textColor?: string
    /** Додатна CSS класа за стиловање */
    cssClass?: string
    /** За veteran значке, праг времена у милисекундама */
    veteranUserThresholdMillis?: number
    /** Да ли се ова значка приказује на корисниковим коментарима */
    displayedOnComments: boolean
    /** Редослед приказа значке */
    order?: number
}

---

GET /api/v1/user-badges

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

Example Request:

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

Copy

Run

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

You can add various query parameters to filter the results:

userId - Добијте значке за специфичног корисника
badgeId - Добијте инстанце одређене значке
type - Филтрирајте по типу значке (0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, etc. See UserBadge structure for full list)
displayedOnComments - Филтрирајте по томе да ли је значка приказана на коментарима (true/false)
limit - Максималан број значки које се враћају (подразумевано 30, максимум 200)
skip - Број значки које треба прескочити (за пагинацију)

Example Response:

Одговор

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

Possible Error Responses:

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

Copy

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

Грешка: Неисправан limit

Copy

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

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

Ovaj endpoint vam omogućava да dohватите одређени кориснички bedž по његовом јединственом ID-у.

Example Request:

Primjer GET zahtjeva

Copy

Run

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

Example Response:

Odgovor

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

Possible Error Responses:

Greška: Nedostaje ID zakupca

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 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) - ИД корисника коме се додјељује значка
badgeId (required) - ИД значке која се додјељује
displayedOnComments (optional) - Да ли би значка требала бити видљива на коментарима корисника (подразумевано: 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 dodeljivanja korisničkog bedža.

Trenutno, jedino svojstvo koje se može ažurirati je displayedOnComments, koje kontroliše da li se bedž prikazuje na komentarima korisnika.

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

Ова крајња тачка вам омогућава да обришете додељивање корисничке ознаке.

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

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

Copy

Run

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

Пример одговора:

Одговор

Copy

{
  "status": "success"
}

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

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

Copy

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

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

Copy

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

Грешка: Није пронађено

Copy

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

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

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

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

Struktura UserBadgeProgress objekta je sljedeća:

Struktura UserBadgeProgress objekta

Copy

export interface UserBadgeProgress {
    /** Jedinstveni identifikator ovog zapisa o napretku */
    id: string
    /** ID tenant-a kome 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 Unix epohe) */
    firstCommentDate?: number
    /** Automatski izračunat faktor povjerenja zasnovan na aktivnosti korisnika */
    autoTrustFactor?: number
    /** Faktor povjerenja ručno postavljen od strane administratora */
    manualTrustFactor?: number
    /** Detaljan objekat napretka sa raznim metrikama, ključevi odgovaraju BadgeType enumeraciji */
    progress: {
        /** 0: CommentCount - Broj komentara koje je korisnik ostavio */
        '0'?: number
        /** 1: CommentUpVotes - Broj upvota koje je korisnik dobio */
        '1'?: number
        /** 2: CommentReplies - Broj odgovora koje je korisnik dao */
        '2'?: number
        /** 3: CommentsPinned - Broj pinovanih 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 - Prosječno vrijeme odgovora u milisekundama */
        '6'?: number
        /** 7: ModeratorCommentsDeleted - Za moderatorne značke, broj izbrisanih komentara */
        '7'?: number
        /** 8: ModeratorCommentsApproved - Za moderatorne značke, broj odobrenih komentara */
        '8'?: number
        /** 9: ModeratorCommentsUnapproved - Za moderatorne značke, broj neodobrenih komentara */
        '9'?: number
        /** 10: ModeratorCommentsReviewed - Za moderatorne značke, broj pregledanih komentara */
        '10'?: number
        /** 11: ModeratorCommentsMarkedSpam - Za moderatorne značke, broj komentara označenih kao spam */
        '11'?: number
        /** 12: ModeratorCommentsMarkedNotSpam - Za moderatorne značke, broj komentara označenih kao 'nije 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
      }
    }
  ]
}

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

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

Copy

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

Грешка: Неважећи Limit

Copy

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

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

Ovaj endpoint vam omogućava да dohvatite конкретан запис о напретку корисничке значке по његовом јединственом ID-у.

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

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

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

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

Copy

Run

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

Пример одговора:

Одговор

Copy

{
  "status": "success",
  "userBadgeProgress": {
    "id": "progress123",
    "tenantId": "tenant001",
    "userId": "user456",
    "firstCommentId": "comment789",
    "firstCommentDate": 1650532511000,
    "autoTrustFactor": 0.75,
    "progress": {
      "0": 42,
      "1": 120,
      "2": 15,
      "3": 3,
      "5": 5,
      "6": 1800000,
      "8": 0,
      "7": 0
    }
  }
}

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

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

Copy

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

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

Copy

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

Грешка: Није пронађено

Copy

{
  "status": "failed",
  "code": "not-found",
  "reason": "No badge progress found for user user456 in tenant tenant001."
}

У закључку

Надамо се да сте нашу API документацију сматрали исцрпном и лаком за разумевање. Ако уочите било какве пропусте, јавите нам испод.

Језик 🇲🇪 Српски (Црна Гора)

API ресурси

Агрегације

Дневници ревизије

Коментари

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

Хештегови

Модератори

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

Обавештења

Странице

Непроцесирани вебхук догађаји

SSO корисници

Претплате

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

Тенанти

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

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

Корисници

Гласови

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

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

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

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

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

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

FastComments API

Generisani SDK-ovi

Autentifikacija

Sigurnosna napomena

Opcija autentifikacije 1 - Zaglavlja

Opcija autentifikacije 2 - Parametri upita

API ресурси

Korišćenje resursa

Napomena!

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

Примери

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

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

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

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

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

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

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

Пример: Број коментара на чекању за преглед

Пример: Расподела одобрених, прегледаних и спам коментара

Структуре

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

GET /api/v1/audit-logs

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

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

Ознаке (Tagging)

Хештегови

GET /api/v1/comments

Paginacija

Niti

Objašnjenje stabala

Dohvatanje komentara u kontekstu korisnika

Dohvati komentare kao stablo

Dohvati komentare kao stablo, pretraga po haštagu

Svi parametri zahteva

Odgovor

Korisni savjeti

URL ID

Anonimne radnje

Komentari se ne vraćaju

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

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

Напомене

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

GET /api/v1/email-templates

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

POST /api/v1/email-templates