लाइव टिप्पणी APIs

FastComments API

FastComments कई संसाधनों (resources) के साथ इंटरैक्ट करने के लिए एक API प्रदान करता है। हमारे प्लेटफ़ॉर्म के साथ इंटीग्रेशन बनाएं, या अपने स्वयं के क्लाइंट भी बनाएं!

इस दस्तावेज़ीकरण में, आपको API द्वारा समर्थित सभी संसाधनों का दस्तावेज़ीकरण उनके रिक्वेस्ट और रिस्पॉन्स प्रकारों के साथ मिलेगा।

Enterprise ग्राहकों के लिए, सभी API एक्सेस Audit Log में कैप्चर किया जाता है।

जेनरेट किए गए SDKs

FastComments अब हमारे कोड से एक API Spec जेनरेट करता है (यह अभी पूरा नहीं है, लेकिन इसमें कई APIs शामिल हैं)।

हमारे पास अब लोकप्रिय भाषाओं के लिए SDKs भी हैं:

प्रमाणीकरण (Authentication)

API आपकी api key को X-API-KEY हेडर या API_KEY क्वेरी पैरामीटर के रूप में पास करके प्रमाणित की जाती है। API कॉल करने के लिए आपको अपनी tenantId भी चाहिए होगी। यह आपकी api key वाले उसी पेज से प्राप्त की जा सकती है।

सुरक्षा नोट

इन रूट्स को सर्वर से कॉल करने के लिए ही है। इन्हें ब्राउज़र से कॉल न करें। ऐसा करने से आपकी API key उजागर हो जाएगी - इससे आपके खाते तक पूर्ण एक्सेस उन सभी को मिल जाएगा जो किसी पेज का सोर्स कोड देख सकते हैं!

प्रमाणीकरण विकल्प एक - Headers

Header: X-API-KEY
Header: X-TENANT-ID

प्रमाणीकरण विकल्प दो - Query Parameters

Query Param: API_KEY
Query Param: tenantId

प्रमाणीकरण विकल्प तीन - OAuth Bearer Token

Header: Authorization: Bearer fcat_...

Zapier जैसे थर्ड-पार्टी एप्लिकेशन और MCP server के क्लाइंट API key के बजाय OAuth के माध्यम से एक टोकन प्राप्त करते हैं। वह टोकन यहाँ हर एंडपॉइंट पर काम करता है। टोकन से tenant निहित रहता है, इसलिए tenantId वैकल्पिक है, लेकिन दिया जाने पर यह टोकन से मेल खाना चाहिए। GET रिक्वेस्ट को read स्कोप की आवश्यकता होती है और हर अन्य मेथड को write स्कोप की। पूरा फ़्लो, जिसमें क्लाइंट रजिस्ट्रेशन, PKCE, रिफ्रेश और रिवोकेशन शामिल है, OAuth Authorization के अंतर्गत दस्तावेज़ित है। डिस्कवरी https://fastcomments.com/.well-known/oauth-authorization-server से शुरू होती है।

अपने स्वयं के राइट्स पढ़ना (Reading Your Own Writes)

FastComments Active-Active उपलब्धता प्रदान करता है। आपके डेटासेंटर से रिक्वेस्ट आपके निकटतम पॉइंट ऑफ़ प्रेज़ेंस पर रूट की जाती हैं। यह स्वचालित है, और सामान्यतः आप read-your-write सिमेंटिक्स देख सकते हैं। यदि आप यह सुनिश्चित करना चाहते हैं कि आप अपने स्वयं के राइट्स पढ़ें, तो आप उस क्षेत्र को अपने API होस्ट के रूप में उपयोग करके अपनी रिक्वेस्ट को एक निश्चित क्षेत्र (region) पर पिन कर सकते हैं (हालाँकि अधिकांश इंटीग्रेशन के लिए यह सामान्यतः आवश्यक नहीं है):

gdc-oregon.fastcomments.com
gdc-virginia.fastcomments.com
gdc-singapore.fastcomments.com
gdc-falkenstein2.fastcomments.com
gdc-sao-paulo.fastcomments.com
eudc-helsinki2.fastcomments.com
eudc-limburg.fastcomments.com
eudc-france.fastcomments.com

ध्यान दें कि यदि आप ऐसा करते हैं तो आप एक फ़ॉलबैक परिभाषित करना चाह सकते हैं, क्योंकि हमने अतीत में एंट्रीपॉइंट नोड्स को deprecated किया है और स्विचओवर के लिए नए नामों का उपयोग किया है।

API संसाधन

संसाधन उपयोग

यह ध्यान दिया जाना चाहिए कि API से डेटा प्राप्त करना आपके खाते पर उपयोग के रूप में गिना जाता है।

प्रत्येक संसाधन अपने स्वयं के अनुभाग में यह बताएगा कि वह उपयोग क्या है।

कुछ संसाधनों को सर्व करना अन्य की तुलना में अधिक महंगा होता है। प्रत्येक एंडपॉइंट की प्रति API कॉल क्रेडिट्स की एक निश्चित लागत होती है। कुछ एंडपॉइंट्स के लिए, क्रेडिट्स की संख्या विकल्पों और रिस्पॉन्स साइज़ के आधार पर भिन्न होती है।

API उपयोग की जांच Billing Analytics पेज पर की जा सकती है और यह हर कुछ मिनटों में अपडेट होता है।

ध्यान दें!

हम सुझाव देते हैं कि पहले Pages दस्तावेज़ीकरण पढ़ें, ताकि Comment API में urlId के लिए कौन से मान पास करने हैं, यह निर्धारित करते समय भ्रम को सीमित करने में मदद मिले।

Webhooks

Webhook सब्सक्रिप्शन की अपनी एक गाइड है। POST, GET और DELETE /api/v1/webhooks, तथा GET /api/v1/webhooks/sample-payloads, को Managing Subscriptions via API के अंतर्गत दस्तावेज़ित किया गया है, और इवेंट पेलोड्स को Webhook Structures के अंतर्गत।

OAuth प्राधिकरण

FastComments एक OAuth 2.1 ऑथराइज़ेशन सर्वर है। एक एप्लिकेशन एक टोकन प्राप्त कर सकता है जो एक FastComments खाते से बंधा होता है और इस गाइड में हर एंडपॉइंट पर API की के स्थान पर उसका उपयोग कर सकता है। Zapier ऐप, MCP सर्वर, और अन्य थर्ड-पार्टी इंटीग्रेशन इसी तरह कनेक्ट होते हैं।

टोकन PKCE के साथ ऑथराइज़ेशन कोड फ्लो के माध्यम से जारी किए जाते हैं। कोई client credentials या implicit grant नहीं है।

डिस्कवरी

एंडपॉइंट के स्थान, समर्थित ग्रांट, और ऑथ मेथड्स मानक मेटाडेटा URL पर प्रकाशित होते हैं:

ऑथराइज़ेशन सर्वर मेटाडेटा

Copy

https://fastcomments.com/.well-known/oauth-authorization-server

इसके द्वारा वर्णित एंडपॉइंट:

OAuth एंडपॉइंट

Copy

GET  https://fastcomments.com/oauth/authorize
POST https://fastcomments.com/oauth/token
POST https://fastcomments.com/oauth/revoke
POST https://fastcomments.com/oauth/register

EU क्षेत्र के खाते https://eu.fastcomments.com को issuer के रूप में उपयोग करते हैं, उसी पाथ के साथ।

क्लाइंट रजिस्टर करना

फ्लो शुरू करने से पहले एक क्लाइंट को client_id और एक रजिस्टर्ड redirect_uri की आवश्यकता होती है। इसे प्राप्त करने के दो तरीके हैं:

डायनामिक क्लाइंट रजिस्ट्रेशन। RFC 7591 के अनुसार JSON बॉडी के साथ POST /oauth/register (redirect_uris, client_name, client_uri, logo_uri, token_endpoint_auth_method)। रिस्पॉन्स में client_id और, कॉन्फिडेंशियल क्लाइंट्स के लिए, client_secret होता है। रजिस्ट्रेशन बिना ऑथेंटिकेशन के होता है और प्रति IP रेट लिमिटेड है।
क्लाइंट ID मेटाडेटा डॉक्यूमेंट। क्लाइंट अपने नियंत्रण वाले एक https URL को अपने client_id के रूप में उपयोग करता है। FastComments उस URL को फ़ेच करता है और उससे वही मेटाडेटा फ़ील्ड पढ़ता है। किसी रजिस्ट्रेशन कॉल की आवश्यकता नहीं है।

FastComments डैशबोर्ड में सूचीबद्ध पार्टनर एप्लिकेशन, जैसे Zapier, सीधे FastComments द्वारा रजिस्टर किए जाते हैं। यदि आप मार्केटप्लेस लिस्टिंग बना रहे हैं और फर्स्ट-पार्टी क्लाइंट की आवश्यकता है तो सपोर्ट से संपर्क करें।

स्कोप

Copy

read   GET and HEAD requests
write  every other method

कोई स्कोप न मांगने वाला रिक्वेस्ट दोनों प्राप्त करता है। उपयोगकर्ता को कंसेंट पेज पर अनुरोधित स्कोप दिखाई देते हैं। इन दो के अलावा किसी अन्य स्कोप का अनुरोध invalid_scope के साथ विफल हो जाता है।

चरण 1 - ऑथराइज़ेशन रिक्वेस्ट

उपयोगकर्ता के ब्राउज़र को authorize एंडपॉइंट पर भेजें। हर क्लाइंट के लिए S256 मेथड के साथ PKCE आवश्यक है।

ऑथराइज़ेशन रिक्वेस्ट

Copy

GET https://fastcomments.com/oauth/authorize
    ?response_type=code
    &client_id=YOUR_CLIENT_ID
    &redirect_uri=https://example.com/oauth/callback
    &scope=read%20write
    &state=RANDOM_STATE
    &code_challenge=BASE64URL_SHA256_OF_VERIFIER
    &code_challenge_method=S256

ऑथराइज़ेशन रिक्वेस्ट पैरामीटर

Copy

interface OAuthAuthorizeQueryParams {
    response_type: 'code'
    client_id: string
    /** क्लाइंट के रजिस्टर्ड redirect URI में से किसी एक से बिल्कुल मेल खाना चाहिए। **/
    redirect_uri: string
    /** स्पेस से अलग किया गया। दोनों स्कोप मांगने के लिए छोड़ दें। **/
    scope?: 'read' | 'write' | 'read write'
    /** रीडायरेक्ट पर अपरिवर्तित लौटाया जाता है। कॉलबैक को उस सेशन से बांधने के लिए उपयोग करें जिसने फ्लो शुरू किया। **/
    state?: string
    /** base64url(sha256(code_verifier))। **/
    code_challenge: string
    code_challenge_method: 'S256'
    /** वैकल्पिक RFC 8707 रिसोर्स इंडिकेटर। यदि भेजा गया, तो वही मान token एंडपॉइंट को भेजा जाना चाहिए। **/
    resource?: string
}

उपयोगकर्ता आवश्यकता होने पर FastComments में साइन इन करता है और एक कंसेंट पेज देखता है जिसमें आपका एप्लिकेशन, वह खाता जिससे इसे कनेक्ट किया जाएगा, और अनुरोधित स्कोप नामित होते हैं। उपयोगकर्ता के पास उस खाते पर API Admin अनुमति होनी चाहिए; कोई अन्य व्यक्ति कंसेंट फॉर्म के बजाय अनुमति त्रुटि देखता है। स्वीकृति करने पर ब्राउज़र आपके redirect_uri पर code और state के साथ रीडायरेक्ट होता है। अस्वीकृति करने पर error=access_denied के साथ रीडायरेक्ट होता है।

ऑथराइज़ेशन कोड 10 मिनट के लिए मान्य है और इसे एक बार एक्सचेंज किया जा सकता है। उसी कोड का दूसरा एक्सचेंज पहले एक्सचेंज द्वारा उत्पादित हर टोकन को रद्द कर देता है।

चरण 2 - टोकन रिक्वेस्ट

कोड को टोकन के लिए एक्सचेंज करें। बॉडी फॉर्म एनकोडेड है। कॉन्फिडेंशियल क्लाइंट्स client_secret_basic (HTTP Basic) या client_secret_post (बॉडी में सीक्रेट) के साथ ऑथेंटिकेट करते हैं। पब्लिक क्लाइंट्स केवल client_id भेजते हैं।

टोकन रिक्वेस्ट cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/oauth/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'grant_type=authorization_code' \
  --data 'client_id=YOUR_CLIENT_ID' \
  --data 'client_secret=YOUR_CLIENT_SECRET' \
  --data 'code=fcac_...' \
  --data 'code_verifier=YOUR_PKCE_VERIFIER' \
  --data 'redirect_uri=https://example.com/oauth/callback'

टोकन रिक्वेस्ट बॉडी (authorization_code)

Copy

interface OAuthTokenRequestAuthorizationCode {
    grant_type: 'authorization_code'
    client_id: string
    /** केवल कॉन्फिडेंशियल क्लाइंट्स। इसके बजाय HTTP Basic auth के रूप में भेजा जा सकता है। **/
    client_secret?: string
    code: string
    code_verifier: string
    /** भेजे जाने पर ऑथराइज़ेशन रिक्वेस्ट से मेल खाना चाहिए। **/
    redirect_uri?: string
    resource?: string
}

टोकन रिस्पॉन्स संरचना

Copy

interface OAuthTokenResponse {
    /** fcat_ प्रीफिक्स। एक घंटे के लिए मान्य। **/
    access_token: string
    token_type: 'bearer'
    /** एक्सेस टोकन के समाप्त होने तक सेकंड। 3600। **/
    expires_in: number
    /** fcrt_ प्रीफिक्स। जारी होने से 30 दिनों तक मान्य। **/
    refresh_token: string
    /** स्पेस से अलग किए गए प्रदान किए गए स्कोप। **/
    scope: string
}

त्रुटियां RFC 6749 का पालन करती हैं: error और error_description के साथ JSON बॉडी, invalid_request, invalid_grant, invalid_scope, invalid_target और unsupported_grant_type के लिए HTTP 400, invalid_client के लिए HTTP 401, रेट लिमिटेड होने पर HTTP 429।

चरण 3 - API कॉल करना

एक्सेस टोकन को बेयरर टोकन के रूप में भेजें। टेनेंट टोकन द्वारा निहित होता है, इसलिए tenantId वैकल्पिक है। दिया जाने पर इसे टोकन से मेल खाना चाहिए अन्यथा रिक्वेस्ट विफल हो जाती है।

बेयरर टोकन cURL उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/me' \
  --header 'Authorization: Bearer fcat_...'

GET /api/v1/me टेनेंट, ऑथराइज़िंग उपयोगकर्ता, और प्रदान किए गए स्कोप लौटाता है, जो इसे कनेक्शन टेस्ट के लिए सही कॉल बनाता है। समाप्त या रद्द किए गए टोकन वाली रिक्वेस्ट को HTTP 401 मिलता है। जिस मेथड को टोकन के पास नहीं है उस स्कोप की आवश्यकता वाली रिक्वेस्ट को HTTP 403 मिलता है।

चरण 4 - रिफ्रेश करना

रिफ्रेश रिक्वेस्ट cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/oauth/token' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'grant_type=refresh_token' \
  --data 'client_id=YOUR_CLIENT_ID' \
  --data 'client_secret=YOUR_CLIENT_SECRET' \
  --data 'refresh_token=fcrt_...'

टोकन रिक्वेस्ट बॉडी (refresh_token)

Copy

interface OAuthTokenRequestRefreshToken {
    grant_type: 'refresh_token'
    client_id: string
    client_secret?: string
    refresh_token: string
    /** वैकल्पिक। मूल रूप से प्रदान किए गए स्कोप के एक सबसेट तक सीमित करता है। **/
    scope?: string
    resource?: string
}

रिस्पॉन्स की आकृति कोड एक्सचेंज के समान है। रिफ्रेश टोकन रोटेट होते हैं: प्रत्येक रिफ्रेश एक नया refresh_token लौटाता है और समवर्ती रिक्वेस्ट्स के लिए 30 सेकंड की ग्रेस विंडो के बाद पुराने को रद्द कर देता है। 30 सेकंड से अधिक पहले रोटेट किए गए रिफ्रेश टोकन को प्रस्तुत करना रिप्ले माना जाता है और पूरे ग्रांट को रद्द कर देता है। FastComments द्वारा रजिस्टर किए गए पार्टनर एप्लिकेशन रोटेशन से मुक्त हैं और उन्हें वही रिफ्रेश टोकन वापस मिलता है जिसकी समाप्ति अन्य 30 दिनों तक बढ़ा दी जाती है।

एक रिफ्रेश यह भी पुनः जांचता है कि ऑथराइज़िंग उपयोगकर्ता अभी भी खाते पर API Admin है। यदि नहीं, तो ग्रांट रद्द कर दिया जाता है और रिस्पॉन्स invalid_grant होता है।

रद्दीकरण

रिवोक रिक्वेस्ट cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/oauth/revoke' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=YOUR_CLIENT_ID' \
  --data 'client_secret=YOUR_CLIENT_SECRET' \
  --data 'token=fcrt_...' \
  --data 'token_type_hint=refresh_token'

एक रिफ्रेश टोकन को रद्द करने से उसी ग्रांट से जारी हर एक्सेस टोकन रद्द हो जाता है। एक एक्सेस टोकन को रद्द करने से केवल वही टोकन रद्द होता है। एंडपॉइंट RFC 7009 के अनुसार, टोकन मिले या न मिले, खाली JSON ऑब्जेक्ट के साथ HTTP 200 लौटाता है।

उपयोगकर्ता FastComments डैशबोर्ड में Connected Apps से भी कनेक्शन रद्द कर सकते हैं। उस एप्लिकेशन का हर टोकन तुरंत काम करना बंद कर देता है।

अपना डेटा एकत्रित करें

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

यह API दस्तावेज़ों को समूहित करके (यदि groupBy दिया गया है) और कई ऑपरेशन लागू करके एकत्रित करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।

लागत परिवर्तनशील है। स्कैन किए गए प्रत्येक 500 ऑब्जेक्ट पर 1 API क्रेडिट खर्च होता है।

डिफ़ॉल्ट रूप से प्रति API कॉल अधिकतम अनुमत मेमोरी उपयोग 64MB है, और डिफ़ॉल्ट रूप से आप एक समय में केवल एक एग्रीगेशन चला सकते हैं। यदि आप एक साथ कई एग्रीगेशन सबमिट करते हैं, तो उन्हें कतार में रखा जाएगा और सबमिट करने के क्रम में चलाया जाएगा। लंबित एग्रीगेशन अधिकतम 60 सेकंड तक प्रतीक्षा करेंगे, उसके बाद अनुरोध टाइम आउट हो जाएगा। प्रत्येक एग्रीगेशन अधिकतम 5 मिनट तक चल सकता है।

यदि आपके पास managed tenants हैं, तो आप 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 }
}

संरचनाएँ

Aggregate अनुरोध संरचना

Copy

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

Aggregate प्रतिक्रिया संरचना

Copy

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

निम्नलिखित रिसोर्स एकत्रित किए जा सकते हैं:

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

AuditLog संरचना

एक AuditLog एक ऐसा ऑब्जेक्ट है जो उन टेनेंट्स के लिए ऑडिट की गई घटना को दर्शाता है जिनके पास इस सुविधा तक पहुँच है।

AuditLog ऑब्जेक्ट की संरचना इस प्रकार है:

AuditLog संरचना

Copy

interface AuditLog {
    id: string;
    /** घटना किसने की। **/
    userId?: string;
    username?: string;
    resourceName: string;
    crudType: 'c' | 'r' | 'u' | 'd' | 'login';
    from: string;
    url?: string;
    ip?: string;
    /** वह ब्राउज़र जिसने घटना की, जब वह किसी ब्राउज़र से आई हो। **/
    ua?: string;
    /** उस सेशन का हैश जिससे घटना आई, एक व्यक्ति की क्रियाओं को सहसंबंधित करने के लिए। कभी भी सेशन स्वयं नहीं। **/
    sIdHashed?: string;
    when: string;
    description?: string;
    serverStartDate: string;
    /** उस ऑब्जेक्ट की id जिस पर घटना की गई, इसके विपरीत कि किसने की। **/
    targetId?: string;
    /** उस ऑब्जेक्ट के लिए मानव-पठनीय लेबल, जैसे "jsmith (jsmith@example.com)"। **/
    targetLabel?: string;
    objectDetails?: object;
}

targetId और targetLabel यह बताते हैं कि घटना किस पर की गई; userId और username यह बताते हैं कि उसे किसने की। अपडेट के लिए, objectDetails.changes में वास्तव में क्या बदला, इसका एक {field: {from, to}} मैप होता है।

ऑडिट लॉग अपरिवर्तनीय (immutable) है। इसे मैन्युअल रूप से लिखा भी नहीं जा सकता। FastComments.com ही तय कर सकता है कि ऑडिट लॉग में कब लिखा जाए। हालाँकि, आप इस API के माध्यम से इसे पढ़ सकते हैं।

ऑडिट लॉग में घटनाएँ दो साल बाद समाप्त हो जाती हैं।

GET /api/v1/audit-logs

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

यह API पेजिनेशन का उपयोग करती है, जो skip, limit, before, और after पैरामीटर द्वारा प्रदान की जाती है। AuditLogs डिफ़ॉल्ट रूप से 1000 के पेजों में लौटाए जाते हैं, अधिकतम limit 10000 तक, when और id के अनुसार क्रमबद्ध। पेज बड़े होते हैं क्योंकि इस एंडपॉइंट का उपयोग आमतौर पर इतिहास को इंटरैक्टिव रूप से पेज करने के बजाय डंप करने के लिए किया जाता है।

हर 100 लॉग लौटाने पर क्रेडिट लागत 1 होती है।

डिफ़ॉल्ट रूप से, आपको सबसे नए आइटम पहले के साथ एक सूची प्राप्त होगी। इस तरह, आप skip=0 से शुरू करके पोल कर सकते हैं और आखिरी उपभोग किए गए रिकॉर्ड को खोजने तक पेजिनेट कर सकते हैं।

वैकल्पिक रूप से, आप सबसे पुराने पहले के क्रम में सॉर्ट कर सकते हैं, और जब तक कोई और रिकॉर्ड न बचे तब तक पेजिनेट कर सकते हैं।

सॉर्टिंग order को ASC या DESC में सेट करके की जा सकती है। डिफ़ॉल्ट DESC है।

तारीख के अनुसार क्वेरी before और after के माध्यम से मिलीसेकंड के साथ टाइमस्टैम्प के रूप में संभव है। before और after समावेशी (inclusive) नहीं हैं, और इनमें से कोई भी अकेले उपयोग किया जा सकता है।

किसी व्यक्ति के साथ क्या हुआ, यह खोजना

हर इवेंट रिकॉर्ड करता है कि उसे किसने किया (username, userId, ip) और, अलग से, वह किस पर किया गया। targetLabel उस ऑब्जेक्ट का एक मानव-पठनीय लेबल है, उदाहरण के लिए jsmith (jsmith@example.com), और targetId उसकी id है। जब आप किसी व्यक्ति का नाम या ईमेल जानते हों लेकिन उनकी id नहीं, तो लेबल पर केस-असंवेदनशील सबस्ट्रिंग मैच के लिए target का उपयोग करें।

डिलीट इवेंट के समय का लेबल कैप्चर करते हैं, इसलिए मूल रिकॉर्ड हट जाने के बाद भी हटाए गए उपयोगकर्ता या मॉडरेटर की पहचान की जा सकती है।

प्रबंधित टेनेंट

यदि आपका टेनेंट अन्य टेनेंट प्रबंधित करता है, तो अपने टेनेंट और उसके द्वारा प्रबंधित हर टेनेंट के इवेंट एक ही प्रतिक्रिया में प्राप्त करने के लिए includeManagedTenants=true सेट करें। प्रत्येक लौटाए गए लॉग की tenantId बताती है कि वह किस टेनेंट से आया।

AuditLog cURL उदाहरण

Copy

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

AuditLog रिक्वेस्ट संरचना

Copy

interface AuditLogsRequestQueryParams {
    tenantId: string
    API_KEY: string
    order?: 'ASC' | 'DESC'
    /** अधिकतम 10000। डिफ़ॉल्ट 1000। **/
    limit?: number
    skip?: number
    before?: number
    after?: number
    /** केवल इस username द्वारा किए गए इवेंट। **/
    username?: string
    /** केवल इस IP पते से इवेंट। **/
    ip?: string
    /** केवल इस प्रकार के इवेंट। **/
    crudType?: 'c' | 'r' | 'u' | 'd' | 'login'
    /** केवल इस रिसोर्स के इवेंट, जैसे User या Moderator। **/
    resourceName?: string
    /** केवल उन इवेंट के लिए जिनकी प्रभावित ऑब्जेक्ट की यह id है। **/
    targetId?: string
    /** प्रभावित ऑब्जेक्ट के लेबल पर केस-असंवेदनशील सबस्ट्रिंग मैच। **/
    target?: string
    /** इस टेनेंट द्वारा प्रबंधित टेनेंट के इवेंट भी लौटाएं। **/
    includeManagedTenants?: boolean
}

AuditLog रिस्पॉन्स संरचना

Copy

interface AuditLogsResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'invalid-limit' | 'invalid-skip'
    /** विफलता पर शामिल। **/
    reason?: string
    /** लॉग! **/
    auditLogs: AuditLog[]
}

BatchJob संरचना

एक BatchJob एक लंबे समय तक चलने वाला कार्य होता है, जैसे कोई import, export, या page migration। Jobs को queue में रखा जाता है, फिर background में उठाया और चलाया जाता है।

processedCount और totalCount प्रगति दिखाते हैं। इनकी इकाई type पर निर्भर करती है:

migrate-pages: पूर्ण हुई migrations, अनुरोधित migrations में से।
undo-page-migration: पुनर्स्थापित records। यहाँ कोई totalCount नहीं होता।
import, export और अन्य jobs: प्रोसेस की गई rows।

BatchJob object की संरचना इस प्रकार है:

BatchJob संरचना

Copy

interface BatchJob {
    id: string
    /** उदाहरण के लिए migrate-pages, undo-page-migration, migrate-domains, import, export, users-export या copy-comments। **/
    type: string
    status: 'requested' | 'running' | 'success' | 'failed'
    createdAt: string
    completedAt?: string
    processedCount: number
    /** कुल कार्य, जब यह पहले से ज्ञात हो। **/
    totalCount?: number
    /** migrate-pages: प्रत्येक पूर्ण हुई migration के लिए एक entry, अनुरोध के क्रम में। **/
    pageMigrationResults?: Array<PageMigrationSuccess | PageMigrationFailure>
    /**
     * migrate-pages: job पूर्ण होने पर (success या failed) एक बार सेट होता है। 90 दिनों के भीतर POST /api/v1/pages/migrations/:undoId/undo को पास करें।
     * undo-page-migration: जो migration पूर्ववत की जा रही है।
     **/
    undoId?: string
    /** undo-page-migration: job पूर्ण होने पर सेट होता है। **/
    pageMigrationUndoResult?: PageMigrationUndoResult
}
interface PageMigrationSuccess {
    from: string
    to: string
    type: 'urlId' | 'domain'
    status: 'success'
    commentsMigrated: number
}
interface PageMigrationFailure {
    from: string
    to: string
    type: 'urlId' | 'domain'
    status: 'failed'
    code: string
    reason: string
}
interface PageMigrationUndoResult {
    /** Records जिन्हें migration से पहले के मानों पर वापस रखा गया। **/
    restored: number
    /** Records जिन्हें छोड़ दिया गया क्योंकि वे migration के बाद बदल गए थे, या अब मौजूद नहीं हैं। **/
    skipped: number
    /** Records जिन्हें migration ने pages merge करते समय delete किया। इन्हें वापस लाया नहीं जा सकता। **/
    notRestorable: number
}

Retries

यदि page migration job चलाने वाला server restart हो जाता है, तो job वापस queue में चला जाता है और अंतिम पूर्ण हुई migration के बाद से फिर शुरू होता है। एक job को अधिकतम 3 बार try किया जाता है, जिसके बाद उसका status failed हो जाता है।

GET /api/v1/batch-jobs

Resource: BatchJob as GET /api/v1/batch-jobs Credit Cost: 1

यह रूट टेनेंट के सभी प्रकार के बैच जॉब लौटाता है, नवीनतम पहले, प्रति पेज 100। सूची को सीमित करने के लिए type और status का उपयोग करें, और पेजिंग के लिए skip का उपयोग करें।

BatchJob सूची cURL उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/batch-jobs?tenantId=demo&API_KEY=DEMO_API_SECRET&type=migrate-pages&status=running'

BatchJob सूची रिक्वेस्ट संरचना

Copy

interface BatchJobsQueryParams {
    tenantId: string
    API_KEY: string
    /** केवल इस प्रकार के जॉब, उदाहरण के लिए migrate-pages। **/
    type?: string
    status?: 'requested' | 'running' | 'success' | 'failed'
    /** पेजिंग के लिए कितने जॉब छोड़ने हैं। एक गैर-ऋणात्मक पूर्णांक। **/
    skip?: number
}

BatchJob सूची रिस्पॉन्स संरचना

Copy

interface BatchJobsResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'invalid-skip' | 'internal'
    /** विफलता पर शामिल। **/
    reason?: string
    /** नवीनतम पहले, अधिकतम 100। **/
    batchJobs?: BatchJob[]
}

GET /api/v1/batch-jobs/:id

Resource: BatchJob as GET /api/v1/batch-jobs/:id Credit Cost: 1

यह रूट एक बैच जॉब की स्थिति, प्रगति और, पूरा होने के बाद, उसका परिणाम लौटाता है। इसका उपयोग POST /api/v1/pages/migrations या POST /api/v1/pages/migrations/:undoId/undo द्वारा शुरू किए गए जॉब को ट्रैक करने के लिए करें।

एक जॉब तब पूरा होता है जब उसकी status success या failed हो। प्रत्येक कॉल 1 क्रेडिट की लागत रखता है, इसलिए लगातार पोल करने के बजाय कुछ सेकंड के अंतराल पर पोल करें।

BatchJob By Id cURL उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/batch-jobs/my-batch-job-id?tenantId=demo&API_KEY=DEMO_API_SECRET'

