실시간 댓글 API

리소스 사용량

API에서 데이터를 가져오는 것이 계정 사용량에 포함된다는 점에 유의하십시오.

각 리소스는 해당 사용량을 자체 섹션에 나열합니다.

일부 리소스는 다른 리소스보다 제공 비용이 더 많이 듭니다. 각 엔드포인트는 API 호출당 정해진 크레딧 비용을 가지고 있습니다. 일부 엔드포인트의 경우 옵션 및 응답 크기에 따라 크레딧 수가 달라집니다.

API 사용량은 Billing Analytics 페이지에서 확인할 수 있으며 몇 분마다 업데이트됩니다.

주의!

Comment API에서 urlId에 전달할 값을 결정할 때 혼란을 줄이기 위해 먼저 Pages 문서를 읽어볼 것을 권장합니다.

웹훅

Webhook 구독에는 별도의 가이드가 있습니다. POST, GET 및 DELETE /api/v1/webhooks, 그리고 GET /api/v1/webhooks/sample-payloads는 Managing Subscriptions via API에서 문서화되어 있으며, 이벤트 페이로드는 Webhook Structures에서 확인할 수 있습니다.

FastComments는 OAuth 2.1 인증 서버입니다. 애플리케이션은 FastComments 계정 하나에 연결된 토큰을 얻어 이 가이드의 모든 엔드포인트에서 API 키 대신 사용할 수 있습니다. 이는 Zapier 앱, MCP 서버 및 기타 서드파티 통합이 연결되는 방식입니다.

토큰은 PKCE를 사용한 인증 코드 흐름을 통해 발급됩니다. 클라이언트 자격 증명 또는 암시적 부여는 없습니다.

Discovery

엔드포인트 위치, 지원되는 부여 유형 및 인증 방법은 표준 메타데이터 URL에 게시됩니다:

인증 서버 메타데이터

Copy

1

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

3

그가 설명하는 엔드포인트:

OAuth 엔드포인트

Copy

1

2GET https://fastcomments.com/oauth/authorize

3POST https://fastcomments.com/oauth/token

4POST https://fastcomments.com/oauth/revoke

5POST https://fastcomments.com/oauth/register

6

EU 지역 계정은 발급자로 https://eu.fastcomments.com을 사용하며, 경로는 동일합니다.

Registering a client

클라이언트는 흐름을 시작하기 전에 client_id와 등록된 redirect_uri가 필요합니다. 이를 얻는 방법은 두 가지가 있습니다:

• 동적 클라이언트 등록. RFC 7591에 따라 JSON 본문(redirect_uris, client_name, client_uri, logo_uri, token_endpoint_auth_method)을 포함한 POST /oauth/register. 응답에는 client_id와 기밀 클라이언트의 경우 client_secret이 포함됩니다. 등록은 인증 없이 이루어지며 IP당 속도 제한이 적용됩니다.
• 클라이언트 ID 메타데이터 문서. 클라이언트는 자신이 제어하는 https URL을 client_id로 사용합니다. FastComments는 해당 URL을 가져와 동일한 메타데이터 필드를 읽습니다. 별도의 등록 호출이 필요하지 않습니다.

FastComments 대시보드에 나열된 파트너 애플리케이션(예: Zapier)은 FastComments가 직접 등록합니다. 마켓플레이스 목록을 구축하고 1인당 클라이언트가 필요한 경우 지원팀에 문의하십시오.

Scopes

스코프

Copy

1

2read GET and HEAD requests

3write every other method

4

스코프를 지정하지 않은 요청은 두 스코프 모두 부여됩니다. 사용자는 동의 페이지에서 요청된 스코프를 확인합니다. 이 두 스코프 외의 스코프를 요청하면 invalid_scope 오류가 발생합니다.

Step 1 - Authorization request

사용자의 브라우저를 인증 엔드포인트로 보냅니다. 모든 클라이언트는 S256 방법을 사용한 PKCE가 필요합니다.

인증 요청

Copy

1

2GET https://fastcomments.com/oauth/authorize

3 ?response_type=code

4 &client_id=YOUR_CLIENT_ID

5 &redirect_uri=https://example.com/oauth/callback

6 &scope=read%20write

7 &state=RANDOM_STATE

8 &code_challenge=BASE64URL_SHA256_OF_VERIFIER

9 &code_challenge_method=S256

10

인증 요청 매개변수

Copy

1

2interface OAuthAuthorizeQueryParams {

3 response_type: 'code'

4 client_id: string

5 /** 클라이언트가 등록한 리디렉션 URI 중 하나와 정확히 일치해야 합니다. **/

6 redirect_uri: string

7 /** 공백으로 구분됩니다. 두 스코프를 모두 요청하려면 생략합니다. **/

8 scope?: 'read' | 'write' | 'read write'

9 /** 리디렉션 시 변경되지 않은 상태로 반환됩니다. 흐름을 시작한 세션에 콜백을 연결하는 데 사용합니다. **/

10 state?: string

11 /** base64url(sha256(code_verifier)). **/

12 code_challenge: string

13 code_challenge_method: 'S256'

14 /** 선택적 RFC 8707 리소스 표시자입니다. 전송할 경우 토큰 엔드포인트에도 동일한 값을 전송해야 합니다. **/

15 resource?: string

16}

17

필요한 경우 사용자는 FastComments에 로그인하고 애플리케이션 이름, 연결될 계정 및 요청된 스코프가 표시된 동의 페이지를 봅니다. 사용자는 해당 계정에 대해 API Admin 권한을 보유해야 하며, 다른 사용자는 동의 양식 대신 권한 오류를 보게 됩니다. 승인을 하면 브라우저가 code와 state를 포함한 redirect_uri로 리디렉션됩니다. 거부하면 error=access_denied와 함께 리디렉션됩니다.

인증 코드는 10분 동안 유효하며 한 번만 교환할 수 있습니다. 동일한 코드를 두 번째로 교환하면 첫 번째 교환으로 생성된 모든 토큰이 폐기됩니다.

Step 2 - Token request

코드를 토큰으로 교환합니다. 본문은 폼 인코딩됩니다. 기밀 클라이언트는 client_secret_basic(HTTP Basic) 또는 client_secret_post(본문에 비밀)으로 인증합니다. 공개 클라이언트는 client_id만 전송합니다.

토큰 요청 cURL 예시

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/oauth/token' \

4 --header 'Content-Type: application/x-www-form-urlencoded' \

5 --data 'grant_type=authorization_code' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

8 --data 'code=fcac_...' \

9 --data 'code_verifier=YOUR_PKCE_VERIFIER' \

10 --data 'redirect_uri=https://example.com/oauth/callback'

11

토큰 요청 본문 (authorization_code)

Copy

1

2interface OAuthTokenRequestAuthorizationCode {

3 grant_type: 'authorization_code'

4 client_id: string

5 /** 기밀 클라이언트 전용. 대신 HTTP Basic 인증으로 보낼 수 있습니다. **/

6 client_secret?: string

7 code: string

8 code_verifier: string

9 /** Must match the authorization request when sent. **/

10 redirect_uri?: string

11 resource?: string

12}

13

토큰 응답 구조

Copy

1

2interface OAuthTokenResponse {

3 /** 접두사 fcat_ . 유효 기간은 1시간입니다. **/

4 access_token: string

5 token_type: 'bearer'

6 /** 액세스 토큰이 만료될 때까지 남은 초. 3600. **/

7 expires_in: number

8 /** 접두사 fcrt_ . 발급 후 30일 동안 유효합니다. **/

9 refresh_token: string

10 /** 공백으로 구분된 부여된 스코프. **/

11 scope: string

12}

13

오류는 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.

Step 3 - Calling the API

액세스 토큰을 Bearer 토큰으로 전송합니다. 테넌트는 토큰에 내포되므로 tenantId는 선택 사항입니다. 제공할 경우 토큰과 일치해야 하며, 일치하지 않으면 요청이 실패합니다.

Bearer 토큰 cURL 예시

Copy

1

2curl --request GET \

3 --url 'https://fastcomments.com/api/v1/me' \

4 --header 'Authorization: Bearer fcat_...'

5

GET /api/v1/me는 테넌트, 인증된 사용자 및 부여된 스코프를 반환하므로 연결 테스트에 적합한 호출입니다. 만료되었거나 폐기된 토큰으로 요청하면 HTTP 401이 반환됩니다. 토큰이 보유하지 않은 스코프가 필요한 메서드로 요청하면 HTTP 403이 반환됩니다.

Step 4 - Refreshing

리프레시 요청 cURL 예시

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/oauth/token' \

4 --header 'Content-Type: application/x-www-form-urlencoded' \

5 --data 'grant_type=refresh_token' \

6 --data 'client_id=YOUR_CLIENT_ID' \

7 --data 'client_secret=YOUR_CLIENT_SECRET' \

8 --data 'refresh_token=fcrt_...'

9

토큰 요청 본문 (refresh_token)

Copy

1

2interface OAuthTokenRequestRefreshToken {

3 grant_type: 'refresh_token'

4 client_id: string

5 client_secret?: string

6 refresh_token: string

7 /** 선택 사항. 원래 부여된 스코프의 하위 집합으로 제한합니다. **/

8 scope?: string

9 resource?: string

10}

11

응답은 코드 교환과 동일한 구조를 가집니다. 리프레시 토큰은 회전합니다: 각 리프레시 시 새로운 refresh_token을 반환하고, 동시 요청을 위한 30초의 유예 기간 후에 이전 토큰을 폐기합니다. 30초 이상 지난 회전된 리프레시 토큰을 제시하면 재생으로 간주되어 전체 부여가 폐기됩니다. FastComments가 등록한 파트너 애플리케이션은 회전에서 제외되며, 동일한 리프레시 토큰을 반환하고 만료 기간이 추가로 30일 연장됩니다.

리프레시 시 인증된 사용자가 여전히 계정에 API Admin 권한을 보유하고 있는지도 재검사합니다. 권한이 없으면 부여가 폐기되고 응답은 invalid_grant가 됩니다.

Revocation

폐기 요청 cURL 예시

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/oauth/revoke' \

4 --header 'Content-Type: application/x-www-form-urlencoded' \

5 --data 'client_id=YOUR_CLIENT_ID' \

6 --data 'client_secret=YOUR_CLIENT_SECRET' \

7 --data 'token=fcrt_...' \

8 --data 'token_type_hint=refresh_token'

9

리프레시 토큰을 폐기하면 동일한 부여에서 발급된 모든 액세스 토큰이 폐기됩니다. 액세스 토큰을 폐기하면 해당 토큰만 폐기됩니다. 엔드포인트는 RFC 7009에 따라 토큰 존재 여부와 관계없이 빈 JSON 객체와 함께 HTTP 200을 반환합니다.

사용자는 FastComments 대시보드의 Connected Apps에서 연결을 폐기할 수도 있습니다. 해당 애플리케이션의 모든 토큰이 즉시 작동을 멈춥니다.

이 API는 문서를 그룹화(groupBy가 제공된 경우)하고 여러 연산을 적용하여 집계합니다. 다양한 연산(예: sum, countDistinct, avg 등)을 지원합니다.

비용은 가변적입니다. 스캔된 객체 500개마다 API 크레딧 1개가 소모됩니다.

기본적으로 각 API 호출에 허용되는 최대 메모리 사용량은 64MB이며, 기본적으로 동시에 하나의 집계만 실행할 수 있습니다. 여러 집계를 동시에 제출하면 제출된 순서대로 큐에 들어가 실행됩니다. 대기 중인 집계는 최대 60초 동안 대기하며, 그 이후에는 요청이 타임아웃됩니다. 개별 집계는 최대 5분 동안 실행될 수 있습니다.

관리되는 테넌트가 있는 경우 parentTenantId 쿼리 파라미터를 전달하여 한 번의 호출로 모든 하위 테넌트 리소스를 집계할 수 있습니다.

예제

예제: 고유 값 세기

고유 값 세기 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "distinct", "field": "urlId", "alias": "urlId" },

6 { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }

7 ]

8}'

9

고유 값 세기 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "commenterEmail": {

7 "distinctCounts": {

8 "someone@somewhere.com": 1,

9 "someone2@somewhere.com": 1

10 }

11 }

12 },

13 {

14 "urlId": {

15 "distinctCounts": {

16 "some-page": 2

17 }

18 }

19 }

20 ],

21 "stats": { "scanned": 2 }

22}

23

예제: 고유 값 개수 세기

고유 값 개수 세기 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "countDistinct", "field": "urlId", "alias": "urlId" },

6 { "op": "countDistinct", "field": "commenterEmail", "alias": "commenterEmail" }

7 ]

8}'

9

응답:

고유 값 개수 세기 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "commenterEmail": { "distinctCount": 2 },

7 "urlId": { "distinctCount": 1 }

8 }

9 ],

10 "stats": { "scanned": 2 }

11}

12

예제: 여러 필드 값 합계

값 합계 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "sum", "field": "votes", "alias": "votes" },

6 { "op": "sum", "field": "votesUp", "alias": "votesUp" }

7 ]

8}'

9

응답:

값 합계 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "votes": { "numericValue": 2 },

7 "votesUp": { "numericValue": 2 }

8 }

9 ],

10 "stats": { "scanned": 2 }

11}

12

예제: 여러 필드 값 평균

평균 값 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "avg", "field": "votes", "alias": "votes" },

6 { "op": "avg", "field": "votesUp", "alias": "votesUp" }