BatchJob By Id रिक्वेस्ट संरचना

Copy

interface BatchJobQueryParams {
    tenantId: string
    API_KEY: string
}

BatchJob By Id रिस्पॉन्स संरचना

Copy

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

पूर्ण हुए Page Migration जॉब का उदाहरण

Copy

{
    "status": "success",
    "batchJob": {
        "id": "my-batch-job-id",
        "type": "migrate-pages",
        "status": "success",
        "createdAt": "2026-10-19T16:00:00.000Z",
        "completedAt": "2026-10-19T16:00:12.000Z",
        "processedCount": 2,
        "totalCount": 2,
        "pageMigrationResults": [
            {"from": "old-post-id", "to": "new-post-id", "type": "urlId", "status": "success", "commentsMigrated": 42},
            {"from": "old.example.com", "to": "new.example.com", "type": "domain", "status": "success", "commentsMigrated": 1250}
        ],
        "undoId": "my-undo-id"
    }
}

Comment संरचना

एक Comment ऑब्जेक्ट किसी उपयोगकर्ता द्वारा छोड़ी गई टिप्पणी को दर्शाता है।

पैरेंट और चाइल्ड कमेंट्स के बीच संबंध parentId के माध्यम से परिभाषित होता है।

Comment ऑब्जेक्ट की संरचना इस प्रकार है:

Comment संरचना

Copy

interface Comment {
    /** READONLY: यदि स्पैम इंजन ने कमेंट को स्पैम निर्धारित किया तो true पर सेट होता है। **/
    aiDeterminedSpam?: boolean
    /** क्या कमेंट दिखाने के लिए स्वीकृत है। कमेंट सेव करते समय true पर सेट करें, अन्यथा यह छिपा रहेगा। **/
    approved?: boolean
    /** उपयोगकर्ता का अवतार। **/
    avatarSrc?: string
    /** चाइल्ड कमेंट्स। सभी परिदृश्यों में पॉपुलेटेड नहीं होते। API के माध्यम से asTree true पर सेट होने पर उपयोग होता है। **/
    children: Comment[]
    /** कमेंटर की रॉ कमेंट। **/
    comment: string
    /** READONLY: कमेंटर की कमेंट HTML में पार्स की गई। **/
    commentHTML?: string
    /** कमेंटर का ईमेल। यदि अनाम कमेंटिंग बंद है तो आवश्यक। **/
    commenterEmail?: string
    /** कमेंटर का लिंक (उदाहरण के लिए, उनका ब्लॉग)। **/
    commenterLink?: string
    /** कमेंटर का नाम। हमेशा आवश्यक। यदि उपलब्ध नहीं है, तो "Anonymous" जैसा कुछ सेट करें। **/
    commenterName: string
    /** कमेंट छोड़ी गई तिथि, UTC epoch में। **/
    date: number
    /** कमेंट के लिए "डिस्प्ले लेबल" - उदाहरण के लिए "Admin", "Moderator", या "VIP User" जैसा कुछ। **/
    displayLabel?: string
    /** वह डोमेन जहाँ कमेंट पोस्ट की गई। **/
    domain?: string
    /** READONLY: कमेंट कितनी बार फ्लैग की गई। **/
    flagCount?: number
    /** कमेंट में लिखे गए #hashtags जो सफलतापूर्वक पार्स हुए। आप क्वेरी के लिए मैन्युअल रूप से भी हैशटैग जोड़ सकते हैं, लेकिन वे कमेंट टेक्स्ट में स्वतः डिस्प्ले नहीं होंगे। **/
    hashTags?: CommentHashTag[]
    /** READONLY: क्या कमेंट में इमेज हैं? **/
    hasImages?: boolean
    /** READONLY: क्या कमेंट में लिंक हैं? **/
    hasLinks?: boolean
    /** READONLY: अद्वितीय कमेंट आईडी। **/
    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
    /** क्या कमेंट लॉक है? true होने पर, अनलॉक होने तक कोई भी (मॉडरेटर सहित) उत्तर, संपादन या डिलीट नहीं कर सकता। **/
    isLocked?: boolean
    /** क्या कमेंट स्पैम है? **/
    isSpam?: boolean
    /** READONLY: क्या वर्तमान उपयोगकर्ता (contextUserId) के लिए कमेंट डाउनवोट की गई है? **/
    isVotedDown?: boolean
    /** READONLY: क्या वर्तमान उपयोगकर्ता (contextUserId) के लिए कमेंट अपवोट की गई है? **/
    isVotedUp?: boolean
    /** कमेंट की लोकेल। यदि प्रदान नहीं की गई, तो language accept 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 जो सफलतापूर्वक पार्स हुए। **/
    mentions?: CommentUserMention[]
    /** कमेंट से जुड़ा वैकल्पिक मेटाडेटा। **/
    meta?: Record<string, string | number | boolean>
    /** इस कमेंट से जुड़े मॉडरेशन ग्रुप आईडी की वैकल्पिक सूची। **/
    moderationGroupIds?: string[]|null
    /** READONLY: इस कमेंट पर वर्तमान उपयोगकर्ता (contextUserId) के वोट से संबंधित वोट ऑब्जेक्ट की आईडी। **/
    myVoteId?: string
    /** क्या इस कमेंट के लिए कमेंटर्स को सूचनाएं भेजी गईं। इंपोर्ट पर सूचनाएं भेजने से रोकने के लिए, इसे true पर सेट करें। **/
    notificationSentForParent?: boolean
    /** क्या इस कमेंट के लिए टेनेंट उपयोगकर्ताओं को सूचनाएं भेजी गईं। इंपोर्ट पर सूचनाएं भेजने से रोकने के लिए, इसे true पर सेट करें। **/
    notificationSentForParentTenant?: boolean
    /** वह पेज शीर्षक जिस पर यह कमेंट थी। **/
    pageTitle?: string
    /** यदि हम किसी कमेंट का उत्तर दे रहे हैं, तो यह उस आईडी है जिसका उत्तर दिया जा रहा है। **/
    parentId?: string|null
    /** क्या कमेंट समीक्षित (reviewed) चिह्नित है। **/
    reviewed: boolean
    /** वह टेनेंट आईडी जिससे कमेंट संबंधित है। **/
    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 के मार्कडाउन फ्लेवर में लिखी जाती हैं, जो मार्कडाउन के साथ इमेज के लिए पारंपरिक bbcode शैली के टैग जैसे [img]path[/img] हैं।

टेक्स्ट दो फ़ील्ड में संग्रहीत होता है। उपयोगकर्ता द्वारा दर्ज किया गया टेक्स्ट बिना बदले comment फ़ील्ड में संग्रहीत होता है। यह रेंडर होकर commentHTML फ़ील्ड में संग्रहीत होता है।

अनुमत HTML टैग हैं: b, u, i, strike, pre, span, code, img, a, strong, ul, ol, li, और br।

HTML रेंडर करने की सिफारिश की जाती है, क्योंकि यह HTML का बहुत छोटा सबसेट है, रेंडरर बनाना काफी सरल है। उदाहरण के लिए, React Native और Flutter के लिए इसमें मदद के लिए कई लाइब्रेरीज़ उपलब्ध हैं।

आप comment फ़ील्ड का अन-नॉर्मलाइज़्ड मान रेंडर करना चुन सकते हैं। एक उदाहरण पार्सर यहाँ है।।

उदाहरण पार्सर को HTML के साथ काम करने के लिए भी समायोजित किया जा सकता है, और HTML टैग को आपके प्लेटफ़ॉर्म के लिए रेंडर करने योग्य अपेक्षित तत्वों में बदला जा सकता है।

टैगिंग

जब कमेंट में उपयोगकर्ताओं को टैग किया जाता है, तो जानकारी mentions नामक सूची में संग्रहीत होती है। उस सूची में प्रत्येक ऑब्जेक्ट की संरचना निम्नलिखित है।

Comment Mentions ऑब्जेक्ट

Copy

Run

interface CommentUserMention {
    /** उपयोगकर्ता आईडी। SSO उपयोगकर्ताओं के लिए, इसमें आपकी टेनेंट आईडी प्रीफ़िक्स्ड होगी। **/
    id: string
    /** अंतिम @mention टैग टेक्स्ट, @ प्रतीक सहित। **/
    tag: string
    /** मूल @mention टैग टेक्स्ट, @ प्रतीक सहित। **/
    rawTag: string
    /** किस प्रकार के उपयोगकर्ता को टैग किया गया। user = FastComments.com खाता। sso = SSOUser। **/
    type: 'user'|'sso'
    /** यदि उपयोगकर्ता सूचनाओं से ऑप्ट आउट करता है, तो भी यह true पर सेट रहेगा। **/
    sent: boolean
}

हैशटैग

जब हैशटैग का उपयोग किया जाता है और सफलतापूर्वक पार्स किया जाता है, तो जानकारी hashTags नामक सूची में संग्रहीत होती है। उस सूची में प्रत्येक ऑब्जेक्ट की संरचना निम्नलिखित है। यदि retain सेट है, तो क्वेरी के लिए हैशटैग को मैन्युअल रूप से कमेंट के hashTags ऐरे में भी जोड़ा जा सकता है।

Comment HashTag ऑब्जेक्ट

Copy

Run

interface CommentHashTag {
    /** हैशटैग आईडी। **/
    id: string
    /** अंतिम #hashtag टैग टेक्स्ट, # प्रतीक सहित। **/
    tag: string
    /** यदि हैशटैग कस्टम URL से जुड़ा है, तो यह परिभाषित होगा। **/
    url?: string
    /** यदि कमेंट अपडेट होने पर हैशटैग को बनाए रखना चाहिए, भले ही वह कमेंट टेक्स्ट में मौजूद न हो। कमेंट टेक्स्ट बदले बिना कमेंट्स को टैग करने के लिए उपयोगी। **/
    retain?: boolean
}

GET /api/v1/comments

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

यह API उपयोगकर्ता को दिखाने के लिए कमेंट्स प्राप्त करने के लिए उपयोग की जाती है। उदाहरण के लिए, यह स्वचालित रूप से अस्वीकृत या स्पैम कमेंट्स को फ़िल्टर कर देती है।

पेजिनेशन

पेजिनेशन दो तरीकों में से किसी एक से किया जा सकता है, जो परफ़ॉर्मेंस आवश्यकताओं और उपयोग के मामले पर निर्भर करता है:

सबसे तेज़: Precalculated Pagination:
1. जब आप हमारे प्रीबिल्ट विजेट्स और क्लाइंट्स का उपयोग करते हैं, तो FastComments इसी तरह काम करता है।
2. "next" पर क्लिक करना केवल पेज काउंट बढ़ाता है।
3. आप इसे key-value स्टोर से प्राप्त किए गए डेटा की तरह सोच सकते हैं।
4. इस तरह, बस 0 से शुरू होने वाला एक page पैरामीटर और direction के रूप में सॉर्ट दिशा परिभाषित करें।
5. पेज साइज़ कस्टमाइज़ेशन नियमों के माध्यम से अनुकूलित किया जा सकता है।
सबसे लचीला: Flexible Pagination:
1. इस तरह आप कस्टम limit और skip पैरामीटर परिभाषित कर सकते हैं। page पास न करें।
2. सॉर्ट direction भी समर्थित है।
3. limit, skip लागू होने के बाद लौटाने की कुल संख्या है।
  - उदाहरण: page size = 100 और page = 2 होने पर skip = 200, limit = 100 सेट करें।
4. चाइल्ड कमेंट्स भी पेजिनेशन में गिने जाते हैं। आप asTree विकल्प का उपयोग करके इससे बच सकते हैं।
  - आप limitChildren और skipChildren के माध्यम से चाइल्ड कमेंट्स को पेजिनेट कर सकते हैं।
  - आप maxTreeDepth के माध्यम से लौटाए गए थ्रेड्स की गहराई सीमित कर सकते हैं।

थ्रेड्स

Precalculated Pagination का उपयोग करते समय, कमेंट्स page के अनुसार समूहित होते हैं और थ्रेड्स में कमेंट्स समग्र पेज को प्रभावित करते हैं।
1. इस तरह, थ्रेड्स को क्लाइंट पर parentId के आधार पर निर्धारित किया जा सकता है।
2. उदाहरण के लिए, एक टॉप-लेवल कमेंट और 29 रिप्लाई वाले पेज के लिए, और API में page=0 सेट करने पर - आपको केवल टॉप-लेवल कमेंट और 29 चाइल्ड मिलेंगे।
Flexible Pagination का उपयोग करते समय, आप एक parentId पैरामीटर परिभाषित कर सकते हैं।
1. केवल टॉप-लेवल कमेंट्स प्राप्त करने के लिए इसे null सेट करें।
2. फिर थ्रेड्स देखने के लिए, API को फिर से कॉल करें और parentId पास करें।
3. एक सामान्य समाधान यह है कि टॉप-लेवल कमेंट्स के लिए एक API कॉल करें और फिर प्रत्येक कमेंट के चाइल्ड के लिए समानांतर API कॉल करें।
नया - फ़रवरी 2023 से! &asTree=true का उपयोग करके ट्री के रूप में प्राप्त करें।
1. आप इसे Flexible Pagination as a Tree की तरह सोच सकते हैं।
2. पेजिनेशन में केवल टॉप-लेवल कमेंट्स गिने जाते हैं।
3. ट्री को रूट से शुरू करने के लिए parentId=null सेट करें (आपको parentId सेट करना अनिवार्य है)।
4. पेजिनेशन के लिए skip और limit सेट करें।
5. asTree को true सेट करें।
6. क्रेडिट्स लागत 2x बढ़ जाती है, क्योंकि इस परिदृश्य में हमारे बैकएंड को बहुत अधिक काम करना पड़ता है।
7. maxTreeDepth, limitChildren, और skipChildren को आवश्यकतानुसार सेट करें।

ट्रीज़ की व्याख्या

asTree का उपयोग करते समय, पेजिनेशन को समझना कठिन हो सकता है। यहाँ एक उपयोगी ग्राफ़िक है:

Tree Pagination Diagram

उपयोगकर्ता के संदर्भ में कमेंट्स प्राप्त करना

/comments API को दो संदर्भों में, विभिन्न उपयोग के मामलों के लिए उपयोग किया जा सकता है:

अपना स्वयं का क्लाइंट बनाने के लिए जानकारी के साथ सॉर्ट और टैग किए गए कमेंट्स लौटाने के लिए।
- इस मामले में, एक contextUserId क्वेरी पैरामीटर परिभाषित करें।
कस्टम इंटीग्रेशन के लिए अपने बैकएंड से कमेंट्स प्राप्त करने के लिए।
- contextUserId के बिना प्लेटफ़ॉर्म डिफ़ॉल्ट रूप से इसी का उपयोग करेगा।

कमेंट्स Precalculated Pagination

Copy

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

कमेंट्स Flexible Pagination

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'

उपयोगकर्ता संदर्भ में कमेंट्स Flexible Pagination

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'

केवल टॉप-लेवल कमेंट्स के लिए उपयोगकर्ता संदर्भ में कमेंट्स Flexible Pagination

Copy

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

कमेंट्स को ट्री के रूप में प्राप्त करें

कमेंट्स को ट्री के रूप में प्राप्त करना संभव है, जिसमें पेजिनेशन केवल टॉप-लेवल कमेंट्स को गिनता है।

उपयोगकर्ता संदर्भ में ट्री के रूप में कमेंट्स

Copy

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

केवल टॉप-लेवल कमेंट्स और तुरंत चाइल्ड प्राप्त करना चाहते हैं? यहाँ एक तरीका है:

अधिकतम गहराई के साथ ट्री के रूप में कमेंट्स

Copy

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

हालाँकि, अपने UI में आपको यह जानने की आवश्यकता हो सकती है कि प्रत्येक कमेंट पर "show replies" बटन दिखाना है या नहीं। ट्री के माध्यम से कमेंट्स प्राप्त करते समय, जब लागू हो, तो कमेंट्स पर एक hasChildren प्रॉपर्टी टैग की जाती है।

ट्री के रूप में कमेंट्स प्राप्त करें, हैश टैग द्वारा खोज

API का उपयोग करके हैशटैग द्वारा खोज करना संभव है, आपके पूरे टेनेंट में (एक पेज या urlId तक सीमित नहीं)।

इस उदाहरण में, हम urlId को छोड़ देते हैं, और कई हैशटैग द्वारा खोज करते हैं। API केवल वही कमेंट्स लौटाएगा जिनमें सभी अनुरोधित हैशटैग मौजूद हैं।

उपयोगकर्ता संदर्भ में हैश टैग द्वारा ट्री के रूप में कमेंट्स

Copy

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

सभी रिक्वेस्ट पैरामीटर्स

कमेंट्स रिक्वेस्ट संरचना

Copy

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

रिस्पॉन्स

कमेंट्स रिस्पॉन्स संरचना

Copy

interface CommentsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-date' | 'unauthorized-page' | 'invalid-pagination-request' | 'invalid-limit' | 'invalid-limit-children' | 'invalid-skip' | 'invalid-skip-children' | 'invalid-max-tree-depth'
    /** Included on failure. **/
    reason?: string
    /** The comments! **/
    comments: Comment[]
}

उपयोगी टिप्स

URL ID

संभवतः आप Comment API का उपयोग urlId पैरामीटर के साथ करना चाहेंगे। आप पहले Pages API को कॉल कर सकते हैं, यह देखने के लिए कि आपके लिए उपलब्ध urlId मान कैसे दिखते हैं।

अनाम (Anonymous) क्रियाएँ

अनाम कमेंटिंग के लिए संभवतः आप कमेंट्स प्राप्त करते समय, और फ्लैगिंग तथा ब्लॉकिंग करते समय anonUserId पास करना चाहेंगे।

(!) यह कई ऐप स्टोर्स के लिए आवश्यक है क्योंकि उपयोगकर्ताओं को उपयोगकर्ता-निर्मित कंटेंट को फ्लैग करने में सक्षम होना चाहिए जिसे वे देख सकते हैं, भले ही वे लॉग इन न हों। ऐसा न करने पर आपका ऐप उस स्टोर से हटाया जा सकता है।

कमेंट्स लौटाए नहीं जा रहे हैं

जाँचें कि आपके कमेंट्स अप्रूव किए गए हैं, और स्पैम नहीं हैं।

GET /api/v1/comments/:id

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

यह API id द्वारा एकल कमेंट प्राप्त करने की क्षमता प्रदान करती है।

Comments Get-By-Id cURL उदाहरण

Copy

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

Comment Get-By-Id रिक्वेस्ट संरचना

Copy

interface CommentsGetByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Comments Get-By-Id रिस्पॉन्स संरचना

Copy

interface CommentGetByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'missing-id'
    /** विफलता पर शामिल। **/
    reason?: string
    /** कमेंट! **/
    comment?: Comment
}

POST /api/v1/comments

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

यह API एंडपॉइंट कमेंट बनाने की क्षमता प्रदान करता है।

सामान्य उपयोग के मामले कस्टम UI, इंटीग्रेशन, या इंपोर्ट हैं।

नोट्स:

यह API चाहें तो कमेंट विजेट को "live" अपडेट कर सकता है (इससे creditsCost 1 से 2 हो जाता है)।
यह API ईमेल दिए जाने पर स्वतः हमारे सिस्टम में यूज़र ऑब्जेक्ट बना देगा।
अलग-अलग ईमेल के साथ लेकिन एक ही यूज़रनेम वाले दो कमेंट सेव करने की कोशिश पर दूसरे कमेंट के लिए एरर आएगा।
यदि आप parentId निर्दिष्ट कर रहे हैं, और चाइल्ड कमेंट का notificationSentForParent false है, तो हम पैरेंट कमेंट के लिए नोटिफिकेशन भेजेंगे। यह हर घंटे किया जाता है (हम भेजे जाने वाले ईमेल की संख्या कम करने के लिए नोटिफिकेशन को बैच में भेजते हैं)।
यदि आप यूज़र बनाते समय वेलकम ईमेल, या कमेंट वेरिफिकेशन ईमेल भेजना चाहते हैं, तो क्वेरी पैरामीटर में sendEmails को true सेट करें।
इस API के माध्यम से बनाए गए कमेंट एडमिन ऐप के Analytics और Moderation पेजों में दिखाई देंगे।
यदि सेटिंग चालू है, तो "bad words" कमेंटर के नाम और कमेंट टेक्स्ट में अभी भी मास्क रहते हैं।
इस API के माध्यम से बनाए गए कमेंट को चाहें तो स्पैम के लिए जांचा जा सकता है।
अधिकतम कमेंट लंबाई जैसी कॉन्फ़िगरेशन, यदि Customization Rule एडमिन पेज के माध्यम से कॉन्फ़िगर की गई है, तो यहाँ लागू होगी।

सबमिट करने के लिए न्यूनतम डेटा जो कमेंट विजेट में दिखाई देगा, वह इस प्रकार है:

न्यूनतम कमेंट POST cURL उदाहरण

Copy

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

एक अधिक वास्तविक रिक्वेस्ट इस तरह दिख सकती है:

कमेंट POST cURL उदाहरण

Copy

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

कमेंट POST रिक्वेस्ट संरचना

Copy

interface CommentPostQueryParams {
    tenantId: string
    API_KEY: string
    doSpamCheck?: 'true' | 'false'
	/** Whether the comment should appear "live" to users viewing instances of the comment widget with the same urlId. NOTE: Doubles credit cost from 1 to 2. **/
    isLive?: 'true' | 'false'
    sendEmails?: 'true' | 'false'
    populateNotifications?: 'true' | 'false'
}

कमेंट POST रिस्पॉन्स संरचना

Copy

interface CommentPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-comment' | 'comment-too-big' | 'hash-tags-readonly' | 'mentions-readonly' | 'invalid-user' | 'unauthorized' | 'invalid-date' | 'invalid-name' | 'invalid-name-is-email' | 'banned' | 'invalid-email';
    /** Included on failure. **/
    reason?: string
    /** The created comment. **/
    comment?: Comment
    /** The associated user, which may or may not have already existed. **/
    user?: User
}

PATCH /api/v1/comments/:id

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

यह API एंडपॉइंट एक सिंगल कमेंट को अपडेट करने की क्षमता प्रदान करता है।

नोट्स:

यह API चाहें तो कमेंट विजेट को "live" अपडेट कर सकता है (इससे बेस creditsCost 1 से बढ़कर 2 हो जाता है)।
- इससे पेजों के बीच कमेंट्स को "live" माइग्रेट किया जा सकता है (urlId बदलकर)।
- माइग्रेशन पर अतिरिक्त 2 क्रेडिट खर्च होते हैं क्योंकि पेज प्री-कैलकुलेट किए जाते हैं और यह CPU-इंटेंसिव है।
क्रिएट API के विपरीत, यह API ईमेल दिए जाने पर भी हमारे सिस्टम में ऑटोमैटिकली यूज़र ऑब्जेक्ट नहीं बनाएगा।
इस API के माध्यम से अपडेट किए गए कमेंट्स की चाहें तो स्पैम जांच भी की जा सकती है।
अधिकतम कमेंट लंबाई जैसी कॉन्फ़िगरेशन, यदि Customization Rule एडमिन पेज के माध्यम से कॉन्फ़िगर की गई है, तो यहाँ भी लागू होगी।
यूज़र्स को उनके कमेंट टेक्स्ट को अपडेट करने की अनुमति देने के लिए, आप बस रिक्वेस्ट बॉडी में comment स्पेसिफाई कर सकते हैं। हम परिणामी commentHTML जनरेट करेंगे।
- यदि आप comment और commentHTML दोनों डिफाइन करते हैं तो हम HTML ऑटोमैटिकली जनरेट नहीं करेंगे।
- यदि यूज़र अपने नए टेक्स्ट में मेंशन्स या हैशटैग जोड़ता है, तो उन्हें अभी भी POST API की तरह प्रोसेस किया जाएगा।
किसी कमेंट पर commenterEmail अपडेट करते समय, userId भी स्पेसिफाई करना सबसे अच्छा है। अन्यथा, आपको यह सुनिश्चित करना होगा कि इस ईमेल वाला यूज़र आपके टेनेंट से संबंधित है, नहीं तो रिक्वेस्ट विफल हो जाएगी।
यदि टारगेट कमेंट लॉक है (isLocked: true), तो रिक्वेस्ट code: 'locked' के साथ रिजेक्ट कर दी जाती है। पहले कमेंट को अनलॉक करें, उसे अपडेट करें, फिर चाहें तो दोबारा लॉक करें।

न्यूनतम कमेंट PATCH cURL उदाहरण

Copy

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

कमेंट PATCH रिक्वेस्ट संरचना

Copy

interface CommentPatchQueryParams {
    tenantId: string
    API_KEY: string
	/** अपडेट करने वाला यूज़र। चाहें तो इसका उपयोग यह जांचने के लिए किया जा सकता है कि वे कमेंट एडिट कर सकते हैं।  **/
    contextUserId?: string
	/** क्या हमें जांचना चाहिए कि नया कमेंट स्पैम जैसा दिखता है?  **/
    doSpamCheck?: 'true' | 'false'
	/** क्या कमेंट उसी urlId वाले कमेंट विजेट के इंस्टेंस देख रहे यूज़र्स को "live" दिखना चाहिए। NOTE: क्रेडिट लागत 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' | 'locked'
    /** विफलता पर शामिल। **/
    reason?: string
}

DELETE /api/v1/comments/:id

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

यह API एंडपॉइंट एक कमेंट को डिलीट करने की सुविधा प्रदान करता है।

नोट्स:

यह API चाहें तो कमेंट विजेट को "live" अपडेट कर सकता है (इससे creditsCost 1 से बढ़कर 2 हो जाता है)।
यह API सभी चाइल्ड कमेंट्स को डिलीट कर देगा।
यदि टारगेट कमेंट लॉक है (isLocked: true), तो रिक्वेस्ट code: 'locked' के साथ अस्वीकार कर दी जाती है। पहले कमेंट को अनलॉक करें, फिर डिलीट करें।

Comment DELETE 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'

Comment DELETE रिक्वेस्ट स्ट्रक्चर

Copy

interface CommentDeleteQueryParams {
    tenantId: string
    API_KEY: string
	/** अपडेट करने वाला यूज़र। चाहें तो इसका उपयोग यह जांचने के लिए किया जा सकता है कि वे कमेंट डिलीट कर सकते हैं।  **/
    contextUserId?: string
	/** क्या कमेंट को उसी urlId वाले कमेंट विजेट के इंस्टेंस देख रहे यूज़र्स के लिए "live" डिलीट किया जाना चाहिए। नोट: क्रेडिट लागत 1 से बढ़कर 2 हो जाती है। **/
    isLive?: 'true' | 'false'
}

Comment DELETE रिस्पॉन्स स्ट्रक्चर

Copy

interface CommentDeleteResponse {
    status: 'success' | 'failed'
    /** फेल होने पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'locked'
    /** फेल होने पर शामिल। **/
    reason?: string
}

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

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

यह API एंडपॉइंट किसी विशिष्ट उपयोगकर्ता के लिए एक टिप्पणी को फ्लैग करने की क्षमता प्रदान करता है।

नोट्स:

यह कॉल हमेशा एक उपयोगकर्ता के संदर्भ में किया जाना चाहिए। उपयोगकर्ता FastComments.com User, SSO User, या Tenant User हो सकता है।
यदि एक flag-to-hide थ्रेशोल्ड सेट किया गया है, तो टिप्पणी को परिभाषित संख्या में फ्लैग किए जाने के बाद लाइव स्वचालित रूप से छिपा दिया जाएगा।
स्वचालित रूप से अन-अप्रूव (छिपाए) जाने के बाद - टिप्पणी को केवल व्यवस्थापक या मॉडरेटर द्वारा ही फिर से अप्रूव किया जा सकता है। अन-फ्लैग करने से टिप्पणी फिर से अप्रूव नहीं होगी।

कमेंट फ्लैग cURL उदाहरण

Copy

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

गुमनाम फ्लैगिंग के लिए, हमें एक anonUserId निर्दिष्ट करना होगा। यह गुमनाम सत्र का प्रतिनिधित्व करने वाली एक ID हो सकती है, या एक यादृच्छिक UUID। यह हमें तब भी टिप्पणियों को फ्लैग और अन-फ्लैग करने की सुविधा देता है जब उपयोगकर्ता लॉग इन न हो। इस तरह, जब उसी anonUserId के साथ टिप्पणियाँ फ़ेच की जाती हैं, तो टिप्पणी को फ्लैग किया गया चिह्नित किया जा सकता है।

गुमनाम कमेंट फ्लैग cURL उदाहरण

Copy

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

कमेंट फ्लैग रिक्वेस्ट संरचना

Copy

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

कमेंट फ्लैग रिस्पॉन्स संरचना

Copy

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

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

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

यह API एंडपॉइंट किसी विशिष्ट उपयोगकर्ता के लिए एक कमेंट को अन-फ्लैग (un-flag) करने की सुविधा प्रदान करता है।

नोट्स:

यह कॉल हमेशा एक उपयोगकर्ता के संदर्भ में किया जाना चाहिए। उपयोगकर्ता एक FastComments.com User, SSO User, या Tenant User हो सकता है।
जब कोई कमेंट स्वचालित रूप से अन-अप्रूव (छिपा हुआ) हो जाता है - तो उस कमेंट को केवल एडमिनिस्ट्रेटर या मॉडरेटर द्वारा ही दोबारा अप्रूव किया जा सकता है। अन-फ्लैग करने से कमेंट दोबारा अप्रूव नहीं होगा।

कमेंट अन-फ्लैग cURL उदाहरण

Copy

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

गुमनाम (anonymous) फ्लैगिंग के लिए, हमें एक anonUserId निर्दिष्ट करना होगा। यह गुमनाम सत्र (anonymous session) का प्रतिनिधित्व करने वाली एक ID हो सकती है, या एक रैंडम UUID।

गुमनाम कमेंट फ्लैग cURL उदाहरण

Copy

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

कमेंट अन-फ्लैग रिक्वेस्ट संरचना

Copy

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

कमेंट अन-फ्लैग रिस्पॉन्स संरचना

Copy

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

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

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

यह API एंडपॉइंट किसी दिए गए कमेंट को लिखने वाले यूज़र को ब्लॉक करने की सुविधा प्रदान करता है। यह FastComments.com Users, SSO Users, और Tenant Users द्वारा लिखे गए कमेंट्स से ब्लॉकिंग को सपोर्ट करता है।