7 ]

8}'

9

응답:

평균 값 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "votes": { "numericValue": 1 },

7 "votesUp": { "numericValue": 1 }

8 }

9 ],

10 "stats": { "scanned": 2 }

11}

12

예제: 여러 필드의 최소/최대 값

최소/최대 값 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "min", "field": "votes", "alias": "votes" },

6 { "op": "min", "field": "votesUp", "alias": "votesUp" },

7 { "op": "max", "field": "votes", "alias": "votes" },

8 { "op": "max", "field": "votesUp", "alias": "votesUp" }

9 ]

10}'

11

응답:

최소/최대 값 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "votes": { "numericValue": 0 },

7 "votesUp": { "numericValue": 0 },

8 "votes": { "numericValue": 2 },

9 "votesUp": { "numericValue": 2 }

10 }

11 ],

12 "stats": { "scanned": 2 }

13}

14

예제: 여러 필드의 고유 값 세기

고유 값 세기 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "distinct", "field": "urlId", "alias": "urlId" },

6 { "op": "distinct", "field": "commenterEmail", "alias": "commenterEmail" }

7 ]

8}'

9

응답:

고유 값 세기 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "commenterEmail": {

7 "distinctCounts": {

8 "someone@somewhere.com": 1,

9 "someone2@somewhere.com": 1

10 }

11 },

12 "urlId": {

13 "distinctCounts": {

14 "some-page": 2

15 }

16 }

17 }

18 ],

19 "stats": { "scanned": 2 }

20}

21

예제: 쿼리 생성 예제

쿼리 생성 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "groupBy": ["commenterName"],

5 "query": [

6 { "key": "approved", "value": true, "operator": "eq" },

7 { "key": "commenterName", "value": "some-username-2", "operator": "eq" }

8 ],

9 "operations": [

10 { "op": "sum", "field": "votes", "alias": "votes" }

11 ]

12}'

13

응답:

쿼리 생성 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "groups": { "commenterName": "some-username-2" },

7 "votes": { "numericValue": 2 }

8 }

9 ],

10 "stats": { "scanned": 1 }

11}

12

예제: 검토 대기 댓글 수 세기

검토 대기 댓글 수 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "query": [

5 { "key": "reviewed", "value": true, "operator": "not_eq" }

6 ],

7 "operations": [

8 { "op": "count", "field": "id", "alias": "count" }

9 ]

10}'

11

응답:

검토 대기 댓글 수 응답

Copy

1

2{

3 "status": "success",

4 "data": [

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

6 ],

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

8}

9

예제: 승인, 검토 및 스팸 댓글 분류

댓글 분류 cURL 예제

Copy

1

2curl --request POST --url 'https://fastcomments.com/api/v1/aggregate?tenantId=demo&API_KEY=DEMO_API_SECRET&includeStats=true' --header 'Content-Type: application/json' --data '{

3 "resourceName": "Comment",

4 "operations": [

5 { "op": "distinct", "field": "approved", "alias": "approved" },

6 { "op": "distinct", "field": "reviewed", "alias": "reviewed" },

7 { "op": "distinct", "field": "isSpam", "alias": "isSpam" }

8 ]

9}'

10

응답:

댓글 분류 응답

Copy

1

2{

3 "status": "success",

4 "data": [

5 {

6 "approved": { "distinctCounts": { "true": 2 } },

7 "reviewed": { "distinctCounts": { "false": 2 } },

8 "isSpam": { "distinctCounts": { "false": 2 } }

9 }

10 ],

11 "stats": { "scanned": 2 }

12}

13

구조

Aggregate 요청 구조

Copy

1

2export type AggregationOpType = 'sum' | 'countDistinct' | 'distinct' | 'avg' | 'min' | 'max' | 'count';

3

4/** 필드에 적용될 연산 */

5export interface AggregationOperation {

6 /** 연산을 적용할 필드 */

7 field: string;

8 /** 연산의 종류 */

9 op: AggregationOpType;

10 /** 출력에 대한 선택적 별칭; 제공되지 않으면 기본 별칭이 계산됩니다 */

11 alias?: string;

12 expandArray?: boolean;

13}

14

15export interface QueryPredicate {

16 key: string

17 value: string | number | boolean

18 operator: 'eq' | 'not_eq' | 'greater_than' | 'less_than' | 'contains'

19}

20

21export interface AggregationRequest {

22 query?: QueryPredicate[];

23 resourceName: string;

24 groupBy?: string[];

25 operations: AggregationOperation[];

26 sort?: {

27 field: string;

28 dir: 'asc' | 'desc';

29 };

30}

31

32type DistinctAccumulator = Record<string, number>;

33type GroupValues = Record<string, string>;

34

35export type AggregationValue = {

36 distinctCounts?: DistinctAccumulator

37 distinctCount?: number

38 numericValue?: number

39 stringValue?: string

40 groups?: GroupValues

41};

42

Aggregate 응답 구조

Copy

1

2export type AggregationItem = Record<string, AggregationValue> & { groups?: GroupValues };

3

4export interface AggregationResponse {

5 status: APIStatus,

6 data: AggregationItem[];

7 stats?: {

8 scanned: number;

9 timeMS: number;

10 };

11}

12

다음 리소스들을 집계할 수 있습니다:

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

This API uses pagination, provided by the skip, limit, before, and after parameters. AuditLogs are returned in pages of 1000 by default, up to a maximum limit of 10000, ordered by when and id. The pages are large because this endpoint is usually used to dump history rather than to page through it interactively.

Every 100 logs returned has a credit cost of 1.

By default, you will receive a list with the newest items first. This way, you can poll starting with skip=0, paginating until you find the last record you've consumed.

Alternatively, you can sort oldest-first, and paginate until there are no more records.

Sorting can be done by setting order to either ASC or DESC. The default is DESC.

Querying by date is possible via before and after as timestamps with milliseconds. before and after are NOT inclusive, and either can be used on its own.

사람에게 무슨 일이 있었는지 찾기

Every event records who performed it (username, userId, ip) and, separately, what it was performed on. targetLabel is a human-readable label for that object, for example jsmith (jsmith@example.com), and targetId is its id. Use target for a case-insensitive substring match on the label when you know a person's name or email but not their id.

Deletes capture the label at the time of the event, so a removed user or moderator can still be identified after the underlying record is gone.

관리되는 테넌트

If your tenant manages other tenants, set includeManagedTenants=true to return events from your tenant and every tenant it manages in one response. Each returned log's tenantId tells you which tenant it came from.

AuditLog cURL 예시

Copy

1

2curl --request GET \

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

4

AuditLog 요청 구조

Copy

1

2interface AuditLogsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 order?: 'ASC' | 'DESC'

6 /** Max 10000. Defaults to 1000. **/

7 limit?: number

8 skip?: number

9 before?: number

10 after?: number

11 /** Only events performed by this username. **/

12 username?: string

13 /** Only events from this IP address. **/

14 ip?: string

15 /** Only events of this type. **/

16 crudType?: 'c' | 'r' | 'u' | 'd' | 'login'

17 /** Only events for this resource, e.g. User or Moderator. **/

18 resourceName?: string

19 /** Only events whose affected object has this id. **/

20 targetId?: string

21 /** Case-insensitive substring match on the affected object's label. **/

22 target?: string

23 /** Also return events from tenants this tenant manages. **/

24 includeManagedTenants?: boolean

25}

26

AuditLog 응답 구조

Copy

1

2interface AuditLogsResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'invalid-limit' | 'invalid-skip'

6 /** Included on failure. **/

7 reason?: string

8 /** The logs! **/

9 auditLogs: AuditLog[]

10}

11

이 API는 사용자가 볼 수 있도록 댓글을 가져오는 데 사용됩니다. 예를 들어, 승인되지 않았거나 스팸인 댓글을 자동으로 필터링합니다.

Pagination

페이지네이션은 성능 요구 사항 및 사용 사례에 따라 두 가지 방법 중 하나로 수행할 수 있습니다:

1. Fastest: Precalculated Pagination:
   1. FastComments는 사전 구축된 위젯과 클라이언트를 사용할 때 이렇게 동작합니다.
   2. "next"를 클릭하면 페이지 수가 단순히 증가합니다.
   3. 이를 키-값 저장소에서 가져오는 것으로 생각할 수 있습니다.
   4. 이 경우 page 매개변수를 0부터 시작하도록 정의하고 정렬 방향을 direction으로 지정하면 됩니다.
   5. 페이지 크기는 커스터마이징 규칙을 통해 맞춤 설정할 수 있습니다.
2. Most Flexible: 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를 사용하여 반환되는 스레드의 깊이를 제한할 수 있습니다.

Threads

1. Precalculated Pagination을 사용할 때, 댓글은 page별로 그룹화되며 스레드 내 댓글이 전체 페이지에 영향을 줍니다.
   1. 이 경우 클라이언트에서 parentId를 기준으로 스레드를 결정할 수 있습니다.
   2. 예를 들어, 최상위 댓글이 하나이고 29개의 답글이 있는 페이지에서 API에 page=0을 설정하면 최상위 댓글 하나와 29개의 자식 댓글만 반환됩니다.
2. Flexible Pagination을 사용할 때 parentId 매개변수를 정의할 수 있습니다.
   1. 이를 null로 설정하면 최상위 댓글만 가져옵니다.
   2. 그런 다음 스레드를 보려면 API를 다시 호출하고 parentId를 전달합니다.
   3. 일반적인 해결책은 최상위 댓글에 대해 API 호출을 한 뒤, 각 댓글의 자식 댓글을 가져오기 위해 병렬 API 호출을 수행하는 것입니다.
3. NEW 2023년 2월부터! &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을 설정합니다.

Trees Explained

asTree를 사용할 때 페이지네이션을 이해하기 어려울 수 있습니다. 다음은 유용한 그래픽입니다:

트리 페이지네이션 다이어그램

Fetching Comments in The Context of a User

/comments API는 두 가지 컨텍스트에서 사용될 수 있으며, 각각 다른 사용 사례에 적용됩니다:

• 자신의 클라이언트를 구축하기 위해 정렬되고 태그된 정보를 포함한 댓글을 반환합니다.
  • 이 경우 contextUserId 쿼리 매개변수를 정의합니다.
• 맞춤형 통합을 위해 백엔드에서 댓글을 가져옵니다.
  • 플랫폼은 contextUserId 없이도 기본적으로 이 방식을 사용합니다.

댓글 사전 계산 페이지네이션

Copy

1

2curl --request GET \

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

4

댓글 유연한 페이지네이션

Copy

1

2curl --request GET \

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

4

사용자 컨텍스트에서 댓글 유연한 페이지네이션

Copy

1

2curl --request GET \

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

4

사용자 컨텍스트에서 최상위 댓글만 위한 유연한 페이지네이션

Copy

1

2curl --request GET \

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

4

Get Comments as a Tree

트리를 반환하도록 요청할 수 있으며, 페이지네이션은 최상위 댓글만 계산됩니다.

사용자 컨텍스트에서 트리 형태 댓글

Copy

1

2curl --request GET \

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

4

최상위 댓글과 즉시 자식만 가져오고 싶나요? 다음과 같이 할 수 있습니다:

최대 깊이 제한 트리 형태 댓글

Copy

1

2curl --request GET \

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

4

하지만 UI에서는 각 댓글에 “답글 보기” 버튼을 표시할지 여부를 알아야 할 수도 있습니다. 트리 형태로 댓글을 가져올 때는 해당 경우에 hasChildren 속성이 댓글에 태그됩니다.

Get Comments as a Tree, Searching by Hash Tag

해시태그로 검색할 수 있으며, 전체 테넌트(특정 페이지나 urlId에 제한되지 않음)에서 검색합니다.

이 예시에서는 urlId를 생략하고 여러 해시태그로 검색합니다. API는 요청된 모든 해시태그를 포함하는 댓글만 반환합니다.

사용자 컨텍스트에서 해시태그별 트리 형태 댓글

Copy

1

2curl --request GET \

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

4

All Request Params

댓글 요청 구조

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 댓글이 연결된 urlId(페이지 URL 또는 기사 ID) **/

6 urlId?: string

7 /** 이 사용자가 반환받는 댓글 수를 제한합니다. **/

8 userId?: string

9 /** 해시태그로 검색할 때 사용합니다. 여러 해시태그의 교집합을 찾으려면 &hashTag=a&hashTag=b와 같이 지정합니다. **/

10 hashTag?: string

11 /** 정렬 방향. 기본값은 MR(가장 관련성 높음)이며, 다른 옵션으로 OF(오래된 순)와 NF(최신 순)가 있습니다. **/

12 direction?: 'MR' | 'OF' | 'NF'

13 /** 사전 계산 페이지네이션: 가져올 페이지 번호이며, 0부터 시작합니다. 모든 댓글(최대 250개)을 가져오려면 -1을 전달합니다. **/

14 page?: number

15 /** 유연한 페이지네이션: 반환할 댓글 수를 지정합니다. **/

16 limit?: number

17 /** 유연한 페이지네이션: 각 부모에 대해 반환할 자식 댓글 수를 지정합니다. **/

18 limitChildren?: number

19 /** 유연한 페이지네이션: 건너뛸 댓글 수를 지정합니다. **/

20 skip?: number

21 /** 유연한 페이지네이션: 각 부모에 대해 건너뛸 자식 댓글 수를 지정합니다. **/

22 skipChildren?: number

23 /** 차단 및 신고된 댓글을 판단하기 위해 사용됩니다. **/