यह एक commentIdsToCheck बॉडी पैरामीटर को सपोर्ट करता है, जिससे यह जांचा जा सके कि इस एक्शन के बाद क्लाइंट पर मौजूद कोई अन्य संभावित रूप से दिखाई देने वाले कमेंट्स को ब्लॉक/अनब्लॉक किया जाना चाहिए या नहीं।

नोट्स:

यह कॉल हमेशा किसी यूज़र के संदर्भ (context) में की जानी चाहिए। यूज़र FastComments.com User, SSO User, या Tenant User हो सकता है।
रिक्वेस्ट में userId वह यूज़र है जो ब्लॉक कर रहा है। उदाहरण के लिए: User A, User B को ब्लॉक करना चाहता है। तो userId=User A और User B द्वारा लिखे गए कमेंट की id पास करें।
पूरी तरह से अनाम (anonymous) कमेंट्स (कोई user id नहीं, कोई email नहीं) को ब्लॉक नहीं किया जा सकता और एक एरर रिटर्न किया जाएगा।

Comment Block 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'

अनाम (anonymous) ब्लॉकिंग के लिए, हमें एक anonUserId निर्दिष्ट करना होगा। यह अनाम सेशन को दर्शाने वाली एक ID हो सकती है, या एक रैंडम UUID। इससे हम उन कमेंट्स को ब्लॉक करने की सुविधा दे पाते हैं जिन्हें उसी anonUserId से फ़ेच करके तब भी ब्लॉक किया जा सके जब यूज़र लॉग इन न हो।

Anonymous Comment Block 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'

Comment Block रिक्वेस्ट संरचना

Copy

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

Comment Block रिस्पॉन्स संरचना

Copy

interface CommentBlockResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'
    /** Included on failure. **/
    reason?: string
    /** If commentIdsToCheck is defined, entries in this map with true are also blocked. **/
    commentStatuses?: Record<string, boolean>;
}

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

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

यह API एंडपॉइंट किसी दिए गए कमेंट को लिखने वाले यूज़र को अन-ब्लॉक करने की सुविधा प्रदान करता है। यह FastComments.com Users, SSO Users, और Tenant Users द्वारा लिखे गए कमेंट्स से अन-ब्लॉकिंग को सपोर्ट करता है।

यह एक commentIdsToCheck बॉडी पैरामीटर को सपोर्ट करता है, ताकि यह जांचा जा सके कि इस क्रिया के बाद क्लाइंट पर कोई अन्य संभावित रूप से दिखाई देने वाले कमेंट्स को ब्लॉक/अन-ब्लॉक करना चाहिए या नहीं।

नोट्स:

यह कॉल हमेशा किसी यूज़र के संदर्भ में की जानी चाहिए। यह यूज़र FastComments.com User, SSO User, या Tenant User हो सकता है।
रिक्वेस्ट में userId वह यूज़र है जो अन-ब्लॉकिंग कर रहा है। उदाहरण के लिए: User A, User B को अन-ब्लॉक करना चाहता है। userId=User A पास करें और वह कमेंट आईडी दें जो User B ने लिखा था।
पूरी तरह अनाम कमेंट्स (कोई यूज़र आईडी नहीं, कोई ईमेल नहीं) को ब्लॉक नहीं किया जा सकता और एक एरर रिटर्न किया जाएगा।

Comment Un-Block cURL उदाहरण

Copy

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

Anonymous Comment Un-Block cURL उदाहरण

Copy

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

Comment Un-Block रिक्वेस्ट स्ट्रक्चर

Copy

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

Comment Un-Block रिस्पॉन्स स्ट्रक्चर

Copy

interface CommentUnBlockResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'
    /** Included on failure. **/
    reason?: string
    /** If commentIdsToCheck is defined, entries in this map with true are still blocked. If false, you might want to un-hide the comments from the user so they don't have to refresh. **/
    commentStatuses?: Record<string, boolean>;
}

ईमेल टेम्पलेट संरचना

एक EmailTemplate ऑब्जेक्ट किसी tenant के लिए कस्टम ईमेल टेम्पलेट की कॉन्फ़िगरेशन को दर्शाता है।

सिस्टम उपयोग करने के लिए ईमेल टेम्पलेट का चयन इस प्रकार करेगा:

इसके type identifier द्वारा, जिसे हम emailTemplateId कहते हैं। ये constants होते हैं।
domain द्वारा। हम पहले संबंधित ऑब्जेक्ट (जैसे Comment) से जुड़े domain के लिए टेम्पलेट खोजने का प्रयास करेंगे, और यदि कोई मैच नहीं मिलता है तो हम ऐसा टेम्पलेट खोजने का प्रयास करेंगे जिसमें domain null या * हो।

EmailTemplate ऑब्जेक्ट की संरचना इस प्रकार है:

ईमेल टेम्पलेट संरचना

Copy

interface EmailTemplate {
    id: string
    tenantId: string
    emailTemplateId: string
    displayName: string
    /** READONLY **/
    createdAt: string
    /** READONLY **/
    updatedAt: string
    /** READONLY **/
    updatedByUserId: string
    /** वह domain जिससे टेम्पलेट संबद्ध होना चाहिए। **/
    domain?: string | '*' | null
    /** EJS सिंटैक्स में ईमेल टेम्पलेट की सामग्री। **/
    ejs: string
    /** प्रत्येक समर्थित locale के लिए, ओवरराइड की गई अनुवाद keys से values तक का मैप। **/
    translationOverridesByLocale: Record<string, Record<string, string>>
    /** एक ऑब्जेक्ट जो टेम्पलेट के render context को दर्शाता है। **/
    testData: object
}

नोट्स

आप मान्य emailTemplateId values /definitions endpoint से प्राप्त कर सकते हैं।
/definitions endpoint में डिफ़ॉल्ट अनुवाद और test data भी शामिल हैं।
अमान्य संरचना या test data के साथ टेम्पलेट सहेजने में विफल हो जाएंगे।

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

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

अलग-अलग EmailTemplates को उनके संबंधित id (emailTemplateId नहीं) से प्राप्त किया जा सकता है।

ID द्वारा EmailTemplate cURL उदाहरण

Copy

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

ID द्वारा EmailTemplate रिक्वेस्ट संरचना

Copy

interface EmailTemplatesByIdRequestQueryParams {
    tenantId: string
    API_KEY: string
}

ID द्वारा EmailTemplate रिस्पॉन्स संरचना

Copy

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

GET /api/v1/email-templates

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

यह API पेजिनेशन का उपयोग करता है, जो page क्वेरी पैरामीटर द्वारा प्रदान की जाती है। EmailTemplates 100 के पेजों में लौटाए जाते हैं, createdAt और फिर id के अनुसार क्रमबद्ध।

EmailTemplate cURL उदाहरण

Copy

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

EmailTemplate रिक्वेस्ट संरचना

Copy

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

EmailTemplate रिस्पॉन्स संरचना

Copy

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

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

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

यह API एंडपॉइंट केवल id और अपडेट करने के लिए विशेषताओं (attributes) को निर्दिष्ट करके ईमेल टेम्पलेट अपडेट करने की क्षमता प्रदान करता है।

ध्यान दें कि टेम्पलेट बनाने के लिए सभी समान सत्यापन (validations) यहाँ भी लागू होते हैं, उदाहरण के लिए:

टेम्पलेट रेंडर होना चाहिए। यह प्रत्येक अपडेट के साथ जाँचा जाता है।
एक ही डोमेन के लिए डुप्लिकेट टेम्पलेट नहीं हो सकते (अन्यथा एक को चुपचाप अनदेखा कर दिया जाएगा)।

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 के माध्यम से उपलब्ध होगा)।

टेम्पलेट जोड़ने के लिए आवश्यक न्यूनतम डेटा इस प्रकार है:

न्यूनतम EmailTemplate POST cURL उदाहरण

Copy

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

आप प्रति-साइट टेम्पलेट रखना चाह सकते हैं, जिस स्थिति में आप domain परिभाषित करते हैं:

EmailTemplate POST cURL उदाहरण

Copy

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

EmailTemplate POST अनुरोध संरचना

Copy

interface EmailTemplatePostQueryParams {
    tenantId: string
    API_KEY: string
}

EmailTemplate POST प्रतिक्रिया संरचना

Copy

interface EmailTemplatePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'invalid-email-template-id' | 'domain-invalid' | 'duplicate' | 'does-not-render';
    /** Included on failure. **/
    reason?: string
    /** The created template. **/
    emailTemplate?: EmailTemplate
}

POST /api/v1/email-templates/render

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

यह API एंडपॉइंट ईमेल टेम्पलेट्स का प्रीव्यू देखने की सुविधा प्रदान करता है।

न्यूनतम EmailTemplate प्रीव्यू POST cURL उदाहरण

Copy

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

EmailTemplate POST अनुरोध संरचना

Copy

interface EmailTemplatePostQueryParams {
    tenantId: string
    API_KEY: string
}

EmailTemplate POST प्रतिक्रिया संरचना

Copy

interface EmailTemplatePostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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

यह रूट id द्वारा एकल EmailTemplate को हटाने की सुविधा प्रदान करता है।

EmailTemplate हटाने का cURL उदाहरण

Copy

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

EmailTemplate हटाने के अनुरोध की संरचना

Copy

interface EmailTemplateRequestQueryParams {
    tenantId: string
    API_KEY: string
}

EmailTemplate हटाने की प्रतिक्रिया की संरचना

Copy

interface EmailTemplateDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'
    /** विफलता पर शामिल। **/
    reason?: string
}

FeedPost संरचना

एक FeedPost ऑब्जेक्ट FastComments फ़ीड में एक पोस्ट को दर्शाता है। फ़ीड एक पोस्ट स्ट्रीम होती है जिसमें प्रत्येक पोस्ट की अपनी कमेंट थ्रेड होती है, और इसे Feed विजेट द्वारा रेंडर किया जाता है। हर पोस्ट का एक लेखक, वैकल्पिक रिच कंटेंट, मीडिया और लिंक होते हैं, और इसे टैग किया जा सकता है ताकि फ़ीड को फ़िल्टर किया जा सके।

FeedPost ऑब्जेक्ट की संरचना इस प्रकार है:

FeedPost संरचना

Copy

interface FeedPost {
    /** READONLY **/
    _id: string
    /** READONLY **/
    tenantId: string
    title?: string
    /** पोस्ट के लेखक FastComments या SSO उपयोगकर्ता की id। **/
    fromUserId?: string
    /** सेट न होने पर उपयोगकर्ता से भरा जाता है। **/
    fromUserDisplayName?: string | null
    /** READONLY. उपयोगकर्ता से भरा जाता है। **/
    fromUserAvatar?: string | null
    /** फ़ीड को फ़िल्टर करने के लिए उपयोग किया जाता है। **/
    tags?: string[]
    /** फ़ीड के भीतर सॉर्ट वेट। उच्च मान पहले सॉर्ट होते हैं। **/
    weight?: number
    /** आपके अपने उपयोग के लिए फ्री-फॉर्म key/value जोड़े। **/
    meta?: Record<string, string>
    /** सैनिटाइज़ किया गया HTML। **/
    contentHTML?: string
    media?: FeedPostMediaItem[]
    links?: FeedPostLink[]
    /** READONLY **/
    createdAt: string
    /** READONLY. रिएक्शन प्रकार से गिनती। **/
    reacts?: Record<string, number>
    /** READONLY **/
    commentCount?: number | null
}
interface FeedPostMediaItem {
    title?: string
    /** क्लिक करने पर मीडिया आइटम कहाँ लिंक होता है। **/
    linkUrl?: string
    /** प्रत्येक रेंडिशन के लिए एक प्रविष्टि। विजेट सबसे उपयुक्त चुनता है। **/
    sizes: FeedPostMediaItemAsset[]
}
interface FeedPostMediaItemAsset {
    w: number
    h: number
    src: string
}
interface FeedPostLink {
    /** लिंक का टेक्स्ट, जैसे "Sign up now"। **/
    text?: string
    /** लिंक के साथ दिखाया जाने वाला शीर्षक। **/
    title?: string
    /** लिंक के साथ दिखाया जाने वाला विवरण। **/
    description?: string
    url?: string
}

नोट्स:

इनमें से कुछ फ़ील्ड READONLY चिह्नित हैं - ये API द्वारा लौटाए जाते हैं लेकिन सेट नहीं किए जा सकते।
किसी पोस्ट पर कमेंट सामान्य कमेंट होते हैं जिनका urlId post: होता है जिसके बाद पोस्ट का _id आता है। किसी पोस्ट पर कमेंट पढ़ने या बनाने के लिए उस मान का उपयोग Comment API के साथ करें।

GET /api/v1/feed-posts

Resource: FeedPost as GET /api/v1/feed-posts Credit Cost: 1

फ़ीड में पोस्ट प्राप्त करता है, नवीनतम पहले। पेजिनेशन कर्सर आधारित है: अगला पेज प्राप्त करने के लिए आपके द्वारा प्राप्त अंतिम पोस्ट की _id को afterId के रूप में पास करें।

प्रत्येक दस लौटाई गई पोस्ट पर एक क्रेडिट लागत होती है, न्यूनतम एक क्रेडिट।

FeedPost cURL उदाहरण

Copy

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

FeedPost रिक्वेस्ट संरचना

Copy

interface FeedPostsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** इस पोस्ट आईडी के बाद की पोस्ट लौटाएँ। पहले पेज के लिए छोड़ें। **/
    afterId?: string
    /** डिफ़ॉल्ट 10। अधिकतम 1000। **/
    limit?: number
    /** केवल इन टैग्स वाली पोस्ट लौटाएँ। एक से अधिक टैग के लिए पैरामीटर दोहराएँ। **/
    tags?: string[]
}

FeedPost रिस्पॉन्स संरचना

Copy

interface FeedPostsResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'limit-invalid' | 'internal'
    /** विफलता पर शामिल। **/
    reason?: string
    feedPosts: FeedPost[]
}

POST /api/v1/feed-posts

Resource: FeedPost as POST /api/v1/feed-posts Credit Cost: 1

यह रूट एक सिंगल FeedPost बनाता है। हर पोस्ट का एक लेखक होता है, इसलिए fromUserId आवश्यक है और यह खाते पर मौजूद किसी FastComments या SSO उपयोगकर्ता की id होनी चाहिए।

FeedPost बनाने का cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/feed-posts?tenantId=demo&isLive=true&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "fromUserId": "some-user-id",
    "title": "Release 2.0 is out",
    "contentHTML": "<p>Read the notes and tell us what you think.</p>",
    "tags": ["releases"],
    "links": [
        {
            "url": "https://example.com/releases/2.0",
            "title": "Release notes",
            "description": "Everything that changed in 2.0."
        }
    ]
}'

FeedPost बनाने की रिक्वेस्ट संरचना

Copy

interface FeedPostPostQueryParams {
    tenantId: string
    API_KEY: string
    /** पोस्ट को उन फ़ीड्स पर भेजें जो अभी ब्राउज़र में खुले हैं। डिफ़ॉल्ट false है। **/
    isLive?: boolean
    /** सेव करने से पहले पोस्ट को स्पैम इंजन से गुज़ारें। डिफ़ॉल्ट false है। **/
    doSpamCheck?: boolean
    /** doSpamCheck के हिस्से के रूप में चलने वाली दोहराए गए कंटेंट की जाँच को छोड़ दें। डिफ़ॉल्ट false है। **/
    skipDupCheck?: boolean
    /** 256 वर्णों तक। लाइव लिसनर्स को भेजा जाता है ताकि क्लाइंट अपना खुद का ब्रॉडकास्ट अनदेखा कर सके। **/
    broadcastId?: string
}
interface FeedPostPostBody {
    /** आवश्यक। एक FastComments या SSO उपयोगकर्ता id। **/
    fromUserId: string
    title?: string
    /** HTML। सेव करते समय सैनिटाइज़ किया जाता है। **/
    contentHTML?: string
    /** उपयोगकर्ता से लिया गया डिस्प्ले नाम ओवरराइड करता है। **/
    fromUserDisplayName?: string
    tags?: string[]
    media?: FeedPostMediaItem[]
    links?: FeedPostLink[]
    meta?: Record<string, string>
}

FeedPost बनाने की रिस्पॉन्स संरचना

Copy

interface FeedPostPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-from-user-id' | 'invalid-user' | 'broadcast-id-too-long' | 'spam-blocked' | 'user-rate-limited' | 'internal'
    /** विफलता पर शामिल। **/
    reason?: string
    feedPost?: FeedPost; // सफलता पर हम पूरी बनाई गई पोस्ट वापस करते हैं।
}

PATCH /api/v1/feed-posts/:id

Resource: FeedPost as PATCH /api/v1/feed-posts/:id Credit Cost: 1

यह रूट एकल FeedPost को अपडेट करता है। केवल वही फ़ील्ड भेजें जिन्हें आप बदलना चाहते हैं।

FeedPost अपडेट cURL उदाहरण

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/feed-posts/some-post-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Release 2.0.1 is out",
    "tags": ["releases", "hotfix"]
}'

FeedPost अपडेट रिक्वेस्ट संरचना

Copy

interface FeedPostPatchQueryParams {
    tenantId: string
    API_KEY: string
}
/** FeedPost संरचना का कोई भी लिखने योग्य फ़ील्ड। **/
type FeedPostPatchBody = Partial<Pick<FeedPost, 'title' | 'contentHTML' | 'fromUserDisplayName' | 'tags' | 'weight' | 'meta' | 'media' | 'links'>>

FeedPost अपडेट रिस्पॉन्स संरचना

Copy

interface FeedPostPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'internal'
    /** विफलता पर शामिल। **/
    reason?: string
}

HashTag संरचना

एक HashTag ऑब्जेक्ट एक ऐसे टैग को दर्शाता है जिसे उपयोगकर्ता द्वारा छोड़ा जा सकता है। HashTags का उपयोग किसी बाहरी सामग्री से लिंक करने या संबंधित टिप्पणियों को एक साथ जोड़ने के लिए किया जा सकता है।

HashTag ऑब्जेक्ट की संरचना इस प्रकार है:

HashTag संरचना

Copy

interface HashTag {
    /** इसे "#" या इच्छित वर्ण से शुरू होना चाहिए। **/
    tag: string
    /** एक वैकल्पिक URL जिसकी ओर हैशटैग इंगित कर सकता है। हैशटैग द्वारा टिप्पणियों को फ़िल्टर करने के बजाय, क्लिक करने पर UI इस पर रीडायरेक्ट कर देगा। **/
    url?: string
    /** READONLY **/
    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

यह API पेजिनेशन का उपयोग करती है, जो page क्वेरी पैरामीटर द्वारा प्रदान की जाती है। HashTags 100 के पेजों में लौटाए जाते हैं, tag के अनुसार क्रमबद्ध।

HashTag cURL उदाहरण

Copy

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

HashTag रिक्वेस्ट संरचना

Copy

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

HashTag रिस्पॉन्स संरचना

Copy

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

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

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

यह रूट एकल HashTag को अपडेट करने की क्षमता प्रदान करता है।

HashTag अपडेट cURL उदाहरण

Copy

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

HashTag अपडेट रिक्वेस्ट संरचना

Copy

interface HashTagPatchQueryParams {
    tenantId: string
    API_KEY: string
}

HashTag अपडेट रिस्पॉन्स संरचना

Copy

interface HashTagPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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 जोड़ने की क्षमता प्रदान करता है।

HashTag बनाने का cURL उदाहरण

Copy

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

HashTag बनाने के अनुरोध की संरचना

Copy

interface HashTagPostQueryParams {
    tenantId: string
    API_KEY: string
}

HashTag बनाने के प्रतिक्रिया की संरचना

Copy

interface HashTagPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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 निर्माण अक्षम नहीं किया गया है, टिप्पणी करते समय हैशटैग प्रदान करके उपयोगकर्ता द्वारा हैशटैग को फिर से बनाया जा सकता है।

HashTag हटाने का cURL उदाहरण

Copy

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

HashTag हटाने के अनुरोध की संरचना

Copy

interface HashTagDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

HashTag हटाने की प्रतिक्रिया की संरचना

Copy

interface HashTagDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist'
    /** विफलता पर शामिल। **/
    reason?: string
}

GET /api/v1/me

Resource: Me as GET /api/v1/me Credit Cost: 1

अनुरोध करने वाले क्रेडेंशियल का वर्णन करता है: वह टेनेंट जिसका यह है और, OAuth एक्सेस टोकन के मामले में, वह उपयोगकर्ता जिसने एप्लिकेशन को अधिकृत किया। इंटीग्रेशन इसका उपयोग कनेक्शन का परीक्षण करने और उसे लेबल करने के लिए करते हैं।

API कुंजी के साथ प्रतिक्रिया केवल टेनेंट की पहचान करती है। OAuth बेयरर टोकन के साथ यह अधिकृत करने वाले उपयोगकर्ता और प्रदान किए गए स्कोप भी ले जाता है।

Me cURL उदाहरण

Copy

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

Me प्रतिक्रिया संरचना

Copy

interface MeResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** विफलता पर शामिल। **/
    reason?: string
    tenantId: string
    tenantName: string
    /** अनुरोध कैसे प्रमाणित हुआ। **/
    authType: 'api-key' | 'oauth'
    /** वे स्कोप जो क्रेडेंशियल के पास हैं। API कुंजियों के पास दोनों होते हैं। **/
    scopes: ('read' | 'write')[]
    /** केवल OAuth टोकन के लिए उपलब्ध। **/
    userId?: string
    username?: string
    email?: string
}

मॉडरेटर संरचना

एक Moderator ऑब्जेक्ट एक मॉडरेटर के लिए कॉन्फ़िगरेशन का प्रतिनिधित्व करता है।

मॉडरेटर के तीन प्रकार होते हैं:

वे एडमिनिस्ट्रेटर उपयोगकर्ता जिनके पास isCommentModeratorAdmin फ्लैग होता है।
isCommentModeratorAdmin फ्लैग वाले SSO उपयोगकर्ता।
सामान्य टिप्पणीकार, या FastComments.com उपयोगकर्ता, जिन्हें मॉडरेटर के रूप में आमंत्रित किया गया हो।

Moderator संरचना का उपयोग उपयोग केस 3 की मॉडरेशन स्थिति (Moderation State) को दर्शाने के लिए किया जाता है।

यदि आप API के माध्यम से किसी उपयोगकर्ता को मॉडरेटर बनने के लिए आमंत्रित करना चाहते हैं, तो एक Moderator बनाकर और उन्हें inviting करके Moderator API का उपयोग करें।

यदि उपयोगकर्ता के पास FastComments.com खाता नहीं है, तो आमंत्रण ईमेल उन्हें सेटअप करने में मदद करेगा। यदि उनके पास पहले से खाता है, तो उन्हें आपके टेनेंट (tenant) तक मॉडरेशन एक्सेस दिया जाएगा और Moderator ऑब्जेक्ट का userId उनके उपयोगकर्ता की ओर इशारा करने के लिए अपडेट कर दिया जाएगा। आपको उनके उपयोगकर्ता तक API एक्सेस नहीं मिलेगा, क्योंकि इस स्थिति में वह उपयोगकर्ता स्वयं का होता है और FastComments.com द्वारा प्रबंधित किया जाता है।

यदि आप उपयोगकर्ता के खाते का पूर्ण प्रबंधन चाहते हैं, तो हम या तो SSO का उपयोग करने, या उन्हें Tenant User के रूप में जोड़ने और फिर उनके आंकड़े ट्रैक करने के लिए एक Moderator ऑब्जेक्ट जोड़ने की सलाह देते हैं।

Moderator संरचना का उपयोग उपयोग केस 1 और 2 के लिए आंकड़े ट्रैकिंग तंत्र के रूप में किया जा सकता है। उपयोगकर्ता बनाने के बाद, उनका userId निर्दिष्ट करते हुए एक Moderator ऑब्जेक्ट जोड़ें और उनके आंकड़े Comment Moderators Page पर ट्रैक किए जाएंगे।

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

यह रूट id द्वारा एक मॉडरेटर को लौटाता है।

ID द्वारा मॉडरेटर cURL उदाहरण

Copy

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

मॉडरेटर रिक्वेस्ट संरचना

Copy

interface ModeratorByIdQueryParams {
    tenantId: string
    API_KEY: string
}

मॉडरेटर रिस्पॉन्स संरचना

Copy

interface ModeratorByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
    moderator?: Moderator
}

GET /api/v1/moderators

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

यह API पेजिनेशन का उपयोग करती है, जो skip क्वेरी पैरामीटर द्वारा प्रदान की जाती है। मॉडरेटर 100 के पृष्ठों में लौटाए जाते हैं, createdAt और id के अनुसार क्रमबद्ध।

लागत लौटाए गए मॉडरेटर की संख्या पर आधारित है, प्रत्येक 10 मॉडरेटर पर 1 क्रेडिट की दर से।

मॉडरेटर cURL उदाहरण

Copy

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

मॉडरेटर रिक्वेस्ट संरचना

Copy

interface ModeratorsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** पेजिनेशन के लिए छोड़े जाने वाले मॉडरेटर की संख्या। **/
    skip?: number
}

मॉडरेटर रिस्पॉन्स संरचना

Copy

interface ModeratorsResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** विफलता पर शामिल। **/
    reason?: string
    moderators?: Moderator[]
}

PATCH /api/v1/moderators/:id

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

यह API एंडपॉइंट id द्वारा एक Moderator को अपडेट करने की क्षमता प्रदान करता है।

एक Moderator को अपडेट करने की निम्नलिखित सीमाएँ हैं:

Moderator को अपडेट करते समय निम्नलिखित मान प्रदान नहीं किए जा सकते:
- acceptedInvite
- markReviewedCount
- deletedCount
- markedSpamCount
- approvedCount
- editedCount
- bannedCount
- verificationId
- createdAt
जब एक userId निर्दिष्ट किया जाता है, तो वह उपयोगकर्ता मौजूद होना चाहिए।
जब एक userId निर्दिष्ट किया जाता है, तो वह क्वेरी पैरामीटर में निर्दिष्ट उसी tenantId से संबंधित होना चाहिए।
एक ही टेनेंट में दो मॉडरेटर एक ही email के साथ नहीं जोड़े जा सकते।
आप एक Moderator से जुड़े tenantId को नहीं बदल सकते।

Moderator PATCH cURL उदाहरण

Copy

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

Moderator PATCH अनुरोध संरचना

Copy

interface ModeratorPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Moderator PATCH प्रतिक्रिया संरचना

Copy

interface ModeratorPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';  
    /** विफलता पर शामिल। **/
    reason?: string
}

POST /api/v1/moderators

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

यह रूट एक सिंगल Moderator जोड़ने की क्षमता प्रदान करता है।

एक Moderator बनाने के लिए निम्नलिखित प्रतिबंध हैं:

एक name और email हमेशा प्रदान किया जाना चाहिए। userId वैकल्पिक है।
एक Moderator बनाते समय निम्नलिखित मान प्रदान नहीं किए जा सकते:
- acceptedInvite
- markReviewedCount
- deletedCount
- markedSpamCount
- approvedCount
- editedCount
- bannedCount
- verificationId
- createdAt
जब एक userId निर्दिष्ट किया जाता है, तो वह उपयोगकर्ता मौजूद होना चाहिए।
जब एक userId निर्दिष्ट किया जाता है, तो वह क्वेरी पैरामीटर में निर्दिष्ट उसी tenantId से संबंधित होना चाहिए।
एक ही टेनेंट में दो मॉडरेटर एक ही email के साथ नहीं जोड़े जा सकते।

हम एक ऐसे उपयोगकर्ता के लिए Moderator बना सकते हैं जिसके बारे में हमें केवल ईमेल पता हो:

ईमेल द्वारा Moderator बनाने का cURL उदाहरण

Copy

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

या हम अपने टेनेंट से संबंधित एक उपयोगकर्ता के लिए Moderator बना सकते हैं, ताकि उनके मॉडरेशन आंकड़ों को ट्रैक किया जा सके:

टेनेंट उपयोगकर्ता द्वारा Moderator बनाने का cURL उदाहरण

Copy

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

Moderator बनाने के अनुरोध की संरचना

Copy

interface ModeratorPostQueryParams {
    tenantId: string
    API_KEY: string
}

Moderator बनाने की प्रतिक्रिया की संरचना

Copy

interface ModeratorPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
    moderator?: Moderator; // सफलता पर हम पूरा बनाया गया मॉडरेटर लौटाते हैं।
}

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

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

यह रूट एक सिंगल 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

यह रूट Moderator को id द्वारा हटाने की सुविधा प्रदान करता है।

Moderator हटाने का cURL उदाहरण

Copy

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

Moderator हटाने के अनुरोध की संरचना

Copy

interface ModeratorDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Moderator हटाने के प्रतिक्रिया की संरचना

Copy

interface ModeratorDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
}

सूचना संख्या संरचना

एक NotificationCount ऑब्जेक्ट किसी उपयोगकर्ता के लिए अपठित नोटिफिकेशन की संख्या और मेटाडेटा को दर्शाता है।

यदि कोई अपठित नोटिफिकेशन नहीं है, तो उपयोगकर्ता के लिए कोई NotificationCount नहीं होगा।

NotificationCount ऑब्जेक्ट स्वचालित रूप से बनाए जाते हैं और API के माध्यम से नहीं बनाए जा सकते। ये एक वर्ष बाद समाप्त (expire) हो जाते हैं।

आप उपयोगकर्ता का NotificationCount डिलीट करके उसकी अपठित नोटिफिकेशन संख्या साफ़ कर सकते हैं।

NotificationCount ऑब्जेक्ट की संरचना इस प्रकार है:

NotificationCount संरचना

Copy

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

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

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

यह रूट यूज़र आईडी द्वारा एकल NotificationCount लौटाता है। SSO के साथ, यूज़र आईडी <tenant id>:<user id> प्रारूप में होती है।

यदि कोई अपठित नोटिफिकेशन नहीं है, तो कोई NotificationCount नहीं होगा - इसलिए आपको 404 मिलेगा।

यह notifications/count से इस मायने में अलग है कि यह बहुत तेज़ है, लेकिन फ़िल्टरिंग की अनुमति नहीं देता।

NotificationCount आईडी द्वारा cURL उदाहरण

Copy

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

NotificationCount रिक्वेस्ट संरचना