24 contextUserId?: string

25 /** 차단 및 신고된 댓글을 판단하기 위해 사용됩니다. **/

26 anonUserId?: string

27 /** 자식 댓글을 가져오기 위해 사용됩니다. **/

28 parentId?: string

29 /** 트리 형태로 가져오기 위해 사용됩니다. **/

30 asTree?: boolean

31 /** 트리 깊이를 얼마나 반환할지 지정합니다. 0은 자식이 없고, 1은 즉시 자식만 반환합니다. **/

32 maxTreeDepth?: number

33}

34

The Response

댓글 응답 구조

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-date' | 'unauthorized-page' | 'invalid-pagination-request' | 'invalid-limit' | 'invalid-limit-children' | 'invalid-skip' | 'invalid-skip-children' | 'invalid-max-tree-depth'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 /** 댓글 목록! **/

9 comments: Comment[]

10}

11

Helpful Tips

URL ID

Comment API를 urlId 매개변수와 함께 사용하는 것이 좋습니다. 먼저 Pages API를 호출하면 사용 가능한 urlId 값이 어떻게 생겼는지 확인할 수 있습니다.

Anonymous Actions

익명 댓글을 달 때는 댓글을 가져올 때와 신고·차단을 수행할 때 anonUserId를 전달하는 것이 좋습니다.

(!) 많은 앱 스토어에서 이는 필수이며, 사용자는 로그인하지 않아도 볼 수 있는 사용자 생성 콘텐츠를 신고할 수 있어야 합니다. 이를 수행하지 않으면 해당 스토어에서 앱이 삭제될 수 있습니다.

Comments Not Being Returned

댓글이 승인되었고 스팸이 아닌지 확인하십시오.

이 API는 id로 단일 댓글을 가져오는 기능을 제공합니다.

댓글 ID 조회 cURL 예제

Copy

1

2curl --request GET \

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

4

댓글 ID 조회 요청 구조

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

댓글 ID 조회 응답 구조

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

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

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 /** 댓글! **/

9 comment?: Comment

10}

11

이 API 엔드포인트는 댓글을 생성하는 기능을 제공합니다.

일반적인 사용 사례는 맞춤 UI, 통합 또는 가져오기입니다.

참고:

• 원하면 이 API는 댓글 위젯을 "라이브"로 업데이트할 수 있습니다 (이 경우 creditsCost가 1에서 2로 증가합니다).
• 이메일이 제공되면 이 API는 자동으로 사용자 객체를 시스템에 생성합니다.
• 다른 이메일을 사용하지만 동일한 사용자 이름을 가진 두 댓글을 저장하려고 하면 두 번째 댓글에 대해 오류가 발생합니다.
• 만약 parentId를 지정하고 자식 댓글의 notificationSentForParent가 false인 경우, 부모 댓글에 대한 알림을 전송합니다. 이 작업은 매 시간 수행됩니다(전송되는 이메일 수를 줄이기 위해 알림을 일괄 처리합니다).
• 사용자를 생성할 때 환영 이메일을 보내거나 댓글 확인 이메일을 보내려면 쿼리 매개변수에서 sendEmails를 true로 설정하세요.
• 이 API로 생성된 댓글은 관리자 앱의 Analytics 및 Moderation 페이지에 표시됩니다.
• 설정이 켜져 있으면 "bad words"는 댓글 작성자 이름과 댓글 내용에서 여전히 마스킹됩니다.
• 원하면 이 API로 생성된 댓글은 스팸 검사를 받을 수 있습니다.
• Customization Rule 관리자 페이지에서 구성된 최대 댓글 길이 같은 설정은 여기에도 적용됩니다.

댓글 위젯에 표시되기 위해 제출에 필요한 최소 데이터는 다음과 같습니다:

최소 댓글 POST cURL 예제

Copy

1

2curl --request POST \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "approved": true,

7 "comment": "some-comment",

8 "commenterName": "some-commenter-name",

9 "date": 1622644382148,

10 "urlId": "some-place",

11 "url": "https://exmaple.com/some-page",

12 "verified": true

13}'

14

더 현실적인 요청 예시는 다음과 같습니다:

댓글 POST cURL 예제

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&isLive=true&doSpamCheck=true' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "approved": true,

7 "avatarSrc": "https://static.fastcomments.com/1605337537848-DSC_0841.JPG",

8 "comment": "some-comment",

9 "commenterName": "some-commenter-name",

10 "commenterEmail": "fordperfect@spaceship.com",

11 "date": 1622644382148,

12 "isSpam": false,

13 "locale": "en_us",

14 "notificationSentForParent": true,

15 "notificationSentForParentTenant": true,

16 "reviewed": true,

17 "urlId": "some-place",

18 "url": "https://exmaple.com/some-page",

19 "verified": true,

20 "votes": 1,

21 "votesUp": 2,

22 "votesDown": 1,

23 "ip": "123.456.789.000"

24}'

25

댓글 POST 요청 구조

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** 댓글이 동일한 urlId를 가진 댓글 위젯 인스턴스를 보는 사용자에게 "라이브"로 표시될지 여부. 참고: 크레딧 비용이 1에서 2로 두 배가 됩니다. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

댓글 POST 응답 구조

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-comment' | 'comment-too-big' | 'hash-tags-readonly' | 'mentions-readonly' | 'invalid-user' | 'unauthorized' | 'invalid-date' | 'invalid-name' | 'invalid-name-is-email' | 'banned' | 'invalid-email';

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9 /** 생성된 댓글. **/

10 comment?: Comment

11 /** 관련된 사용자로, 기존에 존재했을 수도 있고 없었을 수도 있습니다. **/

12 user?: User

13}

14

이 API 엔드포인트는 단일 댓글을 업데이트할 수 있는 기능을 제공합니다.

참고:

• 이 API는 원하면 댓글 위젯을 "실시간"으로 업데이트할 수 있습니다(기본 creditsCost가 1에서 2로 증가합니다).
  • 이를 통해 댓글을 페이지 간에 "실시간"으로 이동(예: urlId 변경)할 수 있습니다.
  • 페이지가 미리 계산되므로 마이그레이션은 추가로 2 크레딧이 소모되며 CPU 집약적입니다.
• 생성 API와 달리, 이 API는 이메일이 제공되더라도 우리 시스템에 사용자 객체를 자동으로 생성하지 않습니다.
• 이 API로 업데이트된 댓글은 원하면 스팸 검사 대상이 될 수 있습니다.
• 최대 댓글 길이와 같은 구성은 Customization Rule 관리자 페이지에서 구성된 경우 여기에도 적용됩니다.
• 사용자가 자신의 댓글 텍스트를 업데이트할 수 있도록 하려면 요청 본문에 단순히 comment를 지정하면 됩니다. 우리는 결과 commentHTML을 생성합니다.
  • comment와 commentHTML을 모두 정의하면 HTML을 자동으로 생성하지 않습니다.
  • 사용자가 새 텍스트에 멘션이나 해시태그를 추가하면 POST API와 같이 처리됩니다.
• 댓글의 commenterEmail을 업데이트할 때는 userId도 함께 지정하는 것이 가장 좋습니다. 그렇지 않으면 해당 이메일을 가진 사용자가 귀하의 테넌트에 속하는지 확인해야 하며, 그렇지 않으면 요청이 실패합니다.
• 대상 댓글이 잠겨 있는 경우(isLocked: true) 요청은 code: 'locked'로 거부됩니다. 먼저 댓글의 잠금을 해제하고 업데이트한 다음 필요하면 다시 잠그십시오.

최소 댓글 PATCH cURL 예제

Copy

1

2curl --request PATCH \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "comment": "some-new-comment-text"

7}'

8

댓글 PATCH 요청 구조

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 업데이트를 수행하는 사용자. 필요하면 이 값을 사용해 댓글을 수정할 수 있는지 확인할 수 있습니다. **/

6 contextUserId?: string

7 /** 새 댓글이 스팸으로 보이는지 검사할까요? **/

8 doSpamCheck?: 'true' | 'false'

9 /** 같은 urlId를 사용하는 댓글 위젯 인스턴스에서 사용자가 댓글을 "실시간"으로 보게 할지 여부. NOTE: 크레딧 비용이 1에서 2로 두 배가 됩니다. **/

10 isLive?: 'true' | 'false'

11}

12

댓글 PATCH 응답 구조

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-comment' | 'comment-too-big' | 'hash-tags-readonly' | 'mentions-readonly' | 'invalid-user' | 'unauthorized' | 'invalid-date' | 'invalid-name' | 'invalid-name-is-email' | 'banned' | 'invalid-email' | 'invalid-input' | 'missing-id' | 'not-found' | 'locked'

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9}

10

이 API 엔드포인트는 댓글을 삭제할 수 있는 기능을 제공합니다.

참고:

• 원하는 경우 이 API는 댓글 위젯을 "라이브"로 업데이트할 수 있습니다 (이 경우 creditsCost가 1에서 2로 증가합니다).
• 이 API는 모든 자식 댓글을 삭제합니다.
• 대상 댓글이 잠금 상태(isLocked: true)이면 요청은 code: 'locked'로 거부됩니다. 먼저 댓글의 잠금을 해제한 후 삭제하세요.

댓글 삭제 cURL 예제

Copy

1

2curl --request DELETE \

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

4 --header 'Content-Type: application/json'

5

댓글 삭제 요청 구조

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 업데이트를 수행하는 사용자입니다. 원하는 경우 그 사용자가 댓글을 삭제할 수 있는지 확인하는 데 사용할 수 있습니다. **/

6 contextUserId?: string

7 /** 동일한 urlId를 가진 댓글 위젯 인스턴스를 보고 있는 사용자들에게 댓글을 "라이브"로 삭제할지 여부입니다. 참고: 크레딧 비용이 1에서 2로 두 배가 됩니다. **/

8 isLive?: 'true' | 'false'

9}

10

댓글 삭제 응답 구조

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

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

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9}

10

이 API 엔드포인트는 특정 사용자를 위해 댓글을 신고할 수 있는 기능을 제공합니다.

Notes:

• 이 호출은 항상 사용자 컨텍스트에서 이루어져야 합니다. 사용자는 FastComments.com 사용자, SSO 사용자, 또는 테넌트 사용자가 될 수 있습니다.
• 숨김 임계값(flag-to-hide threshold)이 설정되어 있으면, 댓글이 정의된 횟수만큼 신고되면 실시간으로 자동으로 숨김 처리됩니다.
• 댓글이 자동으로 미승인(숨김) 처리된 후에는 관리자나 모더레이터만이 댓글을 다시 승인할 수 있습니다. 플래그 해제는 댓글을 다시 승인하지 않습니다.

댓글 신고 cURL 예제

Copy

1

2curl --request POST \

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

4 --header 'Content-Type: application/json'

5

For anonymous flagging, we must specify an anonUserId. This can be an ID that represents the anonymous session, or a random UUID. This allows us to support flagging and un-flagging comments even if a user is not logged in. This way, the comment can be marked as flagged when comments are fetched with the same anonUserId.

익명 댓글 신고 cURL 예제

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

댓글 신고 요청 구조

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

댓글 신고 응답 구조

Copy

1

2

3interface CommentFlagResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

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

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9 /** 댓글이 너무 많이 신고되어 미승인(숨김) 처리되었나요? **/

10 wasUnapproved?: boolean;

11}

12

이 API 엔드포인트는 특정 사용자가 댓글의 플래그를 해제할 수 있는 기능을 제공합니다.

참고:

• 이 호출은 항상 사용자 컨텍스트에서 이루어져야 합니다. 사용자는 FastComments.com 사용자, SSO 사용자, 또는 테넌트 사용자가 될 수 있습니다.
• 댓글이 자동으로 미승인(숨김)된 이후에는 해당 댓글을 다시 승인할 수 있는 사람은 관리자 또는 중재자뿐입니다. 플래그 해제는 댓글을 다시 승인하지 않습니다.

댓글 플래그 해제 cURL 예제

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \

4 --header 'Content-Type: application/json'

5

익명 플래그의 경우 anonUserId를 지정해야 합니다. 이는 익명 세션을 나타내는 ID이거나 임의의 UUID일 수 있습니다.

익명 댓글 플래그 해제 cURL 예제

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-flag?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

댓글 플래그 해제 요청 구조

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

댓글 플래그 해제 응답 구조

Copy

1

2

3interface CommentUnFlagResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

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

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9}

10

이 API 엔드포인트는 특정 댓글을 작성한 사용자를 차단할 수 있는 기능을 제공합니다. FastComments.com 사용자, SSO 사용자, Tenant 사용자가 작성한 댓글로부터의 차단을 지원합니다.

이 호출은 commentIdsToCheck 바디 파라미터를 지원하여, 이 작업 수행 후 클라이언트에 표시될 수 있는 다른 댓글들이 차단/차단 해제되어야 하는지 확인할 수 있습니다.

Notes:

• 이 호출은 항상 사용자 컨텍스트에서 이루어져야 합니다. 사용자는 FastComments.com 사용자, SSO 사용자, 또는 Tenant 사용자일 수 있습니다.
• 요청의 userId는 차단을 행하는 사용자입니다. 예: User A가 User B를 차단하려고 합니다. userId=User A와 User B가 작성한 댓글의 id를 전달하세요.
• 완전히 익명인 댓글(사용자 id 없음, 이메일 없음)은 차단할 수 없으며 에러가 반환됩니다.