Copy

interface NotificationCountGetQueryParams {
    tenantId: string
    API_KEY: string
}

NotificationCount रिस्पॉन्स संरचना

Copy

interface NotificationCountGetResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
    data?: NotificationCount
}

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

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

यह रूट यूज़र आईडी द्वारा एकल NotificationCount को डिलीट करता है। SSO के साथ, यूज़र आईडी <tenant id>:<user id> फ़ॉर्मैट में होती है।

यह यूज़र की अपठित नोटिफिकेशन गिनती को साफ़ कर देगा (कमेंट विजेट में लाल घंटी फीकी पड़ जाएगी और गिनती हट जाएगी)।

NotificationCount डिलीट करने का cURL उदाहरण

Copy

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

NotificationCount हटाने के रिक्वेस्ट की संरचना

Copy

interface NotificationCountDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

NotificationCount हटाने के रिस्पॉन्स की संरचना

Copy

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

सूचना संरचना

एक Notification ऑब्जेक्ट किसी उपयोगकर्ता के लिए एक नोटिफिकेशन को दर्शाता है।

Notification ऑब्जेक्ट्स स्वचालित रूप से बनाए जाते हैं और इन्हें API के माध्यम से नहीं बनाया जा सकता। ये एक वर्ष बाद समाप्त (expire) भी हो जाते हैं। नोटिफिकेशन को डिलीट नहीं किया जा सकता। हालाँकि, इन्हें अपडेट करके viewed को false सेट किया जा सकता है, और आप viewed के आधार पर क्वेरी कर सकते हैं।

एक उपयोगकर्ता किसी विशेष कमेंट के लिए नोटिफिकेशन से ऑप्ट आउट भी कर सकता है, नोटिफिकेशन में optedOut को true सेट करके। आप इसे false सेट करके दोबारा ऑप्ट इन कर सकते हैं।

विभिन्न नोटिफिकेशन प्रकार होते हैं - relatedObjectType और type देखें।

नोटिफिकेशन बनाने के तरीके काफी लचीले हैं और इन्हें कई परिदृश्यों द्वारा ट्रिगर किया जा सकता है (NotificationType देखें)।

आज की तारीख तक, एक Notification का अस्तित्व वास्तव में यह नहीं दर्शाता कि कोई ईमेल भेजा गया है या भेजा जाना चाहिए। बल्कि, नोटिफिकेशन का उपयोग नोटिफिकेशन फ़ीड और संबंधित इंटीग्रेशन के लिए किया जाता है।

Notification ऑब्जेक्ट की संरचना इस प्रकार है:

Notification संरचना

Copy

enum NotificationObjectType {
    Comment = 0,
    Profile = 1,
    Tenant = 2
}
enum NotificationType {
    /** अगर किसी ने आपको रिप्लाई किया। **/
    RepliedToMe = 0,
    /** अगर किसी ने ऐसी थ्रेड में कहीं भी रिप्लाई किया (बच्चों के बच्चों सहित) जिस थ्रेड पर आपने कमेंट किया था। **/
    RepliedTransientChild = 1,
    /** अगर आपके कमेंट को अप-वोट किया गया। **/
    VotedMyComment = 2,
    /** अगर आपकी सदस्यता वाले पेज के रूट पर नया कमेंट किया गया। **/
    SubscriptionReplyRoot = 3,
    /** अगर किसी ने आपकी प्रोफ़ाइल पर कमेंट किया। **/
    CommentedOnProfile = 4,
    /** अगर आपके पास कोई DM है। **/
    DirectMessage = 5,
    /** TrialLimits केवल tenant उपयोगकर्ताओं के लिए है। **/
    TrialLimits = 6,
    /** अगर आपको @mentioned किया गया। **/
    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
    /** नोटिफिकेशन स्रोत को तेज़ी से पढ़ने के लिए Page Title कैश किया जाता है। **/
    pageTitle?: string
    relatedObjectType: NotificationObjectType
    /** उदाहरण के लिए, comment id। **/
    relatedObjectId: string
    viewed: boolean
    createdAt: string // date 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

यह रूट createdAt के अनुसार क्रमबद्ध, नवीनतम पहले, 30 Notification ऑब्जेक्ट तक लौटाता है।

आप userId द्वारा फ़िल्टर कर सकते हैं। SSO के साथ, यूज़र आईडी <tenant id>:<user id> प्रारूप में होती है।

यूज़र के लिए अपठित नोटिफिकेशन cURL उदाहरण

Copy

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

नोटिफिकेशन रिक्वेस्ट संरचना

Copy

interface NotificationsGetQueryParams {
    tenantId: string
    API_KEY: string
    /** रिकॉर्ड छोड़कर पेजिनेट करें। **/
    skip?: number
    /** यूज़र द्वारा फ़िल्टर करें। **/
    userId?: string
    /** urlId द्वारा फ़िल्टर करें। **/
    urlId?: string
    /** स्रोत कमेंट द्वारा फ़िल्टर करें। **/
    fromCommentId?: string
    /** पढ़े/अपठित द्वारा फ़िल्टर करें। **/
    viewed?: 'true' | 'false'
    /** प्रकार द्वारा फ़िल्टर करें। **/
    type?: NotificationType
}

नोटिफिकेशन रिस्पॉन्स संरचना

Copy

interface NotificationsGetResponse {
    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
    notifications?: Notification[]
}

GET /api/v1/notifications/count

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

यह रूट एक ऑब्जेक्ट लौटाता है जिसमें count पैरामीटर के अंतर्गत सूचनाओं की संख्या होती है।

यह /notification-count/ से धीमा है और क्रेडिट्स की लागत दोगुनी है, लेकिन यह अधिक आयामों पर फ़िल्टर करने की अनुमति देता है।

आप /notifications एंडपॉइंट के समान पैरामीटरों से फ़िल्टर कर सकते हैं, जैसे userId। SSO के साथ, यूज़र आईडी <tenant id>:<user id> प्रारूप में होती है।

यूज़र के लिए अपठित सूचना संख्या cURL उदाहरण

Copy

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

किसी विशिष्ट पेज के लिए यूज़र की अपठित सूचना संख्या cURL उदाहरण

Copy

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

सूचना संख्या अनुरोध संरचना

Copy

interface NotificationCountGetQueryParams {
    tenantId: string
    API_KEY: string
    /** यूज़र के अनुसार फ़िल्टर करें। **/
    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 एंडपॉइंट id द्वारा एक Notification को अपडेट करने की क्षमता प्रदान करता है।

एक Notification को अपडेट करने की निम्नलिखित सीमाएँ हैं:

आप केवल निम्नलिखित फ़ील्ड अपडेट कर सकते हैं:
- viewed
- optedOut

Notification PATCH cURL उदाहरण

Copy

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

Notification PATCH रिक्वेस्ट संरचना

Copy

interface NotificationPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Notification PATCH रिस्पॉन्स संरचना

Copy

interface NotificationPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';  
    /** विफलता पर शामिल। **/
    reason?: string
}

पेज रिएक्ट्स सार्वजनिक API

Page Reacts आपके उपयोगकर्ताओं को किसी पेज को लाइक करने, या आपके अपने रिएक्शन इमेज के सेट के साथ उस पर प्रतिक्रिया देने की सुविधा देते हैं। Page Reacts widget और Floating Likes widget इन endpoints पर बने हैं, और आप इन्हें स्वयं कॉल करके अपना लाइक बटन बना सकते हैं।

इस गाइड के बाकी हिस्सों के विपरीत, Page Reacts endpoints सार्वजनिक (public) हैं। इन्हें आपके उपयोगकर्ताओं के ब्राउज़र से कॉल किया जाता है, इनमें कोई API key नहीं लगती, और ये कोई API credits खर्च नहीं करते। हर react अनुरोध करने वाले उपयोगकर्ता से जुड़ा होता है, इसलिए कोई उपयोगकर्ता केवल अपना ही react जोड़ या हटा सकता है।

Endpoints के दो सेट हैं:

/page-reacts/v1/likes/:tenantId - प्रति उपयोगकर्ता प्रति पेज एक "like"। इन्हें लाइक बटन के लिए उपयोग करें।
/page-reacts/v2/:tenantId - प्रति पेज एकाधिक reactions, प्रत्येक आपके चुने हुए एक छोटे id से पहचाना जाता है (उदाहरण के लिए heart या laugh)।

दोनों हमारे SDKs में PublicApi के हिस्से के रूप में भी उपलब्ध हैं, उदाहरण के लिए JavaScript SDK में getV1PageLikes, createV1PageReact, और deleteV1PageReact।

किसने प्रतिक्रिया दी यह दिखाना

जिन उपयोगकर्ताओं ने लाइक या प्रतिक्रिया दी है उन्हें उनके usernames और avatars के साथ, सबसे हालिया पहले, प्राप्त करने के लिए GET endpoints को includeUserInfo=public पास करें। जिन उपयोगकर्ताओं ने अपनी profile activity private कर रखी है वे छोड़ दिए जाते हैं, जैसे anonymous users भी। अधिकतम 100 reacts लौटाए जाते हैं।

SSO users आपका SSO payload isProfileActivityPrivate को false सेट न करे तो private profile activity के साथ बनाए जाते हैं, इसलिए जिन उपयोगकर्ताओं को आप इन सूचियों में दिखाना चाहते हैं उनके लिए इसे सेट करें।

SSO आवश्यक करने वाले पेजों पर, केवल वे SSO users जो पेज देख सकते हैं, वे ही यह सूचीबद्ध कर सकते हैं कि किसने प्रतिक्रिया दी। अन्य लोगों को sso-required या page-forbidden कोड के साथ 403 मिलता है।

अपने सर्वर से, GET /api/v1/pages/likes और GET /api/v1/pages/reacts API key के साथ वही सूचियाँ लौटाते हैं, और private profiles वाले उपयोगकर्ताओं को शामिल करने के लिए includeUserInfo=include-private भी स्वीकार करते हैं।

उपयोगकर्ता की पहचान करना

Reacts अनुरोध करने वाले उपयोगकर्ता से जुड़े होते हैं:

SSO users: sso query parameter पास करें, जो उसी SSO object के URI encoded JSON पर सेट हो जो आप comment widget को देते हैं। SSO देखें।
Anonymous users: जब sso parameter न हो और कोई FastComments लॉगिन न हो, तो सर्वर ब्राउज़र को FastComments session cookie में संग्रहीत एक anonymous id असाइन करता है। अनुरोध credentials: 'include' के साथ भेजें ताकि अनुरोधों के बीच cookie बना रहे। जो ब्राउज़र third-party cookies को ब्लॉक करते हैं वे anonymous id को बनाए नहीं रखेंगे, इसलिए जब प्रत्येक उपयोगकर्ता को विश्वसनीय रूप से पहचाना जाना आवश्यक हो तो SSO का उपयोग करें।

urlId

urlId पेज की पहचान करता है, ठीक उसी तरह जैसे यह comments के लिए करता है। वही urlId उपयोग करें जो आप comment widget को देते हैं ताकि likes और comments एक ही पेज पर गिने जाएँ। इसे URI encode करना न भूलें।

लाइक बटन उदाहरण

Copy

const tenantId = 'demo';
const urlId = 'https://example.com/my-article';
// Optional, for SSO users. The same object you give the comment widget's "sso" option.
const sso = null;
function likesUrl() {
    let url = `https://fastcomments.com/page-reacts/v1/likes/${tenantId}?urlId=${encodeURIComponent(urlId)}`;
    if (sso) {
        url += '&sso=' + encodeURIComponent(JSON.stringify(sso));
    }
    return url;
}
async function getLikes() {
    const response = await fetch(likesUrl(), {credentials: 'include'});
    return response.json(); // {status, likeCount, didLike, commentCount, urlIdWS}
}
async function like() {
    await fetch(likesUrl(), {method: 'POST', credentials: 'include'});
}
async function unlike() {
    await fetch(likesUrl(), {method: 'DELETE', credentials: 'include'});
}

GET /page-reacts/v1/likes/:tenantId

Resource: Page Likes as GET /page-reacts/v1/likes/:tenantId Credit Cost: 0

किसी पेज पर लाइक की संख्या लौटाता है, और यह भी कि क्या वर्तमान उपयोगकर्ता ने उसे लाइक किया है। जो पेज अभी तक मौजूद नहीं हैं, वे likeCount के रूप में 0 लौटाते हैं।

पेज को लाइक करने वाले उपयोगकर्ताओं को भी पाने के लिए, नवीनतम पहले, includeUserInfo=public पास करें। निजी प्रोफ़ाइल गतिविधि वाले उपयोगकर्ताओं और गुमनाम उपयोगकर्ताओं को छोड़ दिया जाता है, और अधिकतम 100 लाइक देखे जाते हैं। यहाँ केवल public स्वीकार किया जाता है; include-private एक 422 लौटाता है और यह API कुंजी के साथ GET /api/v1/pages/likes से उपलब्ध है। जिन पेजों पर SSO आवश्यक है, वहाँ includeUserInfo उन उपयोगकर्ताओं के लिए 403 लौटाता है जो पेज नहीं देख सकते।

Page Likes cURL उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/page-reacts/v1/likes/demo?urlId=example-id-or-url'

Page Likes अनुरोध संरचना

Copy

interface PageLikesRequestQueryParams {
    urlId: string
    /** आपके SSO ऑब्जेक्ट का URI एनकोडेड JSON। गुमनाम उपयोगकर्ताओं के लिए छोड़ दें। **/
    sso?: string
    /** पेज को लाइक करने वाले उपयोगकर्ताओं को शामिल करने के लिए 'public' सेट करें। **/
    includeUserInfo?: 'public'
}

Page Likes प्रतिक्रिया संरचना

Copy

interface PageLikesResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'include-private-not-allowed' | 'sso-required' | 'page-forbidden' | string
    /** विफलता पर शामिल। **/
    reason?: string
    likeCount: number
    /** क्या अनुरोध करने वाले उपयोगकर्ता ने पेज लाइक किया है। **/
    didLike: boolean
    /** पेज पर टॉप लेवल कमेंट्स की संख्या। **/
    commentCount: number
    /** इस पेज के लिए लाइव अपडेट की सदस्यता लेने के लिए उपयोग की जाने वाली id। **/
    urlIdWS: string
    /** नवीनतम पहले। केवल तब सेट होता है जब includeUserInfo पास किया गया हो। **/
    users?: PageReactUser[]
}
interface PageReactUser {
    userId: string
    username: string
    displayName?: string
    avatarSrc?: string
}

POST /page-reacts/v1/likes/:tenantId

Resource: Page Likes as POST /page-reacts/v1/likes/:tenantId Credit Cost: 0

वर्तमान उपयोगकर्ता के रूप में पेज को लाइक करता है। प्रत्येक उपयोगकर्ता किसी पेज को एक बार लाइक कर सकता है: दोबारा लाइक करने पर already-liked कोड के साथ सफलता मिलती है और गिनती नहीं बदलती।

यदि पेज अभी तक मौजूद नहीं है तो उसे बनाया जाता है। पेज का टाइटल सेट या अपडेट करने के लिए title पास करें।

पेज लाइक cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/page-reacts/v1/likes/demo?urlId=example-id-or-url&title=My%20Article'

पेज लाइक रिक्वेस्ट संरचना

Copy

interface PageLikeRequestQueryParams {
    urlId: string
    /** पेज का टाइटल सेट करता है। **/
    title?: string
    /** आपके SSO ऑब्जेक्ट का URI एनकोडेड JSON। अनाम उपयोगकर्ताओं के लिए छोड़ दें। **/
    sso?: string
}

पेज लाइक रिस्पॉन्स संरचना

Copy

interface PageLikeResponse {
    status: 'success' | 'failed'
    /** 'already-liked' जब उपयोगकर्ता पहले ही पेज लाइक कर चुका हो। अन्यथा विफलता पर शामिल। **/
    code?: 'already-liked' | string
    /** विफलता पर शामिल। **/
    reason?: string
}

DELETE /page-reacts/v1/likes/:tenantId

Resource: Page Likes as DELETE /page-reacts/v1/likes/:tenantId Credit Cost: 0

वर्तमान उपयोगकर्ता का लाइक पेज से हटाता है। यदि उपयोगकर्ता ने पेज को लाइक नहीं किया है, तो अनुरोध not-liked कोड के साथ सफल होता है और गिनती नहीं बदलती।

पेज अनलाइक cURL उदाहरण

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/page-reacts/v1/likes/demo?urlId=example-id-or-url'

पेज अनलाइक अनुरोध संरचना

Copy

interface PageUnlikeRequestQueryParams {
    urlId: string
    /** आपके SSO ऑब्जेक्ट का URI एन्कोडेड JSON। गुमनाम उपयोगकर्ताओं के लिए छोड़ दें। **/
    sso?: string
}

पेज अनलाइक प्रतिक्रिया संरचना

Copy

interface PageUnlikeResponse {
    status: 'success' | 'failed'
    /** 'not-liked' जब उपयोगकर्ता ने पेज को लाइक नहीं किया था। अन्यथा विफलता पर शामिल। **/
    code?: 'not-liked' | string
    /** विफलता पर शामिल। **/
    reason?: string
}

GET /page-reacts/v2/:tenantId

Resource: Page Reacts as GET /page-reacts/v2/:tenantId Credit Cost: 0

किसी पेज पर प्रत्येक रिएक्शन की संख्या, और वर्तमान उपयोगकर्ता द्वारा जोड़े गए रिएक्शन लौटाता है।

रिएक्ट करने वाले उपयोगकर्ताओं को भी पाने के लिए includeUserInfo=public पास करें, जिसमें प्रत्येक रिएक्ट के लिए एक प्रविष्टि उसके रिएक्शन id के साथ होती है, सबसे हालिया पहले। निजी प्रोफ़ाइल गतिविधि वाले उपयोगकर्ता और गुमनाम उपयोगकर्ता छोड़ दिए जाते हैं, और अधिकतम 100 रिएक्ट देखे जाते हैं। यहाँ केवल public स्वीकार किया जाता है; include-private एक 422 लौटाता है और API कुंजी के साथ GET /api/v1/pages/reacts से उपलब्ध है। उन पेजों पर जिन्हें SSO की आवश्यकता होती है, includeUserInfo उन उपयोगकर्ताओं के लिए 403 लौटाता है जो पेज नहीं देख सकते।

Page Reacts cURL उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/page-reacts/v2/demo?urlId=example-id-or-url'

Page Reacts अनुरोध संरचना

Copy

interface PageReactsRequestQueryParams {
    urlId: string
    /** आपके SSO ऑब्जेक्ट का URI encoded JSON। गुमनाम उपयोगकर्ताओं के लिए छोड़ दें। **/
    sso?: string
    /** रिएक्ट करने वाले उपयोगकर्ताओं को शामिल करने के लिए 'public' सेट करें। **/
    includeUserInfo?: 'public'
}

Page Reacts प्रतिक्रिया संरचना

Copy

interface PageReactsResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'include-private-not-allowed' | 'sso-required' | 'page-forbidden' | string
    /** विफलता पर शामिल। **/
    reason?: string
    /** प्रत्येक रिएक्शन id के लिए संख्या, उदाहरण के लिए {"heart": 12, "laugh": 3}। पेज पर कोई रिएक्शन न होने पर सेट नहीं होता। **/
    counts?: Record<string, number>
    /** अनुरोध करने वाले उपयोगकर्ता द्वारा जोड़े गए रिएक्शन ids। उन्होंने कोई न जोड़ा होने पर सेट नहीं होता। **/
    reactedIds?: string[]
    /** प्रत्येक रिएक्ट के लिए एक प्रविष्टि, सबसे हालिया पहले। केवल तब सेट होता है जब includeUserInfo पास किया गया हो। **/
    users?: PageCustomReactUser[]
}
interface PageCustomReactUser {
    /** रिएक्शन id, उदाहरण के लिए "heart"। **/
    reactId: string
    userId: string
    username: string
    displayName?: string
    avatarSrc?: string
}

GET /page-reacts/v2/:tenantId/list

Resource: Page React Users as GET /page-reacts/v2/:tenantId/list Credit Cost: 0

किसी पेज पर रिएक्शन जोड़ने वाले उपयोगकर्ताओं के नाम, वर्णानुक्रम में क्रमबद्ध करके लौटाता है। 100 तक रिएक्ट देखे जाते हैं, और गुमनाम उपयोगकर्ता तथा निजी प्रोफ़ाइल गतिविधि वाले उपयोगकर्ता शामिल नहीं होते। SSO आवश्यक वाले पेजों पर, जो उपयोगकर्ता पेज नहीं देख सकते उन्हें sso-required या page-forbidden कोड के साथ 403 मिलता है।

अवतार और उपयोगकर्ता ids भी प्राप्त करने के लिए, includeUserInfo=public के साथ GET /page-reacts/v2/:tenantId का उपयोग करें।

Page React Users cURL उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/page-reacts/v2/demo/list?urlId=example-id-or-url&id=heart'

Page React Users रिक्वेस्ट संरचना

Copy

interface PageReactUsersRequestQueryParams {
    urlId: string
    /** रिएक्शन id। **/
    id: string
    /** आपके SSO ऑब्जेक्ट का URI encoded JSON। गुमनाम उपयोगकर्ताओं के लिए छोड़ दें। **/
    sso?: string
}

Page React Users रिस्पॉन्स संरचना

Copy

interface PageReactUsersResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: string
    /** विफलता पर शामिल। **/
    reason?: string
    userNames: string[]
}

POST /page-reacts/v2/:tenantId

Resource: Page Reacts as POST /page-reacts/v2/:tenantId Credit Cost: 0

वर्तमान उपयोगकर्ता के रूप में किसी पेज पर एक रिएक्शन जोड़ता है। एक उपयोगकर्ता प्रत्येक रिएक्शन id को केवल एक बार जोड़ सकता है: इसे दोबारा जोड़ने पर already-reacted कोड के साथ सफलता मिलती है और काउंट नहीं बदलता। एक उपयोगकर्ता एक ही पेज पर कई अलग-अलग रिएक्शन जोड़ सकता है।

रिएक्शन ids आपके द्वारा चुने जाते हैं और 36 वर्णों तक के हो सकते हैं। यदि पेज अभी तक मौजूद नहीं है तो उसे बना दिया जाता है। पेज का शीर्षक सेट या अपडेट करने के लिए title पास करें।

पेज रिएक्शन cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/page-reacts/v2/demo?urlId=example-id-or-url&id=heart'

पेज रिएक्शन रिक्वेस्ट संरचना

Copy

interface PageReactRequestQueryParams {
    urlId: string
    /** रिएक्शन id, 36 वर्णों तक। **/
    id: string
    /** पेज का शीर्षक सेट करता है। **/
    title?: string
    /** आपके SSO ऑब्जेक्ट का URI एनकोडेड JSON। अनाम उपयोगकर्ताओं के लिए छोड़ दें। **/
    sso?: string
}

पेज रिएक्शन रिस्पॉन्स संरचना

Copy

interface PageReactResponse {
    status: 'success' | 'failed'
    /** 'already-reacted' जब उपयोगकर्ता ने पहले ही यह रिएक्शन जोड़ लिया हो। 'react-id-too-long' (HTTP 422) जब id 36 वर्णों से अधिक हो। अन्यथा विफलता पर शामिल। **/
    code?: 'already-reacted' | 'react-id-too-long' | string
    /** विफलता पर शामिल। **/
    reason?: string
}

DELETE /page-reacts/v2/:tenantId

Resource: Page Reacts as DELETE /page-reacts/v2/:tenantId Credit Cost: 0

वर्तमान उपयोगकर्ता की एक प्रतिक्रिया को पेज से हटाता है। यदि उपयोगकर्ता ने वह प्रतिक्रिया नहीं जोड़ी है, तो अनुरोध no-react कोड के साथ सफल होता है और काउंट को नहीं बदलता।

पेज रिएक्ट डिलीट cURL उदाहरण

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/page-reacts/v2/demo?urlId=example-id-or-url&id=heart'

पेज रिएक्ट डिलीट अनुरोध संरचना

Copy

interface PageReactDeleteRequestQueryParams {
    urlId: string
    /** The reaction id. **/
    id: string
    /** URI encoded JSON of your SSO object. Omit for anonymous users. **/
    sso?: string
}

पेज रिएक्ट डिलीट प्रतिक्रिया संरचना

Copy

interface PageReactDeleteResponse {
    status: 'success' | 'failed'
    /** 'no-react' when the user had not added this reaction. Otherwise included on failure. **/
    code?: 'no-react' | string
    /** Included on failure. **/
    reason?: string
}

पेज संरचना

एक Page ऑब्जेक्ट उस पेज को दर्शाता है जिससे कई कमेंट्स संबंधित हो सकते हैं। यह संबंध urlId द्वारा परिभाषित होता है।

एक Page पेज का शीर्षक, कमेंट काउंट और urlId जैसी जानकारी संग्रहीत करता है।

Page ऑब्जेक्ट की संरचना इस प्रकार है:

Page संरचना

Copy

interface Page {
    id: string
    urlId: string
    url: string
    title?: string
    createdAt: string
    commentCount: number
    rootCommentCount: number
    /** इसे null पर सेट करने का अर्थ है कि सभी SSO उपयोगकर्ता पेज देख सकते हैं। खाली सूची का अर्थ है कि यह सभी उपयोगकर्ताओं के लिए बंद है। **/
    accessibleByGroupIds?: string[] | null
    /** क्या यह पेज नए कमेंट्स के लिए बंद है? **/
    isClosed?: boolean
}

GET /api/v1/pages

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

वर्तमान में आप केवल अपने खाते से जुड़े सभी पेज (या /by-url-id के माध्यम से एकल पेज) प्राप्त कर सकते हैं। यदि आप अधिक सूक्ष्म खोज चाहते हैं, तो हमसे संपर्क करें।

Pages cURL उदाहरण

Copy

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

Pages अनुरोध संरचना

Copy

interface PagesRequestQueryParams {
    tenantId: string
    API_KEY: string
}

Pages प्रतिक्रिया संरचना

Copy

interface PagesResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** विफलता पर शामिल। **/
    reason?: string
    pages: Page[]
}

उपयोगी सुझाव

Comment API को एक urlId की आवश्यकता होती है। आप पहले Pages API को कॉल कर सकते हैं, यह देखने के लिए कि आपके लिए उपलब्ध urlId मान कैसे दिखते हैं।

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

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

अलग-अलग पेजों को उनके संबंधित urlId के आधार पर प्राप्त किया जा सकता है। यह पेज शीर्षक या कमेंट की संख्या देखने के लिए उपयोगी हो सकता है।

URL ID द्वारा पेज cURL उदाहरण

Copy

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

URL ID द्वारा पेज रिक्वेस्ट संरचना

Copy

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

URL ID द्वारा पेज रिस्पॉन्स संरचना

Copy

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

उपयोगी सुझाव

urlId जैसे मानों को URI Encode करना न भूलें।

GET /api/v1/pages/likes

Resource: Page Likes as GET /api/v1/pages/likes Credit Cost: 1

किसी पेज पर लाइक की संख्या, और वैकल्पिक रूप से उन उपयोगकर्ताओं की सूची लौटाता है जिन्होंने उसे लाइक किया, सबसे हालिया पहले। यह GET /page-reacts/v1/likes/:tenantId का सर्वर-साइड संस्करण है।

includeUserInfo नियंत्रित करता है कि कौन से उपयोगकर्ता लौटाए जाते हैं:

public उन उपयोगकर्ताओं को छोड़ देता है जिन्होंने अपनी प्रोफ़ाइल गतिविधि निजी कर रखी है।
include-private उन्हें शामिल करता है। इसका उपयोग केवल तब करें जब सूची सार्वजनिक रूप से न दिखाई जा रही हो।

गुमनाम (Anonymous) उपयोगकर्ता कभी शामिल नहीं किए जाते, और अधिकतम 100 लाइक ही देखे जाते हैं। जो पेज मौजूद नहीं हैं वे likeCount के रूप में 0 और खाली users सूची लौटाते हैं।

Page Likes cURL उदाहरण

Copy

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

Page Likes रिक्वेस्ट संरचना

Copy

interface PageLikesRequestQueryParams {
    tenantId: string
    API_KEY: string
    urlId: string
    /** केवल लाइक संख्या प्राप्त करने के लिए इसे छोड़ दें। **/
    includeUserInfo?: 'public' | 'include-private'
}

Page Likes रिस्पॉन्स संरचना

Copy

interface PageLikesResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
    /** विफलता पर शामिल। **/
    reason?: string
    likeCount?: number
    /** सबसे हालिया पहले। केवल तब सेट होता है जब includeUserInfo पास किया गया हो। **/
    users?: PageReactUser[]
}
interface PageReactUser {
    userId: string
    username: string
    displayName?: string
    avatarSrc?: string
}

उपयोगी सुझाव

urlId जैसे मानों को URI Encode करना न भूलें।

GET /api/v1/pages/reacts

Resource: Page Reacts as GET /api/v1/pages/reacts Credit Cost: 1

किसी पेज पर प्रत्येक रिएक्शन की संख्या लौटाता है, और वैकल्पिक रूप से उन उपयोगकर्ताओं को भी जिन्होंने रिएक्ट किया, प्रत्येक रिएक्ट के लिए एक एंट्री के रूप में उसके रिएक्शन आईडी के साथ, सबसे हालिया पहले। यह GET /page-reacts/v2/:tenantId का सर्वर-साइड संस्करण है।

includeUserInfo नियंत्रित करता है कि कौन से उपयोगकर्ता लौटाए जाते हैं:

public उन उपयोगकर्ताओं को छोड़ देता है जिन्होंने अपनी प्रोफ़ाइल गतिविधि निजी रखी है।
include-private उन्हें शामिल करता है। इसका उपयोग केवल तब करें जब सूची सार्वजनिक रूप से न दिखाई जा रही हो।

गुमनाम (Anonymous) उपयोगकर्ता कभी शामिल नहीं किए जाते, और अधिकतम 100 रिएक्ट देखे जाते हैं। जो पेज मौजूद नहीं हैं वे कोई counts नहीं और खाली users सूची लौटाते हैं।

Page Reacts cURL उदाहरण

Copy

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

Page Reacts रिक्वेस्ट संरचना

Copy

interface PageReactsRequestQueryParams {
    tenantId: string
    API_KEY: string
    urlId: string
    /** केवल counts प्राप्त करने के लिए इसे छोड़ दें। **/
    includeUserInfo?: 'public' | 'include-private'
}

Page Reacts रिस्पॉन्स संरचना

Copy

interface PageReactsResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
    /** विफलता पर शामिल। **/
    reason?: string
    /** प्रत्येक रिएक्शन आईडी के लिए संख्या, उदाहरण के लिए {"heart": 12, "laugh": 3}। पेज पर कोई रिएक्शन न होने पर सेट नहीं होता। **/
    counts?: Record<string, number>
    /** प्रत्येक रिएक्ट के लिए एक एंट्री, सबसे हालिया पहले। केवल तब सेट होता है जब includeUserInfo पास किया गया हो। **/
    users?: PageCustomReactUser[]
}
interface PageCustomReactUser {
    /** रिएक्शन आईडी, उदाहरण के लिए "heart"। **/
    reactId: string
    userId: string
    username: string
    displayName?: string
    avatarSrc?: string
}

उपयोगी सुझाव

urlId जैसे मानों को URI Encode करना न भूलें।

PATCH /api/v1/pages/:id

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

यह रूट एक सिंगल Page को अपडेट करने की सुविधा प्रदान करता है। संबंधित कमेंट्स भी अपडेट हो जाएंगे।

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

Page अपडेट रिक्वेस्ट संरचना

Copy

interface PagePatchQueryParams {
    tenantId: string
    API_KEY: string
}

Page अपडेट रिस्पॉन्स संरचना

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 ऑब्जेक्ट के कुछ पैरामीटर स्वचालित रूप से अपडेट हो जाते हैं। ये counts और title एट्रिब्यूट्स हैं। Counts को API के माध्यम से अपडेट नहीं किया जा सकता क्योंकि वे गणना किए गए मान हैं। पेज का title API के माध्यम से सेट किया जा सकता है, लेकिन यदि उसी urlId वाले पेज पर कमेंट विजेट का उपयोग किया जाता है और पेज का टाइटल अलग है, तो यह ओवरराइट हो जाएगा।

POST /api/v1/pages

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

यह API एंडपॉइंट पेज बनाने की क्षमता प्रदान करता है।

एक सामान्य उपयोग का मामला एक्सेस कंट्रोल है।

नोट्स:

यदि आपने किसी कमेंट थ्रेड पर कमेंट किया है, या Comment बनाने के लिए API को कॉल किया है, तो आप पहले से ही एक Page ऑब्जेक्ट बना चुके हैं! आप इसे /by-url-id Page रूट के माध्यम से फ़ेच करने का प्रयास कर सकते हैं, जिसमें कमेंट विजेट को दिया गया वही 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

यह रूट id द्वारा एकल पेज को हटाने की सुविधा प्रदान करता है।

ध्यान दें कि उसी urlId वाले पेज के लिए कमेंट विजेट के साथ इंटरैक्ट करने पर Page बिना किसी बाधा के सहजता से फिर से बन जाएगा।

पेज हटाने का cURL उदाहरण

Copy

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

पेज हटाने के रिक्वेस्ट की संरचना

Copy

interface PageDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

पेज हटाने के रिस्पॉन्स की संरचना

Copy

interface PageDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'page-does-not-exist'
    /** विफलता पर शामिल। **/
    reason?: string
}

POST /api/v1/pages/migrations

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

यह रूट कमेंट्स और पेजों को एक urlId या डोमेन से दूसरे में स्थानांतरित करता है, ठीक वैसे ही जैसे डैशबोर्ड में Domain Migration tool काम करता है। प्रति रिक्वेस्ट अधिकतम 100 माइग्रेशन भेजे जा सकते हैं। ये दिए गए क्रम में चलते हैं, इसलिए a से b के बाद b से c करना काम करता है।

प्रत्येक माइग्रेशन का एक type होता है:

urlId उस पेज को स्थानांतरित करता है जिसका urlId बिल्कुल from के बराबर हो। post-1, post-10 से मेल नहीं खाता।
domain हर urlId और url के अंदर from को खोजकर बदलता है, और प्रत्येक कमेंट का domain अपडेट करता है। दोनों मान एक डोमेन होने चाहिए, जैसे old.example.com।

कमेंट्स, पेज, पेज रिएक्ट्स, वोट्स, नोटिफिकेशन और सब्सक्रिप्शन — सब स्थानांतरित हो जाते हैं। यदि to पर पहले से कोई पेज मौजूद है, तो दोनों पेज मर्ज हो जाते हैं।

माइग्रेशन एक बैच जॉब के रूप में चलता है। रिस्पॉन्स में एक batchJobId होता है। इसकी प्रगति देखने के लिए GET /api/v1/batch-jobs/:id को पोल करें। जॉब पूरा होने पर प्रत्येक माइग्रेशन के लिए एक रिज़ल्ट और एक undoId होता है, जिसे आप 90 दिनों के भीतर POST /api/v1/pages/migrations/:undoId/undo को पास कर सकते हैं।

रिक्वेस्ट कतार में जोड़े जाने से पहले वैलिडेट की जाती है। यदि कोई भी माइग्रेशन अमान्य है, तो पूरी रिक्वेस्ट 422 के साथ विफल हो जाती है और कुछ भी नहीं चलता।

माइग्रेशन कतार में जोड़ने पर कुछ खर्च नहीं होता। जॉब पूरा होने पर प्रति 1000 माइग्रेट किए गए कमेंट्स पर 1 क्रेडिट खर्च होता है, न्यूनतम 1।

Page Migrations cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/pages/migrations?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
	"migrations": [
		{"from": "old-post-id", "to": "new-post-id", "type": "urlId"},
		{"from": "old.example.com", "to": "new.example.com", "type": "domain"}
	]
}'

Page Migrations रिक्वेस्ट संरचना

Copy

interface PageMigrationsQueryParams {
    tenantId: string
    API_KEY: string
}
interface PageMigrationsBody {
    /** दिए गए क्रम में चलते हैं। अधिकतम 100। **/
    migrations: PageMigration[]
}
interface PageMigration {
    /** अधिकतम 1000 वर्ण। शुरुआती और अंतिम व्हाइटस्पेस हटा दिया जाता है। **/
    from: string
    /** "from" से अलग होना चाहिए। अधिकतम 1000 वर्ण। **/
    to: string
    /** "urlId" केवल सटीक urlId से मेल खाता है। "domain" हर urlId और url के अंदर मान को खोजकर बदलता है। **/
    type: 'urlId' | 'domain'
}

Page Migrations रिस्पॉन्स संरचना

Copy

interface PageMigrationsResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-migrations' | 'too-many-migrations' | 'invalid-migration' | 'internal'
    /** विफलता पर शामिल। invalid-migration के लिए, यह पहले अमान्य माइग्रेशन का इंडेक्स बताता है। **/
    reason?: string
    /** प्रगति और रिज़ल्ट के लिए GET /api/v1/batch-jobs/:id को पास करें। **/
    batchJobId?: string
}

नोट्स

एक ही टेनेंट के जॉब्स एक समय में एक ही चलते हैं, सबसे पुराना पहले। दूसरा माइग्रेशन पहले के पूरा होने की प्रतीक्षा करता है।
नए urlId के साथ PATCH /api/v1/pages/:id केवल पेज को बदलता है, उसके कमेंट्स को नहीं। किसी पेज के कमेंट्स को स्थानांतरित करने के लिए इस रूट का उपयोग करें।

POST /api/v1/pages/migrations/:undoId/undo

Resource: Page Migrations as POST /api/v1/pages/migrations/:undoId/undo Credit Cost: 1

यह रूट एक POST /api/v1/pages/migrations जॉब से हुए हर माइग्रेशन को वापस ले लेता है। undoId पूरे हुए माइग्रेशन जॉब से GET /api/v1/batch-jobs/:id के ज़रिए प्राप्त करें। एक undoId का उपयोग 90 दिनों तक, और केवल एक बार किया जा सकता है।

अनडू एक बैच जॉब के रूप में चलता है, उसी तरह जैसे माइग्रेशन चलता है, और रिस्पॉन्स में उसका batchJobId होता है। जॉब पूरा होने पर, उसका pageMigrationUndoResult रिपोर्ट करता है:

restored: रिकॉर्ड्स जो माइग्रेशन से पहले की उनकी वैल्यू में वापस रख दिए गए।
skipped: रिकॉर्ड्स जिन्हें छोड़ दिया गया क्योंकि वे माइग्रेशन के बाद बदल गए थे, या अब मौजूद नहीं हैं। बाद में किया गया कोई एडिट कभी ओवरराइट नहीं होता।
notRestorable: रिकॉर्ड्स जिन्हें माइग्रेशन ने दो पेजों को मर्ज करते समय, या डुप्लिकेट पेज रिएक्ट्स हटाते समय डिलीट कर दिया था। इन्हें वापस लाया नहीं जा सकता।

माइग्रेशन सबसे नए वाले से पहले रिवर्स किए जाते हैं, इसलिए a से b और फिर b से c जैसी श्रृंखला वापस a तक अनवाउंड हो जाती है। बीच में विफल हुआ माइग्रेशन जॉब भी अनडू किया जा सकता है, जो विफल होने से पहले किए गए उसके बदलावों को रिवर्स कर देता है।

अनडू को क्यू में लगाने पर कुछ खर्च नहीं होता। जॉब पूरा होने पर प्रत्येक 1000 रिस्टोर किए गए रिकॉर्ड्स पर 1 क्रेडिट लगता है, न्यूनतम 1।

Undo Page Migrations cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/pages/migrations/my-undo-id/undo?tenantId=demo&API_KEY=DEMO_API_SECRET'

Undo Page Migrations रिक्वेस्ट स्ट्रक्चर

Copy

interface UndoPageMigrationsQueryParams {
    tenantId: string
    API_KEY: string
}

Undo Page Migrations रिस्पॉन्स स्ट्रक्चर

Copy

interface UndoPageMigrationsResponse {
    status: 'success' | 'failed'
    /**
     * विफलता पर शामिल।
     * undo-not-found (404): इस undoId वाला कोई माइग्रेशन नहीं है, या वह 90 दिनों से पुराना है।
     * already-undone (409) और undo-in-progress (409): माइग्रेशन अनडू किया जा चुका है, या उसका अनडू क्यू में है या चल रहा है।
     **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'undo-not-found' | 'already-undone' | 'undo-in-progress' | 'internal'
    /** विफलता पर शामिल। **/
    reason?: string
    /** प्रगति और परिणाम के लिए GET /api/v1/batch-jobs/:id में पास करें। **/
    batchJobId?: string
}

पोल संरचना

एक Poll किसी कमेंट से जुड़ा होता है, न कि अपने आप में एक अलग ऑब्जेक्ट होता है। यह कमेंट के साथ बनाया जाता है (POST /api/v1/comments देखें), या बाद में PUT /api/v1/polls/:commentId के ज़रिए किसी मौजूदा कमेंट में जोड़ा जाता है।

वोट की गिनती पोल पर ही रखी जाती है, इसलिए पोल पढ़ने पर आपको कुछ जोड़े बिना ही परिणाम मिल जाते हैं। इन गिनतियों के पीछे के अलग-अलग वोट PollVote ऑब्जेक्ट होते हैं।

प्रत्येक विकल्प का एक id होता है जो पोल बनाते समय जनरेट होता है। वही id आप वोट डालने के लिए, किसी विकल्प का लेबल बदलने के लिए, और पोल को PUT करते समय विकल्प जोड़ने या हटाने पर किसी विकल्प (और उसके वोटों) को बनाए रखने के लिए उपयोग करते हैं। किसी विकल्प को संदर्भित करने का यही एकमात्र सुरक्षित तरीका है - कभी भी सूची में उसकी स्थिति का उपयोग न करें।

पोल संरचना

Copy

interface CommentPollOption {
    id: string
    label: string
    votes: number
}
interface CommentPoll {
    question: string
    options: CommentPollOption[]
    totalVotes: number
    /** जब सेट हो और भूतकाल में हो, तो पोल बंद हो जाता है और अब वोट स्वीकार नहीं करता। **/
    closesAt?: string | null
    /** 0 गुमनाम (डिफ़ॉल्ट), 1 एडमिन और मॉडरेटर, 2 सभी। अनुपस्थित होने का अर्थ गुमनाम है। **/
    privacy?: 0 | 1 | 2 | null
    /** जब true हो, तो गिनती उन सभी से छिपी रहती है जिन्होंने अभी तक वोट नहीं दिया है। अनुपस्थित होने का अर्थ false है। **/
    requireVoteToSeeResults?: boolean | null
}

सीमाएँ

एक प्रश्न आवश्यक है, और अधिकतम 200 वर्णों का हो सकता है।
एक पोल में 2 से 10 विकल्प हो सकते हैं।
एक विकल्प का लेबल आवश्यक है, अधिकतम 100 वर्णों का हो सकता है, और पोल के भीतर अद्वितीय होना चाहिए (केस को अनदेखा करते हुए)।
closesAt पोल बनाते समय भविष्य की तारीख होनी चाहिए। किसी पोल को तुरंत बंद करने के लिए, उसे भूतकाल की तारीख के साथ PATCH करें।

साइट सेटिंग्स

पोल आपकी साइट कॉन्फ़िगरेशन का पालन करते हैं, जिसे आप Customize Widget के अंतर्गत बदल सकते हैं:

पोल बनाने से पहले पोल सक्षम होने चाहिए, अन्यथा API polls-disabled के साथ प्रतिक्रिया देता है।
वोटिंग केवल लॉग-इन उपयोगकर्ताओं तक सीमित की जा सकती है, जिस स्थिति में केवल anonUserId के साथ भेजा गया वोट poll-login-required के साथ अस्वीकार कर दिया जाता है।

GET /api/v1/polls/:commentId

Resource: Poll as GET /api/v1/polls/:commentId Credit Cost: 1

किसी कमेंट से जुड़े पोल को उसकी वर्तमान वोट संख्या के साथ पढ़ता है।

पोल कमेंट APIs द्वारा कमेंट पर ही भी लौटाए जाते हैं, इसलिए इसका उपयोग तब करें जब आप केवल परिणाम चाहते हों और पूरा कमेंट नहीं।

पोल प्राप्त करने का cURL उदाहरण

Copy

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

पोल प्राप्त करने की रिक्वेस्ट संरचना

Copy

interface PollGetQueryParams {
    tenantId: string
    API_KEY: string
}

पोल प्राप्त करने की रिस्पॉन्स संरचना

Copy

interface PollGetResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'poll-not-found'
    /** विफलता पर शामिल। **/
    reason?: string
    poll: CommentPoll
}

बिना पोल वाला कमेंट, डिलीट किया गया कमेंट, और कोई मौजूद न होने वाला कमेंट id — तीनों एक ही तरीके से poll-not-found के साथ प्रतिक्रिया देते हैं।

PUT /api/v1/polls/:commentId

Resource: Poll as PUT /api/v1/polls/:commentId Credit Cost: 1

किसी मौजूदा कमेंट पर एक पोल जोड़ता है, या उस पोल की पूरी स्थिति सेट करता है जो पहले से मौजूद है।

बॉडी पूरा पोल होता है, और आपके द्वारा भेजे गए विकल्प उसी क्रम में पोल के विकल्प बन जाते हैं। प्रत्येक विकल्प उसके id से मैच किया जाता है:

किसी मौजूदा विकल्प के id के साथ भेजा गया विकल्प उस विकल्प और उसके वोटों को बनाए रखता है। उसका लेबल और स्थान आपके द्वारा भेजे गए मानों में अपडेट हो जाता है।
बिना id के भेजा गया विकल्प जोड़ा जाता है, बिना किसी वोट के।
कोई मौजूदा विकल्प जिसे आप छोड़ देते हैं, वह हटा दिया जाता है, उस पर डाले गए वोटों सहित। totalVotes उतनी ही मात्रा से घट जाता है।

इसलिए एक विकल्प जोड़ने के लिए, मौजूदा विकल्पों को उनके ids के साथ भेजें और नए विकल्प को बिना id के भेजें। एक को हटाने के लिए, सूची उसे छोड़कर भेजें। विकल्प ids GET /api/v1/polls/:commentId द्वारा लौटाए गए पोल पर होते हैं।

बिल्कुल भी ids न भेजने पर हर विकल्प बदल जाता है और पोल पर पहले से डाले गए हर वोट को हटा दिया जाता है। यदि पोल पर वोट हैं, तो इसके लिए replaceVotes=true आवश्यक है, और इसके बिना API replace-votes-required के साथ प्रतिक्रिया देता है।

अन्य फ़ील्ड भी बदल दिए जाते हैं: closesAt, privacy या requireVoteToSeeResults को छोड़ने पर वे उनके डिफ़ॉल्ट पर रीसेट हो जाते हैं। केवल एक फ़ील्ड बदलने और बाकी को वैसे ही छोड़ने के लिए, PATCH /api/v1/polls/:commentId का उपयोग करें।

Poll Put cURL उदाहरण

Copy

curl --request PUT \
  --url 'https://fastcomments.com/api/v1/polls/comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
	"question": "Which release should we cut first?",
	"options": [
		{"id": "existing-option-id", "label": "The bugfix release"},
		{"label": "The feature release"}
	],
	"closesAt": "2026-12-31T00:00:00.000Z"
}'

Poll Put रिक्वेस्ट संरचना

Copy

interface PollPutQueryParams {
    tenantId: string
    API_KEY: string
    /** Required to keep none of the existing option ids when the poll has votes, since that deletes them all. **/
    replaceVotes?: boolean
}
interface PollPutOption {
    /** The id of an existing option, to keep it and its votes. Omit to add a new option. **/
    id?: string | null
    label: string
}
interface PollPutBody {
    question: string
    /** The complete, ordered list. Existing options left out are removed with their votes. **/
    options: PollPutOption[]
    /** Must be in the future when the comment has no poll yet. Omit for a poll that stays open. **/
    closesAt?: string | null
    /** 0 anonymous (the default), 1 admins and moderators, 2 everyone. **/
    privacy?: 0 | 1 | 2 | null
    requireVoteToSeeResults?: boolean | null
}

Poll Put रिस्पॉन्स संरचना

Copy

interface PollPutResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'polls-disabled' | 'poll-invalid' | 'replace-votes-required' | 'poll-privacy-locked' | 'locked'
    /** Included on failure. **/
    reason?: string
    poll: CommentPoll
}

अन्य नोट्स

ऐसा id जो पोल पर नहीं है, या एक ही id दो बार देना, poll-invalid के साथ विफल होता है। बिना पोल वाले कमेंट के पास अभी कोई विकल्प id नहीं होता, इसलिए उसे भेजे गए हर विकल्प में id छोड़ना होगा।
पोल की प्राइवेसी को संकुचित किया जा सकता है लेकिन वोट होने के बाद उसे बढ़ाया नहीं जा सकता।
यह API आपकी साइट सेटिंग्स का पालन करता है। यदि साइट या पेज के लिए पोल सक्षम नहीं हैं, तो यह polls-disabled के साथ विफल होता है।
लॉक किए गए कमेंट का पोल नहीं बदला जा सकता, और यह locked के साथ विफल होता है।
कनेक्टेड विजेट लाइव अपडेट होते हैं, इसलिए दर्शक रीलोड किए बिना नया पोल देख सकते हैं।

PATCH /api/v1/polls/:commentId

Resource: Poll as PATCH /api/v1/polls/:commentId Credit Cost: 1

वोट को बिना बाधित किए पोल को संपादित करता है। इसका उपयोग प्रश्न या किसी विकल्प में टाइपो ठीक करने, पोल को बंद या फिर से खोलने, या यह बदलने के लिए करें कि कौन देख सकता है कि किसने वोट दिया।

विकल्पों को उनके id से संबोधित किया जाता है, और PATCH उन विकल्पों का नाम बदल देता है जिन्हें आप नामित करते हैं। विकल्प जोड़ने, हटाने या क्रम बदलने के लिए, पूरी विकल्प सूची PUT /api/v1/polls/:commentId पर भेजें: जिन विकल्पों को आप उनकी ids के साथ भेजते हैं, वे वहीं अपने वोट बरकरार रखते हैं।

हर फ़ील्ड वैकल्पिक है, लेकिन कम से कम एक देना अनिवार्य है।

Poll Patch cURL उदाहरण

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/polls/comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
	"question": "Which release should we cut first?",
	"options": [{"id": "the-option-id", "label": "The bugfix release"}]
}'

पोल अभी बंद करें cURL उदाहरण

Copy

curl --request PATCH \
  --url 'https://fastcomments.com/api/v1/polls/comment-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
	"closesAt": "2020-01-01T00:00:00.000Z"
}'

Poll Patch अनुरोध संरचना

Copy

interface PollPatchQueryParams {
    tenantId: string
    API_KEY: string
}
interface PollPatchBody {
    question?: string | null
    /** मौजूदा विकल्पों का नाम बदलता है। दी गई हर id पोल पर पहले से मौजूद होनी चाहिए। **/
    options?: { id: string, label: string }[] | null
    /** अतीत की तारीख पोल को अभी बंद कर देती है। null बंद पोल को फिर से खोल देता है। **/
    closesAt?: string | null
    /** 0 अनाम, 1 एडमिन और मॉडरेटर, 2 सभी। **/
    privacy?: 0 | 1 | 2 | null
    requireVoteToSeeResults?: boolean | null
}

Poll Patch प्रतिक्रिया संरचना

Copy

interface PollPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'poll-not-found' | 'poll-invalid' | 'poll-privacy-locked' | 'locked'
    /** विफलता पर शामिल। **/
    reason?: string
    poll: CommentPoll
}

अन्य नोट्स

पोल पर मौजूद नहीं किसी विकल्प की id नामित करने पर चुपचाप कुछ न करने के बजाय poll-invalid के साथ विफल होता है।
लेबल पोल के भीतर अद्वितीय रहने चाहिए, जिन विकल्पों को आप नहीं बदल रहे हैं उन्हें भी गिनते हुए।
पोल बनाने के विपरीत, यहाँ closesAt अतीत में हो सकता है - इसी तरह आप पोल को तुरंत बंद करते हैं।
पोल की गोपनीयता को संकुचित किया जा सकता है लेकिन वोट होने के बाद बढ़ाया नहीं जा सकता।
लॉक किए गए कमेंट का पोल नहीं बदला जा सकता, और यह locked के साथ विफल होता है।

DELETE /api/v1/polls/:commentId

Resource: Poll as DELETE /api/v1/polls/:commentId Credit Cost: 1

किसी पोल को उसके कमेंट से हटा देता है, साथ ही उस पर डाले गए सभी वोट भी हटा देता है। कमेंट खुद वैसा ही रहता है।

कमेंट को डिलीट करने से भी उसका पोल और वोट हट जाते हैं, इसलिए यह केवल तब ज़रूरी है जब आप कमेंट को बनाए रखना चाहते हैं।

पोल डिलीट cURL उदाहरण

Copy

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

पोल डिलीट रिक्वेस्ट संरचना

Copy

interface PollDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

पोल डिलीट रिस्पॉन्स संरचना

Copy

interface PollDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'poll-not-found'
    /** विफलता पर शामिल। **/
    reason?: string
}

पोल वोट संरचना

एक PollVote किसी पोल पर एक व्यक्ति का उत्तर होता है। पोल पर दिखाए जाने वाले काउंट इनके साथ सिंक में रखे जाते हैं, इसलिए आपको ये केवल तब चाहिए जब आप यह जानना चाहें कि किसने किस विकल्प के लिए वोट दिया, न कि कुल संख्या।

एक वोटर का प्रति पोल अधिकतम एक वोट होता है। दोबारा वोट देने पर दूसरा वोट जोड़ने के बजाय उनका मौजूदा वोट नए विकल्प पर चला जाता है, और updatedAt यह रिकॉर्ड करता है कि वह कब हुआ।

voterId वह userId होता है जब वोटर लॉग इन था, अन्यथा वह anonUserId होता है।

PollVote संरचना

Copy

interface PollVote {
    id: string
    tenantId: string
    commentId: string
    urlId: string
    /** वोटर लॉग इन होने पर userId, अन्यथा anonUserId। **/
    voterId: string
    optionId: string
    createdAt: string
    /** जब वोटर ने अंतिम बार अपना वोट किसी अन्य विकल्प पर स्थानांतरित किया। **/
    updatedAt?: string
}

गोपनीयता

पोल की privacy सेटिंग इस API पर उसी तरह लागू होती है जिस तरह वह कमेंट विजेट में लागू होती है:

Anonymous (डिफ़ॉल्ट): कोई भी नहीं देख सकता कि किसी ने कैसे वोट दिया, इसलिए वोट पढ़े नहीं जा सकते। GET /api/v1/poll-votes और GET /api/v1/poll-votes/:id poll-anonymous के साथ प्रतिक्रिया देते हैं। पोल के काउंट अभी भी GET /api/v1/polls/:commentId से उपलब्ध हैं।
Admins और moderators: आपकी API key आपकी साइट के एडमिन की होती है, इसलिए यह वोट पढ़ सकती है।
Everyone: वोट पढ़े जा सकते हैं।

पोल की गोपनीयता वोट होने के बाद संकुचित की जा सकती है लेकिन बढ़ाई नहीं जा सकती।

GET /api/v1/poll-votes

Resource: PollVote as GET /api/v1/poll-votes Credit Cost: 1

एक पोल की गिनती के पीछे के व्यक्तिगत वोटों की सूची देता है, सबसे पुराने पहले। प्रत्येक 100 वोट लौटाने पर एक क्रेडिट।

एक पोल एक कमेंट से संबंधित होता है, इसलिए वोट एक समय में एक पोल के लिए पढ़े जाते हैं और commentId आवश्यक है। इसे और सीमित करें voterId से यह जांचने के लिए कि एक व्यक्ति ने कैसे वोट किया, या optionId से यह सूचीबद्ध करने के लिए कि किसने किसी दिए गए विकल्प को चुना।

प्रति कॉल अधिकतम 1000 वोट लौटाए जाते हैं। अधिक के लिए पेज करने के लिए skip का उपयोग करें।

पोल की privacy सेटिंग का सम्मान किया जाता है: गुमनाम पोल पर वोट नहीं पढ़े जा सकते, और अनुरोध poll-anonymous के साथ विफल हो जाता है। विवरण के लिए PollVote संरचना देखें।

PollVotes Get cURL उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/poll-votes?tenantId=demo&API_KEY=DEMO_API_SECRET&commentId=comment-id'

PollVotes Get अनुरोध संरचना

Copy

interface PollVotesGetQueryParams {
    tenantId: string
    API_KEY: string
    commentId: string
    voterId?: string
    optionId?: string
    skip?: number
}

PollVotes Get प्रतिक्रिया संरचना

Copy

interface PollVotesGetResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-comment-id' | 'poll-not-found' | 'poll-anonymous'
    /** विफलता पर शामिल। **/
    reason?: string
    pollVotes: PollVote[]
}

प्रति विकल्प वोट गिनना

परिणाम प्राप्त करने के लिए आपको इन्हें जोड़ने की आवश्यकता नहीं है - पोल अपनी गिनती रखता है। पोल को पढ़ें GET /api/v1/polls/:commentId से, और इस API का उपयोग तब करें जब आपको यह जानने की आवश्यकता हो कि किसने वोट किया।

एक पेज पर हर पोल

पूरे पेज की वोट सूची नहीं है। पूरे पेज पर रिपोर्ट करने के लिए, उसके कमेंट्स प्राप्त करें GET /api/v1/comments से, जो प्रत्येक कमेंट का पोल और उसकी गिनती लौटाता है, और फिर उन पोल्स के वोट पढ़ें जिनमें आपकी रुचि है।

GET /api/v1/poll-votes/:id

Resource: PollVote as GET /api/v1/poll-votes/:id Credit Cost: 1

अपनी id द्वारा एकल पोल वोट पढ़ता है।

गुमनाम पोल पर दिया गया वोट नहीं पढ़ा जा सकता, और अनुरोध poll-anonymous के साथ विफल हो जाता है। पोल की privacy सेटिंग कैसे लागू होती है, यह देखने के लिए PollVote संरचना देखें।

PollVote Get cURL उदाहरण

Copy

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

PollVote Get अनुरोध संरचना

Copy

interface PollVoteGetQueryParams {
    tenantId: string
    API_KEY: string
}

PollVote Get प्रतिक्रिया संरचना

Copy

interface PollVoteGetResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found' | 'poll-not-found' | 'poll-anonymous'
    /** विफलता पर शामिल। **/
    reason?: string
    pollVote: PollVote
}

POST /api/v1/poll-votes

Resource: PollVote as POST /api/v1/poll-votes Credit Cost: 1

पोल पर एक वोट रिकॉर्ड करता है।

एक वोटर के पास प्रति पोल अधिकतम एक वोट होता है। उसी वोटर के लिए इसे दोबारा कॉल करने पर दूसरा वोट जोड़ने के बजाय उनका वोट नए विकल्प पर चला जाता है, और उसी विकल्प के लिए वोट करने पर कुछ नहीं होता।

प्रतिक्रिया में पोल शामिल होता है, इसलिए आपको दूसरा अनुरोध किए बिना अपडेट की गई गिनती मिल जाती है।

PollVote Create cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/poll-votes?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
	"commentId": "comment-id",
	"optionId": "the-option-id",
	"userId": "user-id"
}'

Anonymous PollVote Create cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/poll-votes?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
	"commentId": "comment-id",
	"optionId": "the-option-id",
	"anonUserId": "some-randomly-generated-identifier",
	"ip": "203.0.113.4"
}'

PollVote Create अनुरोध संरचना

Copy

interface PollVoteCreateQueryParams {
    tenantId: string
    API_KEY: string
}
interface PollVoteCreateBody {
    commentId: string
    optionId: string
    /** userId या anonUserId में से एक आवश्यक है। **/
    userId?: string
    anonUserId?: string
    /** अंतिम उपयोगकर्ता का IP, जो गुमनाम रेट लिमिट के लिए उपयोग होता है। डिफ़ॉल्ट रूप से कॉलर का IP। **/
    ip?: string
}

PollVote Create प्रतिक्रिया संरचना

Copy

interface PollVoteCreateResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-comment-id' | 'missing-user-id' | 'invalid-user' | 'unauthorized' | 'poll-not-found' | 'poll-invalid-option' | 'poll-closed' | 'poll-login-required' | 'rate-limited'
    /** विफलता पर शामिल। **/
    reason?: string
    pollVote: PollVote
    /** अपडेट की गई गिनती के साथ पोल। **/
    poll: CommentPoll
}