댓글 차단 cURL 예제

Copy

1

2curl --request POST \

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

4 --header 'Content-Type: application/json'

5

익명 차단의 경우 anonUserId를 지정해야 합니다. 이는 익명 세션을 나타내는 ID이거나 임의의 UUID일 수 있습니다. 이를 통해 사용자가 로그인하지 않은 경우에도 동일한 anonUserId로 댓글을 가져와 댓글을 차단하는 것을 지원할 수 있습니다.

익명 댓글 차단 cURL 예제

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

댓글 차단 요청 구조

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

댓글 차단 응답 구조

Copy

1

2

3interface CommentBlockResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9 /** commentIdsToCheck가 정의된 경우, 이 맵에서 true인 항목들도 차단됩니다. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

이 API 엔드포인트는 특정 댓글을 작성한 사용자의 차단을 해제할 수 있는 기능을 제공합니다. FastComments.com 사용자, SSO 사용자, 및 테넌트 사용자가 작성한 댓글에서의 차단 해제를 지원합니다.

이 작업이 수행된 후 클라이언트에서 잠재적으로 표시되는 다른 댓글들이 차단/차단 해제되어야 하는지 확인하기 위해 commentIdsToCheck 바디 매개변수를 지원합니다.

참고:

• 이 호출은 항상 사용자의 맥락에서 이루어져야 합니다. 사용자는 FastComments.com 사용자, SSO 사용자, 또는 테넌트 사용자일 수 있습니다.
• 요청의 userId는 차단을 해제하는 사용자입니다. 예를 들어: User A가 User B의 차단을 해제하려고 합니다. userId=User A와 User B가 작성한 댓글 ID를 전달하세요.
• 완전히 익명인 댓글(사용자 id 없음, 이메일 없음)은 차단할 수 없으며 오류가 반환됩니다.

댓글 차단 해제 cURL 예시

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=some-user-id' \

4 --header 'Content-Type: application/json'

5

익명 댓글 차단 해제 cURL 예시

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/comments/some-comment-id/un-block?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-anon-user-id' \

4 --header 'Content-Type: application/json'

5

댓글 차단 해제 요청 구조

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

댓글 차단 해제 응답 구조

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'missing-user-id' | 'missing-anon-user-id' | 'comment-cannot-be-blocked'

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9 /** commentIdsToCheck가 정의되어 있으면, 이 맵에서 true인 항목들은 여전히 차단된 상태입니다. false인 경우에는 사용자가 새로고침할 필요가 없도록 댓글의 숨김을 해제해 줄 수 있습니다. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

개별 EmailTemplate는 해당 id(emailTemplateId가 아님)로 가져올 수 있습니다.

ID로 EmailTemplate cURL 예제

Copy

1

2curl --request GET \

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

4

ID로 EmailTemplate 요청 구조

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

ID로 EmailTemplate 응답 구조

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

이 API는 페이지 매김을 사용하며, page 쿼리 매개변수로 제공합니다. EmailTemplates는 100개씩 페이지로 반환되며, createdAt과 그 다음으로 id로 정렬됩니다.

EmailTemplate cURL 예제

Copy

1

2curl --request GET \

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

4

EmailTemplate 요청 구조

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 가져올 페이지로, 0부터 시작합니다. **/

6 page: number

7}

8

EmailTemplate 응답 구조

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

이 API 엔드포인트는 id와 업데이트할 속성만 지정하여 이메일 템플릿을 업데이트할 수 있는 기능을 제공합니다.

템플릿을 생성할 때와 동일한 모든 유효성 검사가 적용된다는 점에 유의하세요. 예를 들어:

• 템플릿은 렌더링되어야 합니다. 각 업데이트 시 이것이 확인됩니다.
• 동일한 도메인에 대해 중복된 템플릿을 가질 수 없습니다(그렇지 않으면 하나가 조용히 무시됩니다).

EmailTemplate PATCH cURL 예제

Copy

1

2curl --request PATCH \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "displayName": "Some New Name",

7}'

8

EmailTemplate PATCH 요청 구조

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate PATCH 응답 구조

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'not-found' | 'unexpected-param' | 'invalid-email-template-id' | 'unauthorized' | 'domain-invalid' | 'duplicate' | 'does-not-render';

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9 /** 업데이트된 이메일 템플릿. **/

10 emailTemplate?: EmailTemplate

11}

12

이 API 엔드포인트는 이메일 템플릿을 생성하는 기능을 제공합니다.

Notes:

• 같은 도메인에서는 동일한 emailTemplateId를 가진 템플릿을 여러 개 가질 수 없습니다.
• 하지만 와일드카드 템플릿(domain = *)과 동일한 emailTemplateId에 대한 도메인별 템플릿을 동시에 가질 수 있습니다.
• 여러 도메인이 있거나 테스트용으로 특정 템플릿을 사용하려는 경우(예: domain을 localhost로 설정) 에만 domain을 지정하면 됩니다.
• 만약 domain을 지정하면 해당 값은 DomainConfig와 일치해야 합니다. 오류가 발생하면 유효한 도메인 목록이 제공됩니다.
• 템플릿 문법은 EJS이며 500ms 타임아웃으로 렌더링됩니다. 렌더링의 P99는 <5ms 이므로 500ms에 도달하면 문제가 있는 것입니다.
• 저장하려면 템플릿이 주어진 testData로 렌더링되어야 합니다. 렌더링 오류는 집계되어 대시보드에 보고됩니다(곧 API를 통해서도 제공될 예정입니다).

템플릿을 추가하는 데 필요한 최소 데이터는 다음과 같습니다:

최소 EmailTemplate POST cURL 예제

Copy

1

2curl --request POST \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."

9}'

10

사이트별 템플릿을 원할 경우 domain을 정의할 수 있습니다:

EmailTemplate POST cURL 예제

Copy

1

2curl --request POST \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is some email content!",

9 "domain": "somespecificsite.com",

10}'

11

EmailTemplate POST 요청 구조

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate POST 응답 구조

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'invalid-email-template-id' | 'domain-invalid' | 'duplicate' | 'does-not-render';

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9 /** 생성된 템플릿. **/

10 emailTemplate?: EmailTemplate

11}

12

이 API 엔드포인트는 이메일 템플릿을 미리 볼 수 있는 기능을 제공합니다.

최소 EmailTemplate 미리보기 POST cURL 예제

Copy

1

2curl --request POST \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "emailTemplateId": "comment-user-mention",

7 "displayName": "I'm a custom template.",

8 "ejs": "This is an @mention notification! My name is <%= comment.commenterName %>."

9}'

10

EmailTemplate POST 요청 구조

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate POST 응답 구조

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** 실패 시 포함됩니다. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'unexpected-param' | 'does-not-render';

7 /** 실패 시 포함됩니다. **/

8 reason?: string