गुमनाम वोट

userId के स्थान पर anonUserId सेट करें ताकि किसी ऐसे व्यक्ति के लिए वोट रिकॉर्ड किया जा सके जो लॉग इन नहीं है। वह आईडी कहीं भी किसी उपयोगकर्ता से मेल खाना ज़रूरी नहीं है - यह केवल सत्र की पहचान करता है, ताकि एक ही व्यक्ति दो बार गिना न जाए।

गुमनाम वोटिंग आपकी साइट के लिए सक्षम होनी चाहिए। यदि वोटिंग केवल लॉग इन उपयोगकर्ताओं तक सीमित है, तो केवल anonUserId वाला वोट poll-login-required के साथ विफल हो जाता है।

गुमनाम वोट भी प्रति IP प्रति पोल रेट सीमित होते हैं, ताकि कोई व्यक्ति अपना सत्र साफ़ करके पोल को भर न सके। अंतिम उपयोगकर्ता का ip भेजें ताकि वह सीमा आपके सर्वर के बजाय उस पर लागू हो।

अन्य नोट्स

userId आपकी साइट पर मौजूद किसी उपयोगकर्ता का होना चाहिए। दूसरी साइट के उपयोगकर्ता के लिए वोट अस्वीकार कर दिए जाते हैं।
बंद पोल पर वोट करना poll-closed के साथ विफल हो जाता है।
यह API पोल पर गिनती अपडेट करता है और उन्हें कनेक्टेड विजेट्स पर लाइव भेजता है।

DELETE /api/v1/poll-votes/:id

Resource: PollVote as DELETE /api/v1/poll-votes/:id Credit Cost: 1

एक वोट वापस लेता है। जिस विकल्प पर वोट दिया गया था वह अपनी गिनती वापस प्राप्त कर लेता है, और मतदाता दोबारा वोट देने के लिए स्वतंत्र होता है।

PollVote Delete cURL उदाहरण

Copy

curl --request DELETE \
  --url 'https://fastcomments.com/api/v1/poll-votes/my-id?tenantId=demo&API_KEY=DEMO_API_SECRET'

PollVote Delete अनुरोध संरचना

Copy

interface PollVoteDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

PollVote Delete प्रतिक्रिया संरचना

Copy

interface PollVoteDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'poll-not-found'
    /** विफलता पर शामिल। **/
    reason?: string
    /** अपडेट की गई गिनती के साथ पोल। **/
    poll: CommentPoll
}

अन्य नोट्स

एक ही वोट को दो बार डिलीट करने पर दूसरी बार not-found प्रतिक्रिया मिलती है, और गिनती में कोई बदलाव नहीं होता।
यदि वोट देने के बाद पोल बदल दिया गया है, तो वोट हटा दिया जाता है लेकिन गिनती में कोई बदलाव नहीं होता, क्योंकि बदले गए पोल की गिनती शून्य से शुरू होती है।

PendingWebhookEvent संरचना

एक PendingWebhookEvent ऑब्जेक्ट एक कतार में लंबित (pending) वेबहुक इवेंट का प्रतिनिधित्व करता है।

PendingWebhookEvent ऑब्जेक्ट स्वचालित रूप से बनाए जाते हैं और इन्हें API के माध्यम से मैन्युअल रूप से नहीं बनाया जा सकता। ये एक वर्ष के बाद समाप्त (expire) भी हो जाते हैं। इन्हें डिलीट किया जा सकता है, जिससे यह कार्य कतार से हट जाता है।

अलग-अलग इवेंट प्रकार होते हैं - 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
    /** इवेंट से जुड़ी कमेंट की id। **/
    commentId: string
    /** इवेंट के समय इवेंट के लिए कमेंट ऑब्जेक्ट। हमने इन्हें नवंबर 2023 से जोड़ना शुरू किया। **/
    comment: Comment
    /** एक बाहरी id जो कमेंट से जुड़ी हो सकती है। **/
    externalId: string | null
    createdAt: Date
    tenantId: string
    attemptCount: number
    /** पहले प्रयास से पहले, और हर विफलता के बाद सेट होता है। **/
    nextAttemptAt: Date
    /** क्या यह निर्माण, डिलीशन, या अपडेट इवेंट है... **/
    eventType: OutboundSyncEventType
    /** करने के लिए सिंक का प्रकार (WordPress, API कॉल, आदि)। **/
    type: OutboundSyncType
    /** वह डोमेन जो कमेंट से मेल खाया। हम इस डोमेन का उपयोग API कुंजी चुनने के लिए करते हैं। **/
    domain: string
    /** हुई अंतिम त्रुटि। यह प्रकार अनटाइप्ड है और जो कुछ हुआ उसका एक "डंप" है। आमतौर पर इसमें statusCode, body, और एक headers मैप के साथ एक ऑब्जेक्ट होता है। **/
    lastError: object | null
}

GET /api/v1/pending-webhook-events

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

यह रूट pendingWebhookEvents पैरामीटर के अंतर्गत लंबित वेबहुक इवेंट्स की एक सूची लौटाता है।

यह API skip पैरामीटर द्वारा प्रदान किए गए पेजिनेशन का उपयोग करता है। PendingWebhookEvents 100 के पृष्ठों में लौटाए जाते हैं, जो createdAt के अनुसार नवीनतम पहले क्रम में होते हैं।

PendingWebhookEvent cURL उदाहरण

Copy

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

PendingWebhookEvent रिक्वेस्ट संरचना

Copy

interface PendingWebhookEventsGetQueryParams {
    tenantId: string
    API_KEY: string
    commentId?: string
    externalId?: string
    eventType?: OutboundSyncEventType
    type?: OutboundSyncType
    domain?: string
    /** निर्दिष्ट संख्या से अधिक प्रयास संख्या वाले इवेंट्स के लिए क्वेरी। **/
    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

यह रूट एक ऑब्जेक्ट लौटाता है जिसमें count पैरामीटर के अंतर्गत लंबित वेबहुक इवेंट्स की संख्या होती है।

आप /pending-webhook-events एंडपॉइंट के समान पैरामीटर्स से फ़िल्टर कर सकते हैं।

PendingWebhookEvent Count cURL उदाहरण

Copy

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

PendingWebhookEvent Count रिक्वेस्ट संरचना

Copy

interface PendingWebhookEventsCountQueryParams {
    tenantId: string
    API_KEY: string
    commentId?: string
    externalId?: string
    eventType?: OutboundSyncEventType
    type?: OutboundSyncType
    domain?: string
    /** निर्दिष्ट संख्या से अधिक प्रयास संख्या वाले इवेंट्स के लिए क्वेरी। **/
    attemptCountGT?: number
}

PendingWebhookEvent Count रिस्पॉन्स संरचना

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

यह रूट एक सिंगल PendingWebhookEvent को डिलीट करने की अनुमति देता है।

यदि आपको बल्क डिलीट करने की आवश्यकता है, तो GET API को पेजिनेशन के साथ कॉल करें और फिर इस API को क्रमिक रूप से कॉल करें।

PendingWebhookEvent डिलीट करने का cURL उदाहरण

Copy

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

PendingWebhookEvent डिलीट रिक्वेस्ट संरचना

Copy

interface PendingWebhookEventDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

PendingWebhookEvent डिलीट रिस्पॉन्स संरचना

Copy

interface PendingWebhookEventDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
}

SSO उपयोगकर्ता संरचना

FastComments एक उपयोग में आसान SSO समाधान प्रदान करता है। HMAC-आधारित इंटीग्रेशन के साथ उपयोगकर्ता की जानकारी अपडेट करना उतना ही सरल है जितना उपयोगकर्ता को अपडेटेड पेलोड के साथ पेज लोड करवाना।

हालाँकि, अपने एप्लिकेशन की निरंतरता (consistency) सुधारने के लिए उस फ्लो के बाहर उपयोगकर्ता को प्रबंधित करना वांछनीय हो सकता है।

SSO User API उन ऑब्जेक्ट्स को CRUD करने का एक तरीका प्रदान करती है जिन्हें हम SSOUsers कहते हैं। ये ऑब्जेक्ट्स सामान्य Users से अलग होते हैं और टाइप सेफ्टी के लिए अलग रखे जाते हैं।

SSOUser ऑब्जेक्ट की संरचना इस प्रकार है:

SSOUser संरचना

Copy

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

SSO उपयोगकर्ताओं के लिए बिलिंग

SSO उपयोगकर्ताओं की बिलिंग उनके परमिशन फ्लैग्स के आधार पर अलग-अलग होती है:

सामान्य SSO उपयोगकर्ता: बिना एडमिन या मॉडरेटर परमिशन वाले उपयोगकर्ता सामान्य SSO उपयोगकर्ताओं के रूप में बिल किए जाते हैं
SSO एडमिन: isAccountOwner या isAdminAdmin फ्लैग्स वाले उपयोगकर्ता SSO एडमिन के रूप में अलग से बिल किए जाते हैं (सामान्य टेनेंट एडमिन के समान दर पर)
SSO मॉडरेटर: isCommentModeratorAdmin फ्लैग वाले उपयोगकर्ता SSO मॉडरेटर के रूप में अलग से बिल किए जाते हैं (सामान्य मॉडरेटर के समान दर पर)

महत्वपूर्ण: दोहरी बिलिंग रोकने के लिए, सिस्टम ईमेल पते के आधार पर SSO उपयोगकर्ताओं को सामान्य टेनेंट उपयोगकर्ताओं और मॉडरेटर्स के विरुद्ध स्वचालित रूप से डीडुप्लिकेट करता है। यदि किसी SSO उपयोगकर्ता का ईमेल किसी सामान्य टेनेंट उपयोगकर्ता या मॉडरेटर के समान है, तो उनसे दो बार बिल नहीं किया जाएगा।

एक्सेस कंट्रोल

उपयोगकर्ताओं को समूहों में विभाजित किया जा सकता है। groupIds फ़ील्ड इसी काम के लिए है, और यह वैकल्पिक (optional) है।

@Mentions

डिफ़ॉल्ट रूप से, जब @ कैरेक्टर टाइप किया जाता है तो @mentions अन्य SSO उपयोगकर्ताओं को खोजने के लिए username का उपयोग करेगा। यदि displayName का उपयोग किया जाता है, तो जब displayName के लिए मैच होता है, username से मैच होने वाले परिणामों को अनदेखा कर दिया जाएगा, और @mention खोज परिणाम displayName का उपयोग करेंगे।

सब्सक्रिप्शन

FastComments के साथ, उपयोगकर्ता कमेंट विजेट में घंटी आइकन पर क्लिक करके और Subscribe पर क्लिक करके किसी पेज की सदस्यता ले सकते हैं।

सामान्य उपयोगकर्ता के साथ, हम उन्हें उनकी नोटिफिकेशन सेटिंग्स के आधार पर नोटिफिकेशन ईमेल भेजते हैं।

SSO उपयोगकर्ताओं के साथ, हम इसे पिछली संगतता (backwards compatibility) के लिए विभाजित करते हैं। उपयोगकर्ताओं को ये अतिरिक्त सब्सक्रिप्शन नोटिफिकेशन ईमेल तभी भेजे जाएंगे जब आप optedInSubscriptionNotifications को true पर सेट करें।

बैज

आप badgeConfig प्रॉपर्टी का उपयोग करके SSO उपयोगकर्ताओं को बैज असाइन कर सकते हैं। बैज विज़ुअल इंडिकेटर होते हैं जो कमेंट्स में उपयोगकर्ता के नाम के बगल में दिखाई देते हैं।

badgeIds - उपयोगकर्ता को असाइन करने के लिए बैज ID की एक सरणी। ये सभी पेजों पर दिखाई देने वाले ग्लोबल बैज हैं। आपके FastComments खाते में बनाई गई वैध बैज ID होनी चाहिए। अधिकतम 30 बैज।
pageBadgeIds - वर्तमान पेज (urlId) तक सीमित बैज ID की एक वैकल्पिक सरणी। ये बैज केवल उस पेज पर प्रदर्शित होते हैं जहाँ उन्हें असाइन किया गया था। एक ही उपयोगकर्ता के लिए अलग-अलग पेजों पर अलग-अलग पेज-स्कोप्ड बैज हो सकते हैं।
override - यदि true है, तो सभी मौजूदा प्रदर्शित बैज प्रदान किए गए बैजों से बदल दिए जाएंगे। ग्लोबल और पेज-स्कोप्ड बैज स्वतंत्र रूप से ओवरराइड किए जाते हैं — ग्लोबल बैज को ओवरराइड करना पेज-स्कोप्ड बैज को प्रभावित नहीं करता, और इसके विपरीत भी। यदि false या छोड़ा गया हो, तो प्रदान किए गए बैज किसी भी मौजूदा बैज में जोड़ दिए जाएंगे।
update - यदि true है, तो जब भी उपयोगकर्ता लॉग इन करेगा, बैज डिस्प्ले प्रॉपर्टीज़ टेनेंट कॉन्फ़िगरेशन से अपडेट कर दी जाएंगी।

GET /api/v1/sso-users

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

यह रूट SSO यूज़र्स को 100 के पेजों में लौटाता है। पेजिनेशन skip पैरामीटर द्वारा प्रदान की जाती है। यूज़र्स को उनके signUpDate और id के अनुसार सॉर्ट किया जाता है।

SSOUsers cURL उदाहरण

Copy

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

SSOUsers रिक्वेस्ट संरचना

Copy

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

SSOUsers रिस्पॉन्स संरचना

Copy

interface SSOUsersResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** विफलता पर शामिल। **/
    reason?: string
    users: SSOUser[]
}

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

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

यह रूट उनके id द्वारा एकल SSO यूज़र लौटाता है।

SSOUser By ID cURL उदाहरण

Copy

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

SSOUser रिक्वेस्ट संरचना

Copy

interface SSOUserRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

SSOUser रिस्पॉन्स संरचना

Copy

interface SSOUserByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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

यह रूट ईमेल के आधार पर एक SSO यूज़र लौटाता है।

ईमेल द्वारा SSOUser cURL उदाहरण

Copy

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

SSOUser रिक्वेस्ट संरचना

Copy

interface SSOUserRequestByEmailQueryParams {
    tenantId: string
    API_KEY: string
}

SSOUser रिस्पॉन्स संरचना

Copy

interface SSOUserByEmailResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-email' | 'user-does-not-exist'
    /** विफलता पर शामिल। **/
    reason?: string
    user: SSOUser
}

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

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

यह रूट एकल SSO यूज़र को अपडेट करने की क्षमता प्रदान करता है।

SSOUser अपडेट cURL उदाहरण

Copy

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

SSOUser अपडेट रिक्वेस्ट संरचना

Copy

interface SSOUserPatchQueryParams {
    tenantId: string
    API_KEY: string
    /** जब email या username बदला जाता है, तो आप यूज़र की कमेंट्स को भी अपडेट करने के लिए इसे true सेट कर सकते हैं। इससे क्रेडिट लागत दोगुनी हो जाएगी। **/
    updateComments: 'true' | 'false'
}

SSOUser अपडेट रिस्पॉन्स संरचना

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

यह रूट एक सिंगल SSO यूज़र के निर्माण की सुविधा देता है।

समान ID वाले दो यूज़र बनाने की कोशिश करने पर त्रुटि (error) मिलेगी।

SSOUser निर्माण cURL उदाहरण

Copy

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

इस उदाहरण में हम एक्सेस कंट्रोल के लिए groupIds निर्दिष्ट करते हैं, लेकिन यह वैकल्पिक (optional) है।

SSOUser निर्माण रिक्वेस्ट संरचना

Copy

interface SSOUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

SSOUser निर्माण रिस्पॉन्स संरचना

Copy

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

इंटीग्रेशन नोट

API द्वारा पास किया गया डेटा केवल एक अलग SSO User HMAC पेलोड पास करके ओवरराइड किया जा सकता है। उदाहरण के लिए, यदि आप API के माध्यम से एक username सेट करते हैं, लेकिन फिर पेज लोड पर SSO फ्लो के माध्यम से एक अलग username पास करते हैं, तो हम उनका username स्वचालित रूप से अपडेट कर देंगे।

हम इस फ्लो में यूज़र पैरामीटर अपडेट नहीं करेंगे जब तक कि आप उन्हें स्पष्ट रूप से निर्दिष्ट न करें या उन्हें null (undefined नहीं) पर सेट न करें।

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

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

यह रूट एक सिंगल SSO यूज़र को अपडेट करने की सुविधा प्रदान करता है।

SSOUser अपडेट cURL उदाहरण

Copy

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

इस उदाहरण में हम एक्सेस कंट्रोल के लिए groupIds निर्दिष्ट करते हैं, लेकिन यह वैकल्पिक है।

SSOUser अपडेट रिक्वेस्ट संरचना

Copy

interface SSOUserPutQueryParams {
    tenantId: string
    API_KEY: string
    /** जब email या username बदला जाता है, तो आप इसे true सेट करके यूज़र की कमेंट्स को भी अपडेट कर सकते हैं। इससे क्रेडिट लागत दोगुनी हो जाएगी। **/
    updateComments: 'true' | 'false'
}

SSOUser अपडेट रिस्पॉन्स संरचना

Copy

interface SSOUserPutResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
    /** विफलता पर शामिल। **/
    reason?: string
    user?: SSOUser; // सफलता पर हम अपडेट किया गया यूज़र लौटाते हैं।
}

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

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

यह रूट एक SSO यूज़र को उनकी id के आधार पर हटाने की सुविधा प्रदान करता है।

ध्यान दें कि इस यूज़र के लिए पेलोड के साथ कमेंट विजेट को दोबारा लोड करने पर यूज़र बिना किसी बाधा के आसानी से फिर से बन जाएगा।

deleteComments क्वेरी पैरामीटर के माध्यम से यूज़र के कमेंट्स को हटाना संभव है। ध्यान दें कि यदि यह true है:

यूज़र के सभी कमेंट्स लाइव हटा दिए जाएंगे।
सभी child (अब अनाथ) कमेंट्स प्रत्येक कमेंट से जुड़े पेज कॉन्फ़िगरेशन के आधार पर हटा दिए जाएंगे या गुमनाम (anonymize) कर दिए जाएंगे। उदाहरण के लिए यदि थ्रेड डिलीशन मोड "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 का उपयोग करेगा। इन्हें Widget Customization UI के माध्यम से कस्टमाइज़ किया जा सकता है।

उदाहरण

SSOUser हटाने का cURL उदाहरण

Copy

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

SSOUser हटाने की रिक्वेस्ट संरचना

Copy

enum SSOUserCommentDeleteMode {
    Remove = 0, // डिफ़ॉल्ट
    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) को दर्शाता है।

Subscription ऑब्जेक्ट तब बनाए जाते हैं जब कोई उपयोगकर्ता कमेंट विजेट में नोटिफिकेशन बेल पर क्लिक करता है और "Subscribe to this page" पर क्लिक करता है।

सदस्यताएँ API के माध्यम से भी बनाई जा सकती हैं।

एक Subscription ऑब्जेक्ट होने से, संबंधित पेज के रूट पर नए कमेंट छोड़े जाने पर, उस Subscription के लिए Notification ऑब्जेक्ट बनते हैं और ईमेल भेजे जाते हैं। ईमेल भेजना उपयोगकर्ता के प्रकार पर निर्भर करता है। सामान्य उपयोगकर्ताओं के लिए यह optedInNotifications पर निर्भर करता है। SSO उपयोगकर्ताओं के लिए यह optedInSubscriptionNotifications पर निर्भर करता है। ध्यान दें कि कुछ एप्लिकेशन में वेब-एक्सेसिबल पेज की अवधारणा नहीं हो सकती, ऐसे में बस urlId को उस आइटम की id पर सेट करें जिसकी आप सदस्यता ले रहे हैं (कमेंट विजेट को जो urlId पास करेंगे, वही मान)।

Subscription ऑब्जेक्ट की संरचना इस प्रकार है:

Subscription संरचना

Copy

interface Subscription {
    id: string
    tenantId: string
    /** SSO के साथ, user id का फॉर्मैट `<tenant id>:<user id>` होता है। **/
    userId: string
    anonUserId?: string
    urlId: string
    url?: string
    pageTitle?: string
    createdAt: string // date string
}

GET /api/v1/subscriptions/:id

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

यह रूट createdAt के अनुसार क्रमबद्ध, नवीनतम पहले, अधिकतम 30 Subscription ऑब्जेक्ट लौटाता है।

यूज़र के लिए सब्सक्रिप्शन 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

यह API एंडपॉइंट एक Subscription बनाने की क्षमता प्रदान करता है। ध्यान दें कि एक उपयोगकर्ता के पास प्रति पेज केवल एक सब्सक्रिप्शन हो सकता है, क्योंकि अधिक होना निरर्थक है, और उसी उपयोगकर्ता के लिए उसी पेज पर एक से अधिक सब्सक्रिप्शन बनाने की कोशिश करने पर त्रुटि होगी।

सब्सक्रिप्शन बनाने पर, सब्सक्राइब किए गए urlId के रूट पर नया कमेंट आने पर (जब कमेंट का parentId null हो) Notification ऑब्जेक्ट्स बनाए जाएंगे।

Subscription POST cURL उदाहरण

Copy

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

Subscription POST रिक्वेस्ट संरचना

Copy

interface SubscriptionPostQueryParams {
    tenantId: string
    API_KEY: string
}

Subscription POST रिस्पॉन्स संरचना

Copy

interface SubscriptionPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';  
    /** विफलता पर शामिल। **/
    reason?: string
}

DELETE /api/v1/subscriptions/:id

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

यह रूट id द्वारा एकल Subscription ऑब्जेक्ट को डिलीट करता है।

Subscription हटाने का cURL उदाहरण

Copy

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

Subscription हटाने की Request Structure

Copy

interface SubscriptionsDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Subscription हटाने की Response Structure

Copy

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

TenantDailyUsage संरचना

एक TenantDailyUsage ऑब्जेक्ट किसी टेनेंट के लिए किसी दिए गए दिन के उपयोग को दर्शाता है। यदि किसी दिए गए दिन में किसी टेनेंट की कोई गतिविधि नहीं थी, तो उस दिन के लिए कोई TenantDailyUsage ऑब्जेक्ट नहीं होगा।

TenantDailyUsage ऑब्जेक्ट रीयल टाइम नहीं है और वास्तविक उपयोग से कुछ मिनट पीछे हो सकता है।

TenantDailyUsage ऑब्जेक्ट की संरचना इस प्रकार है:

TenantDailyUsage संरचना

Copy

export interface TenantDailyUsage {
    yearNumber: number
    monthNumber: number
    dayNumber: number
    commentFetchCount?: number
    commentCreateCount?: number
    conversationCreateCount?: number
    voteCount?: number
    accountCreatedCount?: number
    userMentionSearch?: number
    hashTagSearch?: number
    gifSearchTrending?: number
    gifSearch?: number
    apiCreditsUsed?: number
    createdAt: string
    billed: boolean
    /** बिलिंग के लिए अनदेखा। **/
    ignored: boolean
}

GET /api/v1/tenant-daily-usage

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

यह रूट किसी टेनेंट के उपयोग को वर्ष, माह और दिन के आधार पर खोजने की सुविधा देता है। अधिकतम 365 ऑब्जेक्ट लौटाए जा सकते हैं, और लागत प्रति 10 ऑब्जेक्ट पर 1 API क्रेडिट है।

रिस्पॉन्स ऑब्जेक्ट उनकी निर्माण तिथि के अनुसार क्रमबद्ध होते हैं (सबसे पुराना पहले)।

TenantDailyUsage खोज cURL उदाहरण

Copy

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

TenantDailyUsage रिक्वेस्ट संरचना

Copy

interface TenantDailyUsageQueryParams {
    tenantId: string
    API_KEY: string
    /** UTC के आधार पर। **/
    yearNumber?: number
    /** शून्य-आधारित। UTC के आधार पर। **/
    monthNumber?: number
    /** एक-आधारित। UTC के आधार पर। **/
    dayNumber?: number
}

TenantDailyUsage रिस्पॉन्स संरचना

Copy

interface TenantDailyUsageResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
    tenantDailyUsages: TenantDailyUsage[]
}

टेनेंट संरचना

Tenant एक FastComments.com ग्राहक (customer) को परिभाषित करता है। इन्हें API के माध्यम से उन tenants द्वारा बनाया जा सकता है जिनके पास white labeling एक्सेस है। White labeled tenants अन्य white labeled tenants नहीं बना सकते (केवल एक स्तर की nesting की अनुमति है)।

Tenant ऑब्जेक्ट की संरचना इस प्रकार है:

Tenant संरचना

Copy

export enum SiteType {
    Unknown = 0,
    WordPress = 1
}
/** इसे DomainConfig API के माध्यम से भी संभाला जा सकता है। **/
export interface TenantDomainConfig {
    domain: string
    emailFromName?: string
    emailFromEmail?: string
    createdAt?: string,
    siteType?: FastCommentsSiteType, // आप शायद Unknown चाहेंगे
    logoSrc?: string, // रॉ इमेज पाथ
    logoSrc100px?: string, // थंबनेल के लिए रिसाइज़ किया गया
    footerUnsubscribeURL?: string,
    emailHeaders?: Record<string, string>,
    disableUnsubscribeLinks?: boolean,
    dkim?: {
        domainName: string,
        keySelector: string,
        privateKey: string
    }
}
export interface TenantBillingInfo {
    name: string
    address: string
    city: string
    state: string
    zip: string
    country: string
}
export enum TenantPaymentFrequency {
    Monthly = 0,
    Annually = 1
}
export interface Tenant {
    id: string
    name: string
    email?: string
    signUpDate: number; // "legacy" कारणों से number
    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
    /** आप tenant के साथ एक key value pair स्टोर कर सकते हैं जिसका उपयोग आप क्वेरी के लिए कर सकते हैं। Keys में "." या "$" नहीं हो सकता, और 100 वर्णों से लंबा नहीं हो सकता। Values 2k वर्णों से लंबी नहीं हो सकतीं। **/
    meta?: Record<string, string | null>
}

GET /api/v1/tenants/:id

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

यह रूट id द्वारा एकल Tenant लौटाता है।

ID द्वारा Tenant cURL उदाहरण

Copy

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

Tenant रिक्वेस्ट संरचना

Copy

interface TenantByIdQueryParams {
    tenantId: string
    API_KEY: string
}

Tenant रिस्पॉन्स संरचना

Copy

interface TenantByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** विफलता पर शामिल। **/
    reason?: string
    tenant?: Tenant
}

GET /api/v1/tenants

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

यह API उन tenants को लौटाती है जो आपके tenant द्वारा प्रबंधित हैं।

पेजिनेशन skip क्वेरी पैरामीटर द्वारा प्रदान की जाती है। Tenants 100 के पेजों में लौटाए जाते हैं, जो signUpDate और id के अनुसार क्रमबद्ध होते हैं।

लागत लौटाए गए tenants की संख्या पर आधारित है, जो 1 credit per 10 लौटाए गए tenants के अनुसार है।

Tenant cURL उदाहरण

Copy

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

आप Tenant ऑब्जेक्ट्स पर meta पैरामीटर परिभाषित कर सकते हैं और मेल खाते tenants के लिए क्वेरी कर सकते हैं। उदाहरण के लिए, कुंजी someKey और meta मान some-value के लिए, हम इस कुंजी/मान जोड़ी के साथ एक JSON ऑब्जेक्ट बना सकते हैं और फिर इसे फ़िल्टर करने के लिए एक क्वेरी पैरामीटर के रूप में URI एनकोड कर सकते हैं:

Meta द्वारा Tenant क्वेरी cURL उदाहरण

Copy

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

Tenant अनुरोध संरचना

Copy

interface TenantsRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** पेजिनेशन के लिए छोड़े जाने वाले 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 के सभी tenants में अद्वितीय होना चाहिए।
यदि पैरेंट tenant के पास मान्य TenantPackage परिभाषित नहीं है, तो आप tenants नहीं बना सकते।
- यदि आपका tenant FastComments.com के माध्यम से बनाया गया था, तो यह कोई समस्या नहीं होनी चाहिए।
आप अपने पैकेज में maxWhiteLabeledTenants के अंतर्गत परिभाषित से अधिक tenants नहीं बना सकते।
आपको tenantId क्वेरी पैरामीटर निर्दिष्ट करना होगा, जो आपके white labeling सक्षम parent tenant की id है।

हम कुछ ही पैरामीटर के साथ एक Tenant बना सकते हैं:

Tenant बनाने का cURL उदाहरण

Copy

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

Tenant Create Request Structure

Copy

interface TenantPostQueryParams {
    tenantId: string
    API_KEY: string
}

Tenant Create Response Structure

Copy

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

PATCH /api/v1/tenants/:id

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

यह API एंडपॉइंट id द्वारा एक Tenant को अपडेट करने की क्षमता प्रदान करता है।

एक Tenant को अपडेट करने की निम्नलिखित सीमाएँ हैं:

निम्नलिखित मान अपडेट नहीं किए जा सकते:
- hasFlexPricing
- lastBillingIssueReminderDate
- flexLastBilledAmount
- managedByTenantId
signUpDate भविष्य में नहीं हो सकता।
name 200 characters से लंबा नहीं हो सकता।
email 300 characters से लंबा नहीं हो सकता।
email FastComments.com के सभी tenants में अद्वितीय होना चाहिए।
billingInfoValid को true पर सेट करते समय, उसी अनुरोध में billingInfo प्रदान किया जाना चाहिए।
आप अपने स्वयं के tenant से जुड़े packageId को अपडेट नहीं कर सकते।
आप अपने स्वयं के tenant से जुड़े paymentFrequency को अपडेट नहीं कर सकते।

Tenant PATCH cURL उदाहरण

Copy

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

Tenant PATCH अनुरोध संरचना

Copy

interface TenantPatchQueryParams {
    tenantId: string
    API_KEY: string
}

Tenant PATCH प्रतिक्रिया संरचना

Copy

interface TenantPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'unexpected-param' | 'sign-up-date-in-future' | 'payment-frequency-invalid' | 'cannot-change-payment-frequency' | 'name-invalid' | 'email-invalid' | 'email-taken' | 'no-package' | 'invalid-package' | 'unauthorized' | 'tenant-limit-reached' | 'cannot-move-tenant' | 'cannot-change-package' | 'invalid-billing-info'; 
    /** विफलता पर शामिल। **/
    reason?: string
}

DELETE /api/v1/tenants/:id

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

यह रूट id द्वारा एक Tenant और उससे जुड़े सभी डेटा (users, comments, आदि) को हटाने की सुविधा प्रदान करता है।

Tenants को हटाने के लिए निम्नलिखित प्रतिबंध लागू हैं:

Tenant आपका अपना होना चाहिए, या ऐसा white labeled tenant होना चाहिए जिसे आप प्रबंधित करते हैं।
sure query parameter को true पर सेट होना चाहिए।

Tenant हटाने का cURL उदाहरण

Copy

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

Tenant हटाने के अनुरोध की संरचना

Copy

interface TenantDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Tenant हटाने के प्रतिक्रिया की संरचना

Copy

interface TenantDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'unsure'
    /** विफलता पर शामिल। **/
    reason?: string
}

टेनेंट पैकेज संरचना

TenantPackage एक Tenant के लिए उपलब्ध पैकेज की जानकारी परिभाषित करता है। एक टेनेंट के पास कई पैकेज उपलब्ध हो सकते हैं, लेकिन किसी दिए गए समय पर केवल एक ही उपयोग में होता है।

जब तक एक Tenant का packageId किसी मान्य TenantPackage की ओर इंगित नहीं करता, तब तक उसे किसी भी प्रोडक्ट के लिए उपयोग नहीं किया जा सकता।

TenantPackage ऑब्जेक्ट दो प्रकार के होते हैं:

निश्चित मूल्य वाले पैकेज - जहाँ hasFlexPricing false होता है।
लचीला मूल्य निर्धारण (Flexible pricing) - जहाँ hasFlexPricing true होता है।

दोनों स्थितियों में, पैकेज का उपयोग करने वाले खाते पर सीमाएँ परिभाषित की जाती हैं, हालाँकि Flex के साथ टेनेंट से एक आधार मूल्य के साथ-साथ उनके उपयोग के अनुसार शुल्क लिया जाता है, जो flex* पैरामीटर द्वारा परिभाषित होता है।

एक टेनेंट के पास कई टेनेंट पैकेज हो सकते हैं और वह Billing Info Page. से स्वयं पैकेज बदलने में सक्षम हो सकता है।

यदि आप स्वयं टेनेंट्स के लिए बिलिंग संभालेंगे, तो भी आपको प्रत्येक टेनेंट के लिए उनकी सीमाएँ परिभाषित करने हेतु एक पैकेज परिभाषित करना होगा। बस Tenant पर billingHandledExternally को true सेट करें और वे स्वयं अपनी बिलिंग जानकारी, या सक्रिय पैकेज, बदलने में सक्षम नहीं होंगे।

आप पैरेंट टेनेंट से अधिक सीमाओं वाले पैकेज नहीं बना सकते।

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

यह रूट id द्वारा एकल Tenant Package लौटाता है।

TenantPackage By ID cURL उदाहरण

Copy

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

TenantPackage रिक्वेस्ट संरचना

Copy

interface TenantPackageByIdQueryParams {
    tenantId: string
    API_KEY: string
}

TenantPackage रिस्पॉन्स संरचना

Copy

interface TenantPackageByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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 के अनुसार क्रमबद्ध।

लागत लौटाए गए टेनेंट पैकेजों की संख्या पर आधारित है, जिसमें प्रत्येक 10 टेनेंट पैकेजों पर 1 क्रेडिट लगता है।

TenantPackage cURL उदाहरण

Copy

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

TenantPackage रिक्वेस्ट संरचना

Copy

interface TenantPackagesRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** पेजिनेशन के लिए छोड़े जाने वाले टेनेंट पैकेजों की संख्या। **/
    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* पैरामीटर के मान पैरेंट टेनेंट से कम होने चाहिए।
एक व्हाइट लेबल वाले टेनेंट में अधिकतम पाँच पैकेज हो सकते हैं।
केवल व्हाइट लेबलिंग एक्सेस वाले टेनेंट ही TenantPackage बना सकते हैं।
आप अपने ही टेनेंट में पैकेज नहीं जोड़ सकते। :)

हम एक TenantPackage इस प्रकार बना सकते हैं:

TenantPackage Create via Email cURL उदाहरण

Copy

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

TenantPackage Create Request Structure

Copy

interface TenantPackagePostQueryParams {
    tenantId: string
    API_KEY: string
}

TenantPackage Create Response Structure

Copy

interface TenantPackagePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' 'white-labeling-not-allowed' | 'name-too-long' | 'for-who-text-too-long' | 'feature-tag-lines-too-long' | 'no-package' | 'invalid-package' | 'unauthorized' | 'child-tenant-too-large' | 'flex-param-missing' | 'unexpected-flex-param' | 'package-limit-reached' | 'flex-param-missing' | 'unexpected-flex-param'
    /** Included on failure. **/
    reason?: string
    tenantPackage?: TenantPackage; // सफलता पर हम पूरा बनाया गया टेनेंट पैकेज लौटाते हैं।
}

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

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

यह API एंडपॉइंट id द्वारा एक TenantPackage को अपडेट करने की क्षमता प्रदान करता है।

एक TenantPackage को अपडेट करने की निम्नलिखित पाबंदियाँ हैं:

यदि आप hasFlexPricing को true सेट कर रहे हैं, तो उसी अनुरोध में सभी flex* पैरामीटर आवश्यक हैं।
name की लंबाई 50 characters से अधिक नहीं हो सकती।
प्रत्येक forWhoText आइटम की लंबाई 200 characters से अधिक नहीं हो सकती।
प्रत्येक featureTaglines आइटम की लंबाई 100 characters से अधिक नहीं हो सकती।
TenantPackage पैरेंट टेनेंट से "छोटा" होना चाहिए। उदाहरण के लिए, सभी max* पैरामीटर के मान पैरेंट टेनेंट से कम होने चाहिए।
आप TenantPackage से जुड़े tenantId को नहीं बदल सकते।

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 को हटा नहीं सकते जो उपयोग में है (किसी tenant का packageId उस पैकेज की ओर इशारा करता है)। पहले Tenant को अपडेट करें।

TenantPackage हटाने का cURL उदाहरण

Copy

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

TenantPackage हटाने की रिक्वेस्ट संरचना

Copy

interface TenantPackageDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

TenantPackage हटाने की रिस्पॉन्स संरचना

Copy

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

टेनेंट उपयोगकर्ता संरचना

TenantUser एक User को परिभाषित करता है जो एक विशिष्ट टेनेंट द्वारा प्रबंधित होता है। उनका खाता उस टेनेंट पर पूर्ण नियंत्रण रखता है जिससे वे संबद्ध हैं, और उनके खाते को UI या API के माध्यम से अपडेट या डिलीट किया जा सकता है।

टेनेंट उपयोगकर्ता Tenant तक सभी अनुमतियों और पहुँच वाले व्यवस्थापक हो सकते हैं, या उन्हें टिप्पणियों के संचालन, API कुंजियों तक पहुँच, आदि जैसी विशिष्ट अनुमतियों तक सीमित किया जा सकता है।

TenantUser ऑब्जेक्ट की संरचना इस प्रकार है:

TenantUser संरचना

Copy

/** यह सूचनाओं (notifications) के लिए है। **/
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

यह रूट id द्वारा एकल TenantUser लौटाता है।

TenantUser By ID cURL उदाहरण

Copy

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

TenantUser रिक्वेस्ट संरचना

Copy

interface TenantUserByIdQueryParams {
    tenantId: string
    API_KEY: string
}

TenantUser रिस्पॉन्स संरचना

Copy

interface TenantUserByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** विफलता पर शामिल। **/
    reason?: string
    tenantUser?: TenantUser
}

GET /api/v1/tenant-users

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

यह API पेजिनेशन का उपयोग करती है, जो skip क्वेरी पैरामीटर द्वारा प्रदान की जाती है। TenantUsers 100 के पृष्ठों में लौटाए जाते हैं, जो signUpDate, username और id के अनुसार क्रमबद्ध होते हैं।

लागत लौटाए गए tenant users की संख्या पर आधारित है, जो प्रति 10 लौटाए गए tenant users पर 1 credit है।

TenantUser cURL उदाहरण

Copy

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

TenantUser रिक्वेस्ट संरचना

Copy

interface TenantUsersRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** पेजिनेशन के लिए छोड़े जाने वाले tenant users की संख्या। **/
    skip?: number
}

TenantUser रिस्पॉन्स संरचना

Copy

interface TenantUsersResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** विफलता पर शामिल। **/
    reason?: string
    tenantUsers?: TenantUser[]
}

POST /api/v1/tenant-users

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

यह रूट एक सिंगल TenantUser जोड़ने की क्षमता प्रदान करता है।

एक TenantUser बनाने के लिए निम्नलिखित प्रतिबंध हैं:

एक username आवश्यक है।
एक email आवश्यक है।
signUpDate भविष्य की तारीख नहीं हो सकती।
locale समर्थित लोकेल्स की सूची में होना चाहिए।
username पूरे FastComments.com पर अद्वितीय होना चाहिए। यदि यह समस्या है, तो हम SSO का उपयोग करने का सुझाव देते हैं।
email पूरे FastComments.com पर अद्वितीय होना चाहिए। यदि यह समस्या है, तो हम SSO का उपयोग करने का सुझाव देते हैं।
आप अपने पैकेज में maxTenantUsers के अंतर्गत परिभाषित सीमा से अधिक टेनेंट यूज़र नहीं बना सकते।

हम एक TenantUser इस प्रकार बना सकते हैं:

TenantUser बनाने का cURL उदाहरण

Copy

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

TenantUser बनाने की रिक्वेस्ट संरचना

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

TenantUser बनाने की रिस्पॉन्स संरचना

Copy

interface TenantUserPostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'username-required' | 'email-required' | 'sign-up-date-in-future' | 'unsupported-locale' | 'unauthorized' | 'username-taken' | 'email-taken' | 'tenant-user-limit-reached'
    /** Included on failure. **/
    reason?: string
    tenantUser?: TenantUser; // We return the complete created tenant user on success.
}

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

यह रूट एक TenantUser को लॉगिन लिंक भेजने की सुविधा प्रदान करता है।

यह तब उपयोगी होता है जब आप बैच में यूज़र बना रहे हों और उन्हें FastComments.com पर लॉगिन करने का तरीका न बताना पड़े। यह उन्हें लॉगिन के लिए एक "magic link" भेज देगा जो 30 days के बाद समाप्त हो जाता है।

किसी TenantUser को लॉगिन लिंक भेजने के लिए निम्नलिखित प्रतिबंध मौजूद हैं:

TenantUser पहले से मौजूद होना चाहिए।
आपके पास उस Tenant को प्रबंधित करने की पहुँच होनी चाहिए जिससे TenantUser संबंधित है।

हम किसी TenantUser को लॉगिन लिंक इस प्रकार भेज सकते हैं:

TenantUser लॉगिन लिंक cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/tenant-users/xyz/send-login-link?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json'

इससे Bob at TenantName is inviting you to be a moderator... जैसा एक ईमेल भेजा जाएगा।

TenantUser लॉगिन लिंक रिक्वेस्ट संरचना

Copy

interface TenantUserPostQueryParams {
    tenantId: string
    API_KEY: string
}

TenantUser लॉगिन लिंक रिस्पॉन्स संरचना

Copy

interface TenantUserPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
}

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

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

यह रूट एकल TenantUser को अपडेट करने की क्षमता प्रदान करता है।

एक TenantUser को अपडेट करने की निम्नलिखित पाबंदियाँ हैं:

signUpDate भविष्य में नहीं हो सकता।
locale समर्थित लोकेल की सूची में होना चाहिए।
username पूरे FastComments.com पर अद्वितीय होना चाहिए। यदि यह समस्या है, तो हम SSO का उपयोग करने का सुझाव देते हैं।
email पूरे FastComments.com पर अद्वितीय होना चाहिए। यदि यह समस्या है, तो हम SSO का उपयोग करने का सुझाव देते हैं।
आप किसी उपयोगकर्ता का tenantId अपडेट नहीं कर सकते।

हम एक TenantUser इस प्रकार अपडेट कर सकते हैं:

TenantUser अपडेट cURL उदाहरण

Copy

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

TenantUser अपडेट रिक्वेस्ट संरचना

Copy

interface TenantUserPatchQueryParams {
    tenantId: string
    API_KEY: string
    /** जब 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 द्वारा हटाने की सुविधा प्रदान करता है।

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 का उपयोग करेगा। इन्हें Widget Customization UI के माध्यम से अनुकूलित किया जा सकता है।

उदाहरण

TenantUser हटाने का cURL उदाहरण

Copy

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

TenantUser हटाने का रिक्वेस्ट स्ट्रक्चर

Copy

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

TenantUser हटाने का रिस्पॉन्स स्ट्रक्चर

Copy

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

उपयोगकर्ता संरचना

User एक ऑब्जेक्ट है जो सभी उपयोगकर्ताओं के सबसे सामान्य गुणों को दर्शाता है।

ध्यान रखें कि FastComments पर उपयोगकर्ताओं के लिए हमारे पास कई अलग-अलग उपयोग के मामले हैं:

Secure SSO
Simple SSO
Tenant Users (उदाहरण के लिए: Administrators)
Commenters

यह API Commenters और Simple SSO के माध्यम से बनाए गए उपयोगकर्ताओं के लिए है। मूल रूप से, आपकी साइट के माध्यम से बनाया गया कोई भी उपयोगकर्ता इस API के माध्यम से एक्सेस किया जा सकता है। Tenant Users को भी इस तरह प्राप्त किया जा सकता है, लेकिन /tenant-users/ API के साथ इंटरैक्ट करने पर आपको अधिक जानकारी मिलेगी।

Secure SSO के लिए कृपया /sso-users/ API का उपयोग करें।

आप इन प्रकार के उपयोगकर्ताओं को अपडेट नहीं कर सकते। उन्होंने अपना खाता आपकी साइट के माध्यम से बनाया है, इसलिए हम कुछ बुनियादी केवल-पढ़ने योग्य (read-only) एक्सेस प्रदान करते हैं, लेकिन आप बदलाव नहीं कर सकते। यदि आप इस प्रकार का फ्लो चाहते हैं - तो आपको Secure SSO सेटअप करना होगा।

User ऑब्जेक्ट की संरचना इस प्रकार है:

User संरचना

Copy

export interface User {
    /** यह वही id है जो comment ऑब्जेक्ट्स पर userId के रूप में उपयोग की जाती है। **/
    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

यह रूट id द्वारा एकल User लौटाता है।

ID द्वारा User cURL उदाहरण

Copy

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

User रिक्वेस्ट संरचना

Copy

interface UserByIdQueryParams {
    tenantId: string
    API_KEY: string
}

User रिस्पॉन्स संरचना

Copy

interface UserByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
    /** विफलता पर शामिल। **/
    reason?: string
    user?: User
}

वोट संरचना

एक Vote ऑब्जेक्ट किसी उपयोगकर्ता द्वारा दिए गए वोट को दर्शाता है।

कमेंट्स और वोट के बीच संबंध commentId के माध्यम से परिभाषित होता है।

Vote ऑब्जेक्ट की संरचना इस प्रकार है:

Vote संरचना

Copy

interface Vote {
    id: string
    urlId: string
    commentId: string
    userId: string
    direction: 1 | -1
    createdAt: string
}

GET /api/v1/votes

Resource: Vote as GET /api/v1/votes Credit Cost: 10

वोट को urlId द्वारा फ़ेच किया जाना चाहिए।

वोट के प्रकार

तीन प्रकार के वोट होते हैं:

प्रमाणित वोट (Authenticated Votes), जो संबंधित कमेंट पर लागू होते हैं। आप इन्हें इस API के माध्यम से बना सकते हैं।
प्रमाणित वोट, जो सत्यापन के लिए लंबित (pending) हैं, और इस प्रकार अभी तक कमेंट पर लागू नहीं हुए हैं। ये तब बनाए जाते हैं जब कोई उपयोगकर्ता FastComments.com के login to vote तंत्र का उपयोग करता है।
अनाम वोट (Anonymous Votes), जो संबंधित कमेंट पर लागू होते हैं। ये अनाम कमेंटिंग के साथ बनाए जाते हैं।

भ्रम को कम करने के लिए इन्हें 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 कुंजी के साथ बनाया गया था।

appliedAnonymousVotes संरचना उन वोटों के लिए है जो बिना ईमेल, API कुंजी आदि के बनाए गए थे।

GET /api/v1/votes/for-user

Resource: Vote as GET /api/v1/votes/for-user Credit Cost: 1

किसी दिए गए urlId पर एक उपयोगकर्ता द्वारा छोड़े गए वोट प्राप्त करने की सुविधा देता है। यह एक userId लेता है जो कोई भी FastComments.com या SSO User हो सकता है।

यह तब उपयोगी है जब आप यह दिखाना चाहें कि उपयोगकर्ता ने किसी कमेंट पर वोट किया है या नहीं। कमेंट प्राप्त करते समय, बस उसी समय उसी urlId के लिए उपयोगकर्ता के लिए इस API को कॉल करें।

यदि आप गुमनाम (anonymous) वोटिंग का उपयोग कर रहे हैं, तो आप userId के स्थान पर anonUserId पास करना चाहेंगे।

Votes For User 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'

Votes For Anon User 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 कुंजी के साथ बनाया गया था।

Votes For User रिक्वेस्ट संरचना

Copy

interface VotesForUserRequestQueryParams {
    tenantId: string
    API_KEY: string
    urlId: string
    userId?: string
    anonUserId?: string
}

Votes For User रिस्पॉन्स संरचना

Copy

interface VotesForUserResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'invalid-user-id'
    /** Included on failure. **/
    reason?: string
    /** Authorized, verified votes, applied to their corresponding comments. **/
    appliedAuthorizedVotes: Vote[]
    /** Votes pending verification, not yet applied to their corresponding comments. **/
    pendingVotes: Vote[]
}

POST /api/v1/votes

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

यह रूट एकल अधिकृत Vote जोड़ने की क्षमता प्रदान करता है। वोट up (+1) या down (-1) हो सकते हैं।

वोट बनाने का cURL उदाहरण

Copy

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

गुमनाम वोट बनाने का cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-randomly-generated-identifier&commentId=comment-id&direction=up' \
  --header 'Content-Type: application/json'

वोट बनाने के अनुरोध की संरचना

Copy

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

वोट बनाने की प्रतिक्रिया की संरचना

Copy

interface VotePostResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-user-id' | 'invalid-user-id' | 'invalid-comment-id' | 'invalid-direction' | 'duplicate' | 'voting-disabled'
    /** Included on failure. **/
    reason?: string
    voteId?: string
}

गुमनाम वोट बनाना

गुमनाम वोट userId के स्थान पर क्वेरी पैरामीटर में anonUserId सेट करके बनाए जा सकते हैं।

यह id को कहीं भी किसी user ऑब्जेक्ट से मेल खाना ज़रूरी नहीं है (इसीलिए यह गुमनाम है)। यह केवल सेशन के लिए एक पहचानकर्ता है, ताकि आप उसी सेशन में वोट को फिर से प्राप्त कर सकें और जांच सकें कि किसी कमेंट पर वोट किया गया है या नहीं।

यदि आपके पास FastComments की तरह "गुमनाम सेशन" जैसी कोई चीज़ नहीं है - तो आप इसे बस एक यादृच्छिक ID, जैसे UUID पर सेट कर सकते हैं (हालाँकि स्थान बचाने के लिए हम छोटे पहचानकर्ताओं को प्राथमिकता देते हैं)।

अन्य नोट्स

यह API टेनेंट-स्तरीय सेटिंग्स का पालन करता है। उदाहरण के लिए, यदि आप किसी दिए गए पेज के लिए वोटिंग अक्षम करते हैं, और API के माध्यम से वोट बनाने का प्रयास करते हैं, तो यह त्रुटि कोड voting-disabled के साथ विफल हो जाएगा।
यह API डिफ़ॉल्ट रूप से लाइव है।
यह API संबंधित Comment के votes को अपडेट करेगा।

DELETE /api/v1/votes/:id

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

यह रूट एकल Vote को डिलीट करने की सुविधा प्रदान करता है।

Vote डिलीट cURL उदाहरण

Copy

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

Vote डिलीट रिक्वेस्ट संरचना

Copy

interface VoteDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

Vote डिलीट रिस्पॉन्स संरचना

Copy

interface VoteDeleteResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id'
    /** विफलता पर शामिल। **/
    reason?: string
}

नोट्स:

यह API टेनेंट-स्तरीय सेटिंग्स का पालन करता है। उदाहरण के लिए, यदि आप किसी दिए गए पेज के लिए वोटिंग अक्षम करते हैं और API के माध्यम से वोट बनाने का प्रयास करते हैं, तो यह voting-disabled त्रुटि कोड के साथ विफल हो जाएगा।
यह API डिफ़ॉल्ट रूप से लाइव है।
यह API संबंधित Comment के votes को अपडेट करेगा।

DomainConfig संरचना

एक DomainConfig ऑब्जेक्ट किसी टेनेंट के लिए एक डोमेन की कॉन्फ़िगरेशन दर्शाता है।

DomainConfig ऑब्जेक्ट की संरचना इस प्रकार है:

डोमेन कॉन्फ़िग संरचना

Copy

interface DomainConfig {
    /** एक डोमेन, URL नहीं, जैसे "fastcomments.com" या "www.example.com"। यदि सबडोमेन तक सीमित करना चाहा जाए तो सबडोमेन शामिल किया जा सकता है। अधिकतम 1000 वर्ण। **/
    domain: string
    /** ईमेल भेजते समय उपयोग किया जाने वाला From-Name। **/
    emailFromName?: string
    /** ईमेल भेजते समय उपयोग किया जाने वाला From-Email। सुनिश्चित करें कि SPF इस एट्रिब्यूट में उपयोग किए गए डोमेन के रूप में ईमेल भेजने के लिए mail.fastcomments.com को अनुमति देने के लिए सेटअप है। **/
    emailFromEmail?: string
    /** READONLY। जब ऑब्जेक्ट बनाया गया था। **/
    createdAt: string
    /** इस डोमेन से संबंधित लोगो। ईमेल में उपयोग होता है। HTTPS का उपयोग करें। **/
    logoSrc?: string
    /** इस डोमेन से संबंधित एक छोटा लोगो। HTTPS का उपयोग करें। **/
    logoSrc100px?: string
    /** SSO ONLY। भेजे गए हर ईमेल के फुटर में उपयोग किया जाने वाला URL। "[userId]" वेरिएबल का समर्थन करता है। **/
    footerUnsubscribeURL?: string
    /** SSO ONLY। भेजे गए हर ईमेल में उपयोग किए जाने वाले हेडर। उदाहरण के लिए, डिलीवरी में सुधार के लिए अनसब्सक्राइब से संबंधित हेडर सेट करने के लिए उपयोगी। इस Record में List-Unsubscribe एंट्री, यदि मौजूद हो, "[userId]" वेरिएबल का समर्थन करती है। **/
    emailHeaders?: Record<string, string>
    /** सभी अनसब्सक्राइब लिंक अक्षम करें। अनुशंसित नहीं, डिलीवरी दरों को नुकसान हो सकता है। **/
    disableUnsubscribeLinks?: boolean
    /** DKIM कॉन्फ़िगरेशन। **/
    dkim?: DomainConfigDKIM
}

DKIM कॉन्फ़िग संरचना

Copy

interface DomainConfigDKIM {
    /** आपके DKIM रिकॉर्ड में डोमेन नाम। **/
    domainName: string
    /** उपयोग करने के लिए DKIM की सिलेक्टर। **/
    keySelector: string
    /** सार्वजनिक कुंजी, PEM फॉर्मेट में। GET प्रतिक्रियाओं में लौटाया जाता है। **/
    publicKey: string
    /** @deprecated अब API प्रतिक्रियाओं में लौटाया नहीं जाता। पिछली संगतता के लिए लेखन पर स्वीकार किया जाता है। **/
    privateKey?: string
}

प्रमाणीकरण के लिए

डोमेन कॉन्फ़िगरेशन का उपयोग यह निर्धारित करने के लिए किया जाता है कि कौन सी साइटें आपके खाते के लिए FastComments विजेट होस्ट कर सकती हैं। यह प्रमाणीकरण का एक बुनियादी रूप है, जिसका अर्थ है कि किसी भी डोमेन कॉन्फ़िगरेशन को जोड़ने या हटाने से प्रोडक्शन में आपकी FastComments इंस्टॉलेशन की उपलब्धता प्रभावित हो सकती है।

किसी ऐसे डोमेन के लिए Domain Config की domain प्रॉपर्टी को हटाएं या अपडेट न करें जो वर्तमान में उपयोग में है, जब तक कि उस डोमेन को अक्षम करना इरादा न हो।

इसका व्यवहार /auth/my-account/configure-domains से डोमेन हटाने जैसा ही है।

यह भी ध्यान दें कि My Domains UI से डोमेन हटाने से उस डोमेन के लिए इस UI के माध्यम से जोड़ी गई कोई भी संबंधित कॉन्फ़िगरेशन हट जाएगी।

ईमेल अनुकूलन के लिए

ईमेल फुटर में अनसब्सक्राइब लिंक, और कई ईमेल क्लाइंट द्वारा प्रदान की जाने वाली वन-क्लिक-अनसब्सक्राइब सुविधा, को इस API के माध्यम से क्रमशः footerUnsubscribeURL और emailHeaders को परिभाषित करके कॉन्फ़िगर किया जा सकता है।

DKIM के लिए

अपने DKIM DNS रिकॉर्ड परिभाषित करने के बाद, परिभाषित संरचना का उपयोग करके अपने DKIM कॉन्फ़िगरेशन के साथ DomainConfig को बस अपडेट करें।

GET /api/v1/domain-configs

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

यह API एक tenant के लिए सभी DomainConfig ऑब्जेक्ट्स प्राप्त करने की क्षमता प्रदान करता है।

DomainConfig GET cURL उदाहरण

Copy

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

DomainConfig GET रिक्वेस्ट संरचना

Copy

interface GetDomainConfigsRequestQueryParams {
    tenantId: string
    API_KEY: string
}

DomainConfig GET रिस्पॉन्स संरचना

Copy

interface GetDomainConfigsResponse {
    status: 'success' | 'failed'
    /** Included on failure. **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** Included on failure. **/
    reason?: string
    /** The configurations! **/
    configurations: DomainConfig[] | null
}

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

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

अलग-अलग DomainConfigs को उनके संबंधित domain के आधार पर प्राप्त (fetch) किया जा सकता है।

डोमेन द्वारा डोमेन कॉन्फ़िग 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'
    /** Included on failure. **/
    code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-domain' | 'update-would-create-duplicate' | 'domain-does-not-exist'
    /** Included on failure. **/
    reason?: string
    configuration?: DomainConfig | null
}

POST /api/v1/domain-configs

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

यह API एंडपॉइंट डोमेन कॉन्फ़िगरेशन बनाने की क्षमता प्रदान करता है।

किसी डोमेन के लिए कॉन्फ़िगरेशन जोड़ने से वह डोमेन FastComments खाते के लिए अधिकृत हो जाता है।

इस API के सामान्य उपयोग के मामले प्रारंभिक सेटअप हैं, यदि कई डोमेन जोड़े जाने हों, या ईमेल भेजने के लिए कस्टम कॉन्फ़िगरेशन।

DomainConfig POST cURL उदाहरण

Copy

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

DomainConfig POST अनुरोध संरचना

Copy

interface DomainConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

DomainConfig POST प्रतिक्रिया संरचना

Copy

interface DomainConfigPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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

यह API एंडपॉइंट केवल डोमेन और अपडेट करने के लिए एट्रिब्यूट निर्दिष्ट करके डोमेन कॉन्फ़िगरेशन अपडेट करने की क्षमता प्रदान करता है।

DomainConfig PATCH cURL उदाहरण

Copy

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

DomainConfig PATCH रिक्वेस्ट संरचना

Copy

interface DomainConfigPatchQueryParams {
    tenantId: string
    API_KEY: string
}

DomainConfig PATCH रिस्पॉन्स संरचना

Copy

interface DomainConfigPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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
}

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

यह रूट id द्वारा एकल DomainConfig को हटाने की सुविधा प्रदान करता है।

नोट: DomainConfig को हटाने से उस डोमेन का FastComments उपयोग करने का अधिकार समाप्त हो जाएगा।
नोट: UI के माध्यम से डोमेन को दोबारा जोड़ने पर ऑब्जेक्ट फिर से बन जाएगा (केवल domain पॉपुलेटेड के साथ)।

DomainConfig हटाने का cURL उदाहरण

Copy

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

DomainConfig हटाने के रिक्वेस्ट की संरचना

Copy

interface DomainConfigRequestQueryParams {
    tenantId: string
    API_KEY: string
}

DomainConfig हटाने के रिस्पॉन्स की संरचना

Copy

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

QuestionConfig संरचना

FastComments प्रश्न बनाने और उनके परिणामों को संग्रहित (aggregate) करने का एक तरीका प्रदान करता है। एक प्रश्न (आगे इसे QuestionConfig कहा जाएगा) का उदाहरण एक स्टार रेटिंग, एक स्लाइडर, या एक NPS प्रश्न हो सकता है (type के माध्यम से निर्धारित)।

प्रश्न डेटा को अलग-अलग, साथ में, समय के साथ, समग्र रूप से, पेज के अनुसार आदि तरीकों से संग्रहित किया जा सकता है।

इस फ्रेमवर्क में क्लाइंट-साइड विजेट (इस API के सामने आपके सर्वर के साथ), एडमिन डैशबोर्ड, और रिपोर्टिंग टूल बनाने के लिए आवश्यक सभी क्षमताएं मौजूद हैं।

सबसे पहले, हमें एक QuestionConfig परिभाषित करना होगा। इसकी संरचना इस प्रकार है:

QuestionConfig संरचना

Copy