9 /** 성공 시 렌더링된 HTML. **/

10 html?: string

11}

12

이 경로는 id로 단일 EmailTemplate를 제거합니다.

EmailTemplate 제거 cURL 예제

Copy

1

2curl --request DELETE \

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

4

EmailTemplate 제거 요청 구조

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

EmailTemplate 제거 응답 구조

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8}

9

피드의 게시물을 최신 순으로 가져옵니다. 페이지네이션은 커서 기반이며, 마지막으로 받은 게시물의 _id를 afterId로 전달하여 다음 페이지를 가져옵니다.

반환된 10개의 게시물당 1크레딧이 소모되며, 최소 1크레딧이 차감됩니다.

FeedPost cURL 예제

Copy

1

2curl --request GET \

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

4

FeedPost 요청 구조

Copy

1

2interface FeedPostsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 이 게시물 ID 이후의 게시물을 반환합니다. 첫 페이지의 경우 생략합니다. **/

6 afterId?: string

7 /** 기본값은 10이며, 최대값은 1000입니다. **/

8 limit?: number

9 /** 이 태그가 있는 게시물만 반환합니다. 여러 태그를 지정하려면 매개변수를 반복합니다. **/

10 tags?: string[]

11}

12

FeedPost 응답 구조

Copy

1

2interface FeedPostsResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'limit-invalid' | 'internal'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 feedPosts: FeedPost[]

9}

10

이 라우트는 단일 FeedPost를 생성합니다. 모든 게시물에는 작성자가 있으므로 fromUserId가 필요하며, 이는 계정에 존재하는 FastComments 또는 SSO 사용자의 ID여야 합니다.

FeedPost 생성 cURL 예시

Copy

1

2curl --request POST \

3 --url 'https://fastcomments.com/api/v1/feed-posts?tenantId=demo&isLive=true&API_KEY=DEMO_API_SECRET' \

4 --header 'Content-Type: application/json' \

5 --data '{

6 "fromUserId": "some-user-id",

7 "title": "Release 2.0 is out",

8 "contentHTML": "<p>Read the notes and tell us what you think.</p>",

9 "tags": ["releases"],

10 "links": [

11 {

12 "url": "https://example.com/releases/2.0",

13 "title": "Release notes",

14 "description": "Everything that changed in 2.0."

15 }

16 ]

17}'

18

FeedPost 생성 요청 구조

Copy

1

2interface FeedPostPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 현재 브라우저에서 열려 있는 피드에 게시물을 푸시합니다. 기본값은 false입니다. **/

6 isLive?: boolean

7 /** 저장하기 전에 스팸 엔진을 통해 게시물을 실행합니다. 기본값은 false입니다. **/

8 doSpamCheck?: boolean

9 /** doSpamCheck의 일부로 실행되는 중복 콘텐츠 검사를 건너뜁니다. 기본값은 false입니다. **/

10 skipDupCheck?: boolean

11 /** 최대 256자. 실시간 청취자에게 에코되어 클라이언트가 자신의 방송을 무시할 수 있습니다. **/

12 broadcastId?: string

13}

14

15interface FeedPostPostBody {

16 /** 필수. FastComments 또는 SSO 사용자 ID. **/

17 fromUserId: string

18 title?: string

19 /** HTML. 저장 시 정제됩니다. **/

20 contentHTML?: string

21 /** 사용자에게서 가져온 표시 이름을 재정의합니다. **/

22 fromUserDisplayName?: string

23 tags?: string[]

24 media?: FeedPostMediaItem[]

25 links?: FeedPostLink[]

26 meta?: Record<string, string>

27}

28

FeedPost 생성 응답 구조

Copy

1

2interface FeedPostPostResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

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

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 feedPost?: FeedPost; // 성공 시 전체 생성된 게시물을 반환합니다.

9}

10

이 라우트는 단일 FeedPost를 업데이트합니다. 변경하려는 필드만 전송하세요.

FeedPost 업데이트 cURL 예시

Copy

1

2curl --request PATCH \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "title": "Release 2.0.1 is out",

7 "tags": ["releases", "hotfix"]

8}'

9

FeedPost 업데이트 요청 구조

Copy

1

2interface FeedPostPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

7/** FeedPost 구조에서 쓸 수 있는 모든 필드. **/

8type FeedPostPatchBody = Partial<Pick<FeedPost, 'title' | 'contentHTML' | 'fromUserDisplayName' | 'tags' | 'weight' | 'meta' | 'media' | 'links'>>

9

FeedPost 업데이트 응답 구조

Copy

1

2interface FeedPostPatchResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'internal'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8}

9

이 API는 page 쿼리 매개변수로 페이지네이션을 제공합니다. HashTags는 tag로 정렬되어 페이지당 100개씩 반환됩니다.

HashTag cURL 예제

Copy

1

2curl --request GET \

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

4

HashTag 요청 구조

Copy

1

2interface HashTagsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 가져올 페이지 (0부터 시작). **/

6 page: number

7}

8

HashTag 응답 구조

Copy

1

2interface HashTagsResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 /** 해시태그들! **/

9 hashTags: HashTag[]

10}

11

이 경로는 단일 HashTag를 업데이트할 수 있는 기능을 제공합니다.

HashTag 업데이트 cURL 예제

Copy

1

2curl --request PATCH \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "url": "https://example.com/some-`page`"

7}'

8

HashTag 업데이트 요청 구조

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

HashTag 업데이트 응답 구조

Copy

1

2interface HashTagPatchResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag' | 'already-exists'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 hashTag?: HashTag; // 성공 시 업데이트된 전체 해시태그를 반환합니다.

9}

10

이 라우트는 단일 HashTag를 추가하는 기능을 제공합니다.

HashTag 생성 cURL 예제

Copy

1

2curl --request POST \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "tag": "#example",

7 "url": "https://example.com/some-page"

8}'

9

HashTag 생성 요청 구조

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

HashTag 생성 응답 구조

Copy

1

2interface HashTagPostResponse {

3 status: 'success' | 'failed'

4 /** 실패 시 포함됩니다. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-hash-tag' | 'tag-does-not-exist' | 'url-too-long' | 'invalid-tag'

6 /** 실패 시 포함됩니다. **/

7 reason?: string

8 hashTag?: HashTag; // 성공 시 생성된 전체 해시태그를 반환합니다.

9}

10

이 경로는 최대 100개의 HashTag 객체를 한 번에 추가할 수 있는 기능을 제공합니다.

HashTag 일괄 생성 cURL 예제

Copy

1

2curl --request PATCH \

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

4 --header 'Content-Type: application/json' \

5 --data '{

6 "tags": [

7 {

8 "tag": "#example",

9 "url": "https://example.com/some-page"

10 }

11 ]

12}'

13

HashTag 일괄 생성 요청 구조

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6