type QuestionConfigType = 'nps' | 'slider' | 'star' | 'thumbs';
interface QuestionConfig {
    id: string
    tenantId: string
    name: string
    question: string
    helpText?: string
    createdAt: string
    createdBy: string
    /** READONLY - incremented for each new response. **/
    usedCount: number
    /** A date string for when the configuration was last used (result left). **/
    lastUsed?: string
    type: QuestionConfigType
    numStars?: number
    min?: number
    max?: number
    defaultValue?: number
    labelNegative?: string
    labelPositive?: string
    subQuestionIds?: string[]
    alwaysShowSubQuestions?: boolean
    reportingOrder: number
}

GET /api/v1/question-configs

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

यह रूट एक बार में 100 तक QuestionConfig ऑब्जेक्ट लौटाता है, पृष्ठांकित (paginated) रूप में। प्रत्येक 100 ऑब्जेक्ट की लागत 1 है। इन्हें प्रश्न पाठ के आरोही क्रम (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

यह रूट अपनी id के आधार पर एकल QuestionConfig लौटाता है।

QuestionConfig By ID cURL उदाहरण

Copy

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

QuestionConfig अनुरोध संरचना

Copy

interface QuestionConfigRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionConfig प्रतिक्रिया संरचना

Copy

interface QuestionConfigByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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

यह API एंडपॉइंट एक QuestionConfig बनाने की क्षमता प्रदान करता है।

QuestionConfig POST cURL उदाहरण

Copy

curl --request POST \
  --url 'https://fastcomments.com/api/v1/question-configs?tenantId=demo&API_KEY=DEMO_API_SECRET' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Some name that shows on reports.",
    "question": "how much do you like this api?",
    "type": 'slider',
    "reportingOrder": 0,
    "min": 0,
    "max": 10
}'

QuestionConfig POST अनुरोध संरचना

Copy

interface QuestionConfigPostQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionConfig POST प्रतिक्रिया संरचना

Copy

interface QuestionConfigPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';  
    /** विफलता पर शामिल। **/
    reason?: string
    /** बनाया गया ऑब्जेक्ट। **/
    questionConfig?: QuestionConfig
}

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

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

यह रूट एक सिंगल QuestionConfig को अपडेट करने की क्षमता प्रदान करता है।

निम्नलिखित संरचना उन सभी मानों को दर्शाती है जिन्हें बदला जा सकता है:

QuestionConfig संरचना

Copy

interface QuestionConfigPatchBody {
    name?: string
    question?: string
    helpText?: string
    /** सावधान! यदि min/max अलग हैं तो type बदलने से रिपोर्टिंग प्रभावित हो सकती है। **/
    type?: QuestionConfigType
    numStars?: number
    min?: number
    max?: number
    defaultValue?: number
    labelNegative?: string
    labelPositive?: string
    subQuestionIds?: string[]
    alwaysShowSubQuestions?: boolean
    reportingOrder?: number
}

QuestionConfig अपडेट cURL उदाहरण

Copy

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

QuestionConfig अपडेट रिक्वेस्ट संरचना

Copy

interface QuestionConfigPatchQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionConfig अपडेट रिस्पॉन्स संरचना

Copy

interface QuestionConfigPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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 द्वारा हटाने की सुविधा प्रदान करता है।

यह सभी संबंधित question results को हटा देगा (लेकिन comments नहीं)। यह उच्च credit लागत का एक हिस्सा है।

QuestionConfig हटाने का cURL उदाहरण

Copy

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

QuestionConfig हटाने के अनुरोध की संरचना

Copy

interface QuestionConfigDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionConfig हटाने की प्रतिक्रिया की संरचना

Copy

interface QuestionConfigResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
}

QuestionResult संरचना

प्रश्नों के परिणाम सहेजने के लिए, आप एक QuestionResult बनाते हैं। इसके बाद आप प्रश्न परिणामों को एग्रीगेट कर सकते हैं, और रिपोर्टिंग उद्देश्यों के लिए उन्हें टिप्पणियों से भी जोड़ सकते हैं।

QuestionResult संरचना

Copy

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

GET /api/v1/question-results

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

यह रूट एक बार में 1000 तक QuestionResults ऑब्जेक्ट लौटाता है, पृष्ठांकित (paginated) रूप में। प्रत्येक 100 ऑब्जेक्ट पर लागत 1 है। इन्हें 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

यह रूट अपनी id द्वारा एकल QuestionResult लौटाता है।

QuestionResult By ID cURL उदाहरण

Copy

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

QuestionResult रिक्वेस्ट संरचना

Copy

interface QuestionResultRequestByIdQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionResult रिस्पॉन्स संरचना

Copy

interface QuestionResultByIdResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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

यह API एंडपॉइंट एक QuestionResult बनाने की क्षमता प्रदान करता है।

QuestionResult POST cURL उदाहरण

Copy

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

QuestionResult POST रिक्वेस्ट संरचना

Copy

interface QuestionResultPostQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionResult POST रिस्पॉन्स संरचना

Copy

interface QuestionResultPostResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';  
    /** विफलता पर शामिल। **/
    reason?: string
    /** बनाया गया ऑब्जेक्ट। **/
    questionResult?: QuestionResult
}

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

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

यह रूट एकल QuestionResult को अपडेट करने की क्षमता प्रदान करता है।

निम्नलिखित संरचना उन सभी मानों को दर्शाती है जिन्हें बदला जा सकता है:

QuestionResult संरचना

Copy

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

QuestionResult अपडेट cURL उदाहरण

Copy

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

QuestionResult अपडेट रिक्वेस्ट संरचना

Copy

interface QuestionResultPatchQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionResult अपडेट रिस्पॉन्स संरचना

Copy

interface QuestionResultPatchResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    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-results/:id

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

यह रूट QuestionResult को id द्वारा हटाने की सुविधा प्रदान करता है।

QuestionResult हटाने का cURL उदाहरण

Copy

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

QuestionResult हटाने के अनुरोध की संरचना

Copy

interface QuestionResultDeleteQueryParams {
    tenantId: string
    API_KEY: string
}

QuestionResult हटाने के प्रतिसाद की संरचना

Copy

interface QuestionResultResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
    /** विफलता पर शामिल। **/
    reason?: string
}

GET /api/v1/question-results-aggregate

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

यहीं पर परिणामों का समुच्चयन (aggregation) होता है।

समुच्चयन प्रतिक्रिया की संरचना इस प्रकार है:

QuestionResultsAggregationResult संरचना

Copy

interface QuestionResultDataPoint {
    /** वर्तमान डेटा पॉइंट (तिथि बकेट या पेज) के लिए किसी मान की घटनाओं की संख्या का मान-से-गिनती मैप। **/
    v: Map<ValueAsString, number>
    total: number
}
interface QuestionResultsAggregationResult {
    /** ध्यान दें - timeBucket निर्दिष्ट न होने पर null होता है। **/
    dataByDateBucket?: Map<DateString, QuestionResultDataPoint>
    dataByUrlId?: Map<URLIdString, QuestionResultDataPoint>
    countsByValue?: Map<ValueAsString, number>
    /** समुच्चयित किए गए परिणामों की कुल संख्या। **/
    total: number
    /** परिणामी भारित औसत। यह एक float है, आमतौर पर दो दशमलव या उससे कम। **/
    average: number
    /** एक तिथि स्ट्रिंग जो दर्शाती है कि यह डेटा कब गणना किया गया था, क्योंकि यह कैश से आ सकता है। **/
    createdAt: string
}

समुच्चयन के लिए उपलब्ध क्वेरी पैरामीटर यहाँ दिए गए हैं:

QuestionResultsAggregation रिक्वेस्ट संरचना

Copy

interface QuestionResultsAggregateRequestQueryParams {
    tenantId: string
    API_KEY: string
    /** आप एक या अधिक प्रश्नों के लिए परिणाम समुच्चयित कर सकते हैं। **/
    questionId: string | string[]
    startDate?: string | number
    timeBucket?: 'day' | 'month' | 'year'
    /** किसी विशिष्ट पेज के लिए समुच्चयन। **/
    urlId?: string
    /** किसी विशिष्ट उपयोगकर्ता के लिए समुच्चयन। **/
    userId?: string
    /** अभी पुनः गणना करें और कैश अपडेट करें। **/
    forceRecalculate?: boolean
}

एक उदाहरण रिक्वेस्ट यहाँ है:

QuestionResultsAggregation उदाहरण

Copy

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

उदाहरण प्रतिक्रिया:

QuestionResultsAggregation प्रतिक्रिया उदाहरण

Copy

    {
        "average": 8.33,
        "countsByValue": {
            "5": 1,
            "10": 2
        },
        "createdAt": "2023-08-30T00:00:00.000Z",
        "dataByUrlId": {
            "some-page": {
                "total": 3,
                "v": {
                    "5": 1,
                    "10": 2
                }
            }
        },
        "total": 3
    }

QuestionResultsAggregation प्रतिक्रिया संरचना

Copy

interface QuestionResultsAggregationResponse {
    status: 'success' | 'failed'
    /** विफलता पर शामिल। **/
    code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
    /** विफलता पर शामिल। **/
    reason?: string
    data: QuestionResultsAggregationResult
}

परफ़ॉर्मेंस नोट्स

कैश मिस की स्थिति में समुच्चयन में आमतौर पर प्रति मिलियन परिणाम पाँच सेकंड लगते हैं।
अन्यथा, रिक्वेस्ट स्थिर-समय (constant-time) में होती हैं।

कैशिंग और लागत नोट्स

जब forceRecalculate निर्दिष्ट किया जाता है, तो लागत सामान्य 2 के बजाय हमेशा 10 होती है।
यदि कैश समाप्त हो जाता है और डेटा पुनः गणना किया जाता है, तो भी लागत एक स्थिर 2 रहती है यदि forceRecalculate निर्दिष्ट नहीं किया गया है। कैश समुच्चयित किए गए डेटा सेट के आकार के आधार पर समाप्त होता है (30 सेकंड से 5 मिनट के बीच भिन्न हो सकता है)।
यह कैश के उपयोग को प्रोत्साहित करने के लिए है।

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

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

यहीं पर परिणामों और टिप्पणियों का संयोजन होता है। उदाहरण के लिए, किसी उत्पाद के लिए "हाल की सकारात्मक और नकारात्मक टिप्पणियों" का चार्ट बनाने के लिए उपयोगी।

आप मानों की एक श्रेणी (समावेशी), एक या अधिक प्रश्नों, और एक प्रारंभ तिथि (समावेशी) के आधार पर खोज कर सकते हैं।

प्रतिक्रिया की संरचना इस प्रकार है:

QuestionResultsCombinedWithCommentsResponse संरचना

Copy

interface SimpleComment {
    id: string
    commenterName: string
    userId?: string
    date: string
    commentHTML: string
}
interface SimpleQuestionResult {
    id: string
    value: number
}
interface CommentAndResult {
    comment: SimpleComment
    result: SimpleQuestionResult
}
interface QuestionResultsCombinedWithCommentsResponse {
    /** A date string representing when this data was calculated, since it might come from cache. **/
    createdAt: string
    results: CommentAndResult[]
}

एग्रीगेशन के लिए उपलब्ध क्वेरी पैरामीटर यहाँ दिए गए हैं:

QuestionResultsCombineComments रिक्वेस्ट संरचना

Copy

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

एक उदाहरण रिक्वेस्ट यहाँ है:

QuestionResultsCombineComments उदाहरण

Copy

curl --request GET \
  --url 'https://fastcomments.com/api/v1/question-results-aggregation/combine/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&questionId=some-question-id&minValue=5&maxValue=10'

उदाहरण प्रतिक्रिया:

QuestionResultsCombineComments प्रतिक्रिया उदाहरण

Copy

{
    "createdAt": "2023-08-30T00:00:00.000Z",
    "results": [
        {
            "comment": {
                "id": "some-id",
                "commentHTML": "test-2",
                "commenterName": "Test",
                "date": "2023-08-30T00:00:00.000Z",
                "userId": "some-user-id"
            },
            "result": {
                "id": "some-id",
                "value": 10
            }
        },
        {
            "comment": {
                "id": "some-id",
                "commentHTML": "test-0",
                "commenterName": "Some Name",
                "date": "2023-08-30T00:00:00.000Z",
                "userId": "some-user-id"
            },
            "result": {
                "id": "some-id",
                "value": 5
            }
        }
    ]
}

QuestionResultsCombineComments प्रतिक्रिया संरचना

Copy

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

कैशिंग और लागत संबंधी नोट्स

जब forceRecalculate निर्दिष्ट किया जाता है, तो लागत सामान्य 2 के बजाय हमेशा 10 होती है।
यदि कैश समाप्त हो जाता है और डेटा पुनर्गणना की जाती है, तो भी लागत स्थिर 2 रहती है यदि forceRecalculate निर्दिष्ट नहीं किया गया हो।
यह कैश के उपयोग को प्रोत्साहित करने के लिए है।

UserBadge संरचना

UserBadge एक ऑब्जेक्ट है जो FastComments सिस्टम में किसी उपयोगकर्ता को सौंपे गए बैज को दर्शाता है।

बैज उपयोगकर्ताओं को उनकी गतिविधि (जैसे कमेंट संख्या, रिप्लाई समय, वेटेरन स्थिति) के आधार पर स्वचालित रूप से या साइट व्यवस्थापकों द्वारा मैन्युअल रूप से सौंपे जा सकते हैं।

UserBadge ऑब्जेक्ट की संरचना इस प्रकार है:

UserBadge संरचना

Copy

export interface UserBadge {
    /** इस उपयोगकर्ता बैज असाइनमेंट के लिए अद्वितीय पहचानकर्ता */
    id: string
    /** वह उपयोगकर्ता की ID जिसे यह बैज सौंपा गया है */
    userId: string
    /** टेनेंट के बैज कैटलॉग से बैज परिभाषा की ID */
    badgeId: string
    /** वह टेनेंट की ID जिसने यह बैज बनाया/सौंपा */
    fromTenantId: string
    /** यह बैज कब बनाया गया (epoch से मिलीसेकंड) */
    createdAt?: number
    /** उपयोगकर्ता को यह बैज कब प्राप्त हुआ (epoch से मिलीसेकंड) */
    receivedAt?: number
    /** 
     * बैज का प्रकार: 
     * 0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, 3=CommentsPinned, 
     * 4=Veteran, 5=NightOwl, 6=FastReplyTime, 7=ModeratorCommentsDeleted,
     * 8=ModeratorCommentsApproved, 9=ModeratorCommentsUnapproved, 10=ModeratorCommentsReviewed,
     * 11=ModeratorCommentsMarkedSpam, 12=ModeratorCommentsMarkedNotSpam, 13=RepliedToSpecificPage,
     * 14=Manual
     */
    type: number
    /** थ्रेशोल्ड-आधारित बैज के लिए, थ्रेशोल्ड मान */
    threshold?: number
    /** बैज का नाम/लेबल */
    name?: string
    /** बैज का विस्तृत विवरण */
    description?: string
    /** बैज पर दिखाया गया टेक्स्ट */
    displayLabel?: string
    /** बैज पर दिखाई जाने वाली छवि का URL */
    displaySrc?: string
    /** बैज के लिए बैकग्राउंड रंग (हेक्स कोड) */
    backgroundColor?: string
    /** बैज के लिए बॉर्डर रंग (हेक्स कोड) */
    borderColor?: string
    /** बैज के लिए टेक्स्ट रंग (हेक्स कोड) */
    textColor?: string
    /** स्टाइलिंग के लिए अतिरिक्त CSS क्लास */
    cssClass?: string
    /** वेटेरन बैज के लिए, मिलीसेकंड में समय थ्रेशोल्ड */
    veteranUserThresholdMillis?: number
    /** क्या यह बैज उपयोगकर्ता के कमेंट्स पर दिखाया जाता है */
    displayedOnComments: boolean
    /** बैज का प्रदर्शन क्रम */
    order?: number
    /** यदि सेट है, तो यह बैज केवल मेल खाते urlId वाले पेज पर दिखाया जाता है। ग्लोबल बैज के लिए Null। */
    urlId?: string | null
}

GET /api/v1/user-badges

यह एंडपॉइंट आपको विभिन्न मानदंडों के आधार पर यूज़र बैज प्राप्त करने की सुविधा देता है।

उदाहरण रिक्वेस्ट:

यूज़र बैज की सूची - GET उदाहरण

Copy

Run

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

आप परिणामों को फ़िल्टर करने के लिए विभिन्न क्वेरी पैरामीटर जोड़ सकते हैं:

userId - किसी विशिष्ट यूज़र के बैज प्राप्त करें
badgeId - किसी विशिष्ट बैज के इंस्टेंस प्राप्त करें
type - बैज टाइप के अनुसार फ़िल्टर करें (0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, आदि। पूरी सूची के लिए UserBadge संरचना देखें)
displayedOnComments - बैज कमेंट्स पर दिखाया जाता है या नहीं, इसके अनुसार फ़िल्टर करें (true/false)
limit - लौटाए जाने वाले बैज की अधिकतम संख्या (डिफ़ॉल्ट 30, अधिकतम 200)
skip - छोड़े जाने वाले बैज की संख्या (पेजिनेशन के लिए)

उदाहरण रिस्पॉन्स:

रिस्पॉन्स

Copy

{
  "status": "success",
  "userBadges": [
    {
      "id": "badge123",
      "userId": "user456",
      "badgeId": "badgeDef789",
      "fromTenantId": "tenant001",
      "createdAt": 1650532511000,
      "receivedAt": 1650532511000,
      "type": 14,
      "name": "Special Contributor",
      "description": "Awarded to special contributors to our community",
      "displayLabel": "Special",
      "backgroundColor": "#4a5568",
      "textColor": "#ffffff",
      "displayedOnComments": true,
      "order": 1
    },
    {
      "id": "badge124",
      "userId": "user456",
      "badgeId": "badgeDef790",
      "fromTenantId": "tenant001",
      "createdAt": 1650532598000,
      "receivedAt": 1650532598000,
      "type": 0,
      "threshold": 100,
      "name": "Centurion",
      "description": "Made 100 comments",
      "displayLabel": "100",
      "backgroundColor": "#2b6cb0",
      "textColor": "#ffffff",
      "displayedOnComments": true,
      "order": 2
    }
  ]
}

संभावित त्रुटि रिस्पॉन्स:

त्रुटि: Tenant ID अनुपस्थित

Copy

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

त्रुटि: अमान्य Limit

Copy

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

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

यह एंडपॉइंट आपको अपनी अद्वितीय ID द्वारा एक विशिष्ट यूज़र बैज प्राप्त करने की अनुमति देता है।

उदाहरण रिक्वेस्ट:

ID द्वारा यूज़र बैज प्राप्त करें - GET उदाहरण

Copy

Run

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

उदाहरण रिस्पॉन्स:

रिस्पॉन्स

Copy

{
  "status": "success",
  "userBadge": {
    "id": "badge123",
    "userId": "user456",
    "badgeId": "badgeDef789",
    "fromTenantId": "tenant001",
    "createdAt": 1650532511000,
    "receivedAt": 1650532511000,
    "type": 14,
    "name": "Special Contributor",
    "description": "Awarded to special contributors to our community",
    "displayLabel": "Special",
    "backgroundColor": "#4a5568",
    "textColor": "#ffffff",
    "displayedOnComments": true,
    "order": 1
  }
}

संभावित त्रुटि रिस्पॉन्स:

त्रुटि: Tenant ID अनुपस्थित

Copy

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

त्रुटि: नहीं मिला

Copy

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

POST /api/v1/user-badges

यह एंडपॉइंट आपको एक नया यूज़र बैज असाइनमेंट बनाने की अनुमति देता है।

अनुरोध उदाहरण:

POST अनुरोध उदाहरण

Copy

Run

curl -X POST "https://fastcomments.com/api/v1/user-badges?tenantId=demo&API_KEY=DEMO_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "userId": "user456",
  "badgeId": "badgeDef789",
  "displayedOnComments": true
}'

अनुरोध बॉडी में निम्नलिखित पैरामीटर होने चाहिए:

userId (आवश्यक) - उस यूज़र की ID जिसे बैज असाइन किया जाना है
badgeId (आवश्यक) - असाइन किए जाने वाले बैज की ID
displayedOnComments (वैकल्पिक) - क्या बैज यूज़र की टिप्पणियों पर प्रदर्शित होना चाहिए (डिफ़ॉल्ट true)

महत्वपूर्ण नोट्स:

बैज आपके टेनेंट के बैज कैटलॉग में मौजूद और सक्रिय होना चाहिए
आप केवल उन यूज़र्स को बैज असाइन कर सकते हैं जो आपके टेनेंट से संबंधित हैं या जिन्होंने आपकी साइट पर टिप्पणी की है

प्रतिक्रिया उदाहरण:

प्रतिक्रिया

Copy

{
  "status": "success",
  "userBadge": {
    "id": "badge123",
    "userId": "user456",
    "badgeId": "badgeDef789",
    "fromTenantId": "tenant001",
    "createdAt": 1650532511000,
    "receivedAt": 1650532511000,
    "type": 14,
    "name": "Special Contributor",
    "description": "Awarded to special contributors to our community",
    "displayLabel": "Special",
    "backgroundColor": "#4a5568",
    "textColor": "#ffffff",
    "displayedOnComments": true,
    "order": 1
  }
}

संभावित त्रुटि प्रतिक्रियाएँ:

त्रुटि: Tenant ID अनुपस्थित

Copy

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

त्रुटि: User ID अनुपस्थित

Copy

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

त्रुटि: Badge ID अनुपस्थित

Copy

{
  "status": "failed",
  "code": "missing-badge-id",
  "reason": "Badge ID (body param: badgeId) is required."
}

त्रुटि: बैज नहीं मिला

Copy

{
  "status": "failed",
  "code": "badge-not-found",
  "reason": "The badge badgeDef789 was not found or is not enabled."
}

त्रुटि: अनधिकृत यूज़र

Copy

{
  "status": "failed",
  "code": "unauthorized-user",
  "reason": "You can only add badges to users who belong to your tenant or have commented on your site."
}

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

यह एंडपॉइंट आपको यूज़र बैज असाइनमेंट अपडेट करने की अनुमति देता है।

वर्तमान में, केवल displayedOnComments प्रॉपर्टी अपडेट की जा सकती है, जो यह नियंत्रित करती है कि बैज यूज़र की कमेंट्स पर दिखाया जाए या नहीं।

उदाहरण रिक्वेस्ट:

PUT रिक्वेस्ट उदाहरण

Copy

Run

curl -X PUT "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
  "displayedOnComments": false
}'

उदाहरण रिस्पॉन्स:

रिस्पॉन्स

Copy

{
  "status": "success"
}

संभावित एरर रिस्पॉन्स:

एरर: Tenant ID गायब है

Copy

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

एरर: ID गायब है

Copy

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

एरर: नहीं मिला

Copy

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

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

यह एंडपॉइंट आपको एक यूज़र बैज असाइनमेंट डिलीट करने की सुविधा देता है।

उदाहरण रिक्वेस्ट:

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 संरचना

UserBadgeProgress एक ऑब्जेक्ट है जो FastComments सिस्टम में विभिन्न बैज अर्जित करने की दिशा में उपयोगकर्ता की प्रगति को दर्शाता है।

यह ट्रैकिंग यह निर्धारित करने में मदद करती है कि उपयोगकर्ताओं को आपके समुदाय में उनकी गतिविधि और भागीदारी के आधार पर स्वचालित बैज कब प्राप्त होने चाहिए।

UserBadgeProgress ऑब्जेक्ट की संरचना इस प्रकार है:

UserBadgeProgress संरचना

Copy

export interface UserBadgeProgress {
    /** इस प्रगति रिकॉर्ड के लिए अद्वितीय पहचानकर्ता */
    id: string
    /** इस प्रगति रिकॉर्ड का संबंधित टेनेंट की ID */
    tenantId: string
    /** उस उपयोगकर्ता की ID जिसे यह प्रगति रिकॉर्ड ट्रैक करता है */
    userId: string
    /** सिस्टम में उपयोगकर्ता की पहली टिप्पणी की ID */
    firstCommentId?: string
    /** उपयोगकर्ता की पहली टिप्पणी की तिथि (epoch से मिलीसेकंड) */
    firstCommentDate?: number
    /** उपयोगकर्ता गतिविधि के आधार पर स्वचालित रूप से गणना किया गया ट्रस्ट फैक्टर */
    autoTrustFactor?: number
    /** व्यवस्थापकों द्वारा मैन्युअल रूप से सेट किया गया ट्रस्ट फैक्टर */
    manualTrustFactor?: number
    /** विभिन्न मेट्रिक्स के साथ विस्तृत प्रगति ऑब्जेक्ट, कुंजियाँ BadgeType enum से मेल खाती हैं */
    progress: {
        /** 0: CommentCount - उपयोगकर्ता द्वारा की गई टिप्पणियों की संख्या */
        '0'?: number
        /** 1: CommentUpVotes - उपयोगकर्ता को प्राप्त अपवोट की संख्या */
        '1'?: number
        /** 2: CommentReplies - उपयोगकर्ता द्वारा किए गए उत्तरों की संख्या */
        '2'?: number
        /** 3: CommentsPinned - उपयोगकर्ता की पिन की गई टिप्पणियों की संख्या */
        '3'?: number
        /** 4: Veteran - उपयोगकर्ता के खाते की आयु */
        '4'?: number
        /** 5: NightOwl - रात के समय उपयोगकर्ता द्वारा पोस्ट करने की बार-बारता */
        '5'?: number
        /** 6: FastReplyTime - मिलीसेकंड में औसत उत्तर समय */
        '6'?: number
        /** 7: ModeratorCommentsDeleted - मॉडरेटर बैज के लिए, हटाई गई टिप्पणियों की संख्या */
        '7'?: number
        /** 8: ModeratorCommentsApproved - मॉडरेटर बैज के लिए, स्वीकृत टिप्पणियों की संख्या */
        '8'?: number
        /** 9: ModeratorCommentsUnapproved - मॉडरेटर बैज के लिए, अस्वीकृत टिप्पणियों की संख्या */
        '9'?: number
        /** 10: ModeratorCommentsReviewed - मॉडरेटर बैज के लिए, समीक्षा की गई टिप्पणियों की संख्या */
        '10'?: number
        /** 11: ModeratorCommentsMarkedSpam - मॉडरेटर बैज के लिए, स्पैम के रूप में चिह्नित टिप्पणियों की संख्या */
        '11'?: number
        /** 12: ModeratorCommentsMarkedNotSpam - मॉडरेटर बैज के लिए, स्पैम नहीं के रूप में चिह्नित टिप्पणियों की संख्या */
        '12'?: number
        /** 13: RepliedToSpecificPage - प्रत्येक पेज के लिए, उत्तरों की संख्या */
        '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

यह एंडपॉइंट आपको अपनी यूनिक ID द्वारा किसी विशिष्ट यूज़र बैज प्रोग्रेस रिकॉर्ड को फ़ेच करने की अनुमति देता है।

उदाहरण रिक्वेस्ट:

ID द्वारा बैज प्रोग्रेस प्राप्त करें - GET उदाहरण

Copy

Run

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

उदाहरण रिस्पॉन्स:

रिस्पॉन्स

Copy

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

संभावित त्रुटि रिस्पॉन्स:

त्रुटि: Tenant ID अनुपस्थित

Copy

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

त्रुटि: नहीं मिला

Copy

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

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

यह एंडपॉइंट आपको यूज़र ID द्वारा किसी यूज़र का बैज प्रोग्रेस रिकॉर्ड प्राप्त करने की अनुमति देता है।

उदाहरण रिक्वेस्ट:

यूज़र 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
    }
  }
}

संभावित एरर रिस्पॉन्स:

एरर: टेनेंट 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": "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 संसाधन

प्रमाणीकरण

एकत्रीकरण

AuditLogs

बैच जॉब

टिप्पणियाँ

EmailTemplates

फ़ीड पोस्ट

हैशटैग

मैं

मॉडरेटर

सूचना संख्या

सूचनाएँ

पेज रिएक्ट्स

पेज

पोल

पोल वोट

PendingWebhookEvents

SSO उपयोगकर्ता

सदस्यताएँ

टेनेंट दैनिक उपयोग

टेनेंट

टेनेंट पैकेज

टेनेंट उपयोगकर्ता

उपयोगकर्ता

वोट

डोमेन कॉन्फ़िग

प्रश्न कॉन्फ़िग

प्रश्न परिणाम

प्रश्न परिणाम एकत्रीकरण

उपयोगकर्ता बैज

उपयोगकर्ता बैज प्रगति

लाइव टिप्पणी APIs

FastComments API

जेनरेट किए गए SDKs

प्रमाणीकरण (Authentication)

सुरक्षा नोट

प्रमाणीकरण विकल्प एक - Headers

प्रमाणीकरण विकल्प दो - Query Parameters

प्रमाणीकरण विकल्प तीन - OAuth Bearer Token

अपने स्वयं के राइट्स पढ़ना (Reading Your Own Writes)

API संसाधन

संसाधन उपयोग

ध्यान दें!

Webhooks

OAuth प्राधिकरण

डिस्कवरी

क्लाइंट रजिस्टर करना

स्कोप

चरण 1 - ऑथराइज़ेशन रिक्वेस्ट

चरण 2 - टोकन रिक्वेस्ट

चरण 3 - API कॉल करना

चरण 4 - रिफ्रेश करना

रद्दीकरण

अपना डेटा एकत्रित करें

उदाहरण

उदाहरण: अद्वितीय गिनती

उदाहरण: डिस्टिंक्ट गिनती

उदाहरण: कई फ़ील्ड के मानों का योग

उदाहरण: कई फ़ील्ड के मानों का औसत

उदाहरण: कई फ़ील्ड के न्यूनतम/अधिकतम मान

उदाहरण: कई फ़ील्ड के अद्वितीय मानों की गिनती

उदाहरण: क्वेरी निर्माण उदाहरण

उदाहरण: समीक्षा लंबित टिप्पणियों की गिनती

उदाहरण: स्वीकृत, समीक्षित और स्पैम टिप्पणियों का विवरण

संरचनाएँ

AuditLog संरचना

GET /api/v1/audit-logs

किसी व्यक्ति के साथ क्या हुआ, यह खोजना

प्रबंधित टेनेंट

BatchJob संरचना

Retries

GET /api/v1/batch-jobs

GET /api/v1/batch-jobs/:id

Comment संरचना

कमेंट टेक्स्ट संरचना

टैगिंग

हैशटैग

GET /api/v1/comments