ライブコメント API

リソース使用量

APIからデータを取得することは、アカウントの使用量としてカウントされることに注意してください。

各リソースは、その使用量をそれぞれのセクションで示します。

リソースによって提供コストが異なります。各エンドポイントには、API呼び出しごとのクレジットの固定コストがあります。一部のエンドポイントでは、オプションやレスポンスサイズに応じてクレジット数が変動します。

API使用量は請求分析ページで確認でき、数分ごとに更新されます。

注意！

コメントAPIでurlIdに渡す値を決定する際の混乱を防ぐため、まずPagesのドキュメントを読むことをお勧めします。

Webhook

Webhookサブスクリプションには独自のガイドがあります。POST、GET、DELETE /api/v1/webhooks、およびGET /api/v1/webhooks/sample-payloadsはAPIでのサブスクリプション管理で、イベントペイロードはWebhook構造で文書化されています。

FastCommentsはOAuth 2.1認可サーバーです。アプリケーションは1つのFastCommentsアカウントに紐付けられたトークンを取得し、このガイドのすべてのエンドポイントでAPIキーの代わりに使用できます。Zapierアプリ、MCPサーバー、およびその他のサードパーティ統合は、この方法で接続します。

トークンはPKCEを用いた認可コードフローを通じて発行されます。クライアントクレデンシャルやインプリシットグラントはありません。

ディスカバリー

エンドポイントの場所、サポートされているグラント、および認証方法は、標準のメタデータ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 をissuerとして使用します。

クライアントの登録

クライアントは、フローを開始する前に client_id と登録済みの redirect_uri が必要です。取得するには2つの方法があります:

• 動的クライアント登録。 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を取得し、同じメタデータフィールドを読み取ります。登録呼び出しは不要です。

Zapierなど、FastCommentsダッシュボードに表示されるパートナーアプリケーションは、FastCommentsによって直接登録されます。マーケットプレイスへの掲載を構築していて、ファーストパーティクライアントが必要な場合は、サポートにお問い合わせください。

スコープ

スコープ

Copy

1

2read GET and HEAD requests

3write every other method

4

スコープを要求しないリクエストには両方が付与されます。ユーザーには、同意ページで要求されたスコープが表示されます。これら2つ以外のスコープを要求すると、invalid_scope で失敗します。

ステップ1 - 認可リクエスト

ユーザーのブラウザを認可エンドポイントに誘導します。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 /** Must exactly match one of the client's registered redirect URIs. **/

6 redirect_uri: string

7 /** Space separated. Omit to request both scopes. **/

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

9 /** Returned unchanged on the redirect. Use it to bind the callback to the session that started the flow. **/

10 state?: string

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

12 code_challenge: string

13 code_challenge_method: 'S256'

14 /** Optional RFC 8707 resource indicator. If sent, the same value must be sent to the token endpoint. **/

15 resource?: string

16}

17

必要に応じてユーザーがFastCommentsにサインインすると、アプリケーション名、接続先のアカウント、要求されたスコープを示す同意ページが表示されます。ユーザーはそのアカウントでAPI Admin権限を持っている必要があります。それ以外のユーザーには、同意フォームの代わりに権限エラーが表示されます。承認すると、code と state 付きでブラウザが redirect_uri にリダイレクトされます。拒否すると、error=access_denied 付きでリダイレクトされます。

認可コードは10分間有効で、1回のみ交換できます。同じコードを2回目に交換すると、最初の交換で発行されたすべてのトークンが失効します。

ステップ2 - トークンリクエスト

コードをトークンと交換します。ボディはフォームエンコードです。機密クライアントは 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 /** Confidential clients only. May be sent as HTTP Basic auth instead. **/

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 /** Prefixed fcat_. Valid for one hour. **/

4 access_token: string

5 token_type: 'bearer'

6 /** Seconds until the access token expires. 3600. **/

7 expires_in: number

8 /** Prefixed fcrt_. Valid for 30 days from issue. **/

9 refresh_token: string

10 /** Space separated scopes granted. **/

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。

ステップ3 - APIの呼び出し

アクセストークンをベアラートークンとして送信します。テナントはトークンから推測されるため、tenantId は省略可能です。指定する場合はトークンと一致している必要があり、一致しないとリクエストは失敗します。

ベアラートークン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を返します。

ステップ4 - 更新

更新リクエスト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 /** Optional. Narrows to a subset of the scopes originally granted. **/

8 scope?: string

9 resource?: string

10}

11

レスポンスはコード交換と同じ形式です。リフレッシュトークンはローテーションします: 各更新は新しい refresh_token を返し、同時リクエスト用の30秒の猶予期間の後、古いトークンを失効させます。30秒以上前にローテーションされたリフレッシュトークンの提示はリプレイとみなされ、グラント全体が失効します。FastCommentsによって登録されたパートナーアプリケーションはローテーションが免除され、有効期限がさらに30日延長された同じリフレッシュトークンが返されます。

更新時には、認可ユーザーが引き続きアカウントのAPI Admin権限を持っているかも再確認されます。持っていない場合、グラントは失効し、レスポンスは invalid_grant になります。

失効

失効リクエスト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ダッシュボードの接続済みアプリから接続を失効させることもできます。そのアプリケーションのすべてのトークンは直ちに機能しなくなります。

このAPIは、ドキュメントをグループ化（groupByが提供されている場合）し、複数の操作を適用して集計を行います。 sum、countDistinct、avg などのさまざまな操作がサポートされています。

コストは可変です。500件のオブジェクトをスキャンするごとに1 APIクレジットが消費されます。

デフォルトでは、APIコールごとの最大メモリ使用量は64MBで、デフォルトでは同時に実行できる集計は1つだけです。複数の集計を同時に送信すると、それらはキューに入り、送信された順に実行されます。保留中の集計は最大60秒待機し、それを超えるとリクエストはタイムアウトします。個々の集計は最大で5分間実行される場合があります。

管理されたテナントがある場合、parentTenantId クエリパラメータを渡すことで、子テナントのリソースを1回の呼び出しでまとめて集計できます。

例

例: 一意のカウント

一意の値のカウント 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

例: countDistinct（重複を除くカウント）

重複を除く値のカウント 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

構造

集計リクエスト構造

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

集計レスポンス構造

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

この API は、skip、limit、before、after パラメータによるページネーションを使用します。AuditLogs はデフォルトで 1000 件ずつのページで返され、最大 limit は 10000 です。when と id の順序で並びます。このエンドポイントは通常、履歴を一括取得するために使用され、対話的にページングするためではないため、ページは大きくなります。

返される 100 件のログごとにクレジットコストは 1 です。

デフォルトでは、最新の項目が最初 のリストが返されます。この方法では、skip=0 からポーリングを開始し、取得した最後のレコードが見つかるまでページングできます。

あるいは、古い順にソートし、レコードがなくなるまでページングできます。

order を ASC または DESC に設定することでソートできます。デフォルトは DESC です。

before と after をミリ秒単位のタイムスタンプとして使用することで日付でのクエリが可能です。before と after は含まれません（排他的）で、どちらか単独でも使用できます。

人に何が起きたかを確認する

すべてのイベントは、実行者（username、userId、ip）と、実行対象を別々に記録します。targetLabel はそのオブジェクトの人間が読めるラベルで、例として jsmith (jsmith@example.com) のようになります。targetId はその ID です。ID が分からなくても人物の名前やメールアドレスが分かる場合は、target を使用してラベルの大文字小文字を区別しない部分文字列検索を行います。

削除イベントはその時点のラベルを記録するため、基になるレコードが削除された後でも、削除されたユーザーやモデレーターを特定できます。

管理テナント

テナントが他のテナントを管理している場合、includeManagedTenants=true を設定すると、あなたのテナントと管理下のすべてのテナントからのイベントを1つのレスポンスで返します。返される各ログの tenantId が、どのテナントからのものかを示します。

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 /** 最大 10000。デフォルトは 1000。 **/

7 limit?: number

8 skip?: number

9 before?: number

10 after?: number

11 /** このユーザー名で実行されたイベントのみ。 **/

12 username?: string

13 /** この IP アドレスからのイベントのみ。 **/

14 ip?: string

15 /** このタイプのイベントのみ。 **/

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

17 /** このリソース（例: User または Moderator）に対するイベントのみ。 **/

18 resourceName?: string

19 /** 対象オブジェクトがこの ID を持つイベントのみ。 **/

20 targetId?: string

21 /** 対象オブジェクトのラベルに対する大文字小文字を区別しない部分文字列マッチ。 **/

22 target?: string

23 /** このテナントが管理するテナントからのイベントも返す。 **/

24 includeManagedTenants?: boolean

25}

26

AuditLog 応答構造

Copy

1

2interface AuditLogsResponse {

3 status: 'success' | 'failed'

4 /** 失敗時に含まれます。 **/

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

6 /** 失敗時に含まれます。 **/

7 reason?: string

8 /** ログです！ **/

9 auditLogs: AuditLog[]

10}

11

このエンドポイントはテナントのすべてのタイプのバッチジョブを、最新順に最大 100 件ずつページングして返します。type と status を使用してリストを絞り込み、skip でページングできます。

BatchJob リスト cURL 例

Copy

1

2curl --request GET \

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

4

BatchJob リスト リクエスト構造

Copy

1

2interface BatchJobsQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** このタイプのジョブのみ、例: migrate-pages。 **/

6 type?: string

7 status?: 'requested' | 'running' | 'success' | 'failed'

8 /** ページングのためにスキップするジョブ数。負でない整数。 **/

9 skip?: number

10}

11

BatchJob リスト レスポンス構造

Copy

1

2interface BatchJobsResponse {

3 status: 'success' | 'failed'

4 /** 失敗時に含まれます。 **/

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

6 /** 失敗時に含まれます。 **/

7 reason?: string

8 /** 最新順、最大 100 件。 **/

9 batchJobs?: BatchJob[]

10}

11

このエンドポイントは、バッチジョブのステータス、進行状況、そして完了した場合は結果を返します。POST /api/v1/pages/migrations または POST /api/v1/pages/migrations/:undoId/undo によって開始されたジョブの進捗を確認するために使用します。

ジョブは status が success または failed のときに完了とみなされます。各呼び出しは 1 クレジット消費するため、継続的にポーリングするのではなく、数秒ごとにポーリングしてください。

IDで取得するバッチジョブ cURL例

Copy

1

2curl --request GET \

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

4

IDで取得するバッチジョブ リクエスト構造

Copy

1

2interface BatchJobQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

IDで取得するバッチジョブ レスポンス構造

Copy

1

2interface BatchJobResponse {

3 status: 'success' | 'failed'

4 /** Included on failure. **/

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

6 /** Included on failure. **/

7 reason?: string

8 batchJob?: BatchJob

9}

10

完了したページ移行ジョブの例

Copy

1

2{

3 "status": "success",

4 "batchJob": {

5 "id": "my-batch-job-id",

6 "type": "migrate-pages",

7 "status": "success",

8 "createdAt": "2026-10-19T16:00:00.000Z",

9 "completedAt": "2026-10-19T16:00:12.000Z",

10 "processedCount": 2,

11 "totalCount": 2,

12 "pageMigrationResults": [

13 {"from": "old-post-id", "to": "new-post-id", "type": "urlId", "status": "success", "commentsMigrated": 42},

14 {"from": "old.example.com", "to": "new.example.com", "type": "domain", "status": "success", "commentsMigrated": 1250}

15 ],

16 "undoId": "my-undo-id"

17 }

18}

19

この API は、ユーザーに表示するためのコメントを取得するために使用されます。たとえば、未承認またはスパムコメントを自動的に除外します。

ページネーション

ページネーションは、パフォーマンス要件とユースケースに応じて、次の 2 つの方法のいずれかで実行できます。

1. 最速: 事前計算ページネーション:
   1. これは、事前に構築されたウィジェットとクライアントを使用する際の FastComments の動作方式です。
   2. 「次へ」をクリックすると、単にページ番号が増えます。
   3. これはキー・バリュー・ストアから取得されるものと考えてください。
   4. この方法では、page パラメータを 0 から開始し、ソート方向を direction として定義するだけです。
   5. ページサイズはカスタマイズルールで調整できます。
2. 最も柔軟: 柔軟なページネーション:
   1. この方法では、カスタムの limit と skip パラメータを定義できます。page は渡さないでください。
   2. ソート direction もサポートされています。
   3. limit は、skip が適用された後に返す総数です。
      • 例: page size = 100 で page = 2 の場合、skip = 200, limit = 100 と設定します。
   4. 子コメントもページネーションにカウントされます。asTree オプションを使用して回避できます。
      • limitChildren と skipChildren で子コメントをページネーションできます。
      • maxTreeDepth で返されるスレッドの深さを制限できます。

スレッド

1. Precalculated Pagination を使用する場合、コメントは ページ ごとにグループ化され、スレッド内のコメントは全体のページに影響します。
   1. この方法では、parentId に基づいてクライアント側でスレッドを判定できます。
   2. 例として、トップレベルコメントが 1 件で 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 を設定します。

ツリーの説明

asTree を使用する場合、ページネーションの考え方が難しいことがあります。便利な図をご覧ください。

ツリーページネーション図

ユーザーコンテキストでのコメント取得

/comments API は、異なるユースケースに応じて 2 つのコンテキストで使用できます。

• 独自クライアント構築のために、ソートされ情報がタグ付けされたコメントを返す場合。
  • この場合、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

ツリー形式のコメント取得

コメントをツリーとして返すことが可能で、ページネーションはトップレベルコメントのみをカウントします。

ユーザーコンテキストでのコメント ツリー形式

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 プロパティが付与されます。

ハッシュタグで検索するツリー形式のコメント取得

API を使用してハッシュタグで検索することが可能です。テナント全体（特定のページや 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

すべてのリクエストパラメータ

コメント リクエスト構造

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

レスポンス

コメント レスポンス構造

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

便利なヒント

URL ID

おそらく Comment API を urlId パラメータと共に使用したいでしょう。まず Pages API を呼び出すことで、利用可能な urlId の値がどのようなものか確認できます。

匿名アクション

匿名コメントの場合、コメント取得時やフラグ付け・ブロック操作時に anonUserId を渡すことが望ましいでしょう。

(!) これは多くのアプリストアで必須です。ユーザーはログインしていなくても閲覧できるユーザー生成コンテンツにフラグを付けられる必要があります。これを行わないと、アプリが該当ストアから削除される可能性があります。

コメントが返されない場合

コメントが承認済みであり、スパムでないことを確認してください。

この 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はシステム内にユーザーオブジェクトを自動的に作成します。
• 異なるメールアドレスで同じユーザー名のコメントを2件保存しようとすると、2つ目のコメントでエラーになります。
• parentId を指定していて、子コメントの notificationSentForParent が false の場合、親コメントに対して通知を送信します。これは毎時間行われます（送信されるメール数を減らすために通知をまとめて送信します）。
• ユーザー作成時に歓迎メールを送信したり、コメント検証メールを送信したい場合は、クエリパラメータで sendEmails を true に設定してください。
• このAPIで作成されたコメントは、管理アプリの Analytics および Moderation ページに表示されます。
• 設定がオンになっている場合、コメント投稿者の名前やコメント本文の「悪い言葉」はマスクされます。
• この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を変更する）ことができます。
  • 移行はページが事前計算されるためCPU負荷が高く、追加で2クレジットがかかります。
• 作成APIと異なり、このAPIはメールアドレスが提供されてもユーザーオブジェクトを自動的に作成しません。
• このAPIで更新されたコメントは、必要に応じてまだスパムチェックの対象にできます。
• カスタマイズルール管理ページで設定された最大コメント長などの設定はここでも適用されます。
• ユーザーにコメントテキストの更新を許可するには、リクエストボディに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を持つコメントウィジェットのインスタンスを見ているユーザーにコメントを「ライブ」で表示するかどうか。注意: クレジットコストが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エンドポイントはコメントを削除する機能を提供します。

Notes:

• 必要に応じて、このAPIはコメントウィジェットをライブで更新できます（これにより creditsCost が 1 から 2 に増加します）。
• このAPIはすべての子コメントを削除します。
• 対象のコメントがロックされている場合（isLocked: true）、リクエストは code: 'locked' で拒否されます。先にコメントのロックを解除してから削除してください。

コメント DELETE 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

コメント DELETE リクエスト構造

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** 更新を行うユーザー。必要に応じて、そのユーザーがコメントを削除できるかどうか確認するために使用できます。 **/

6 contextUserId?: string

7 /** 同じ urlId を持つコメントウィジェットのインスタンスを閲覧しているユーザーに対して、コメントを「ライブ」で削除するかどうか。NOTE: クレジットコストが `1` から `2` に倍増します。 **/

8 isLive?: 'true' | 'false'

9}

10

コメント DELETE レスポンス構造

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 エンドポイントは、特定のユーザーのためにコメントにフラグを付ける機能を提供します。

注意:

• この呼び出しは常にユーザーのコンテキストで行う必要があります。ユーザーは FastComments.com のユーザー、SSO ユーザー、またはテナントユーザーであり得ます。
• フラグで非表示にする閾値が設定されている場合、定義された回数フラグが付けられるとコメントは自動的にライブで非表示になります。
• 自動的に非承認（非表示）された後、コメントを再承認できるのは管理者またはモデレーターのみです。フラグを解除してもコメントは再承認されません。

コメントのフラグ付け 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

匿名でフラグを付ける場合、anonUserId を指定する必要があります。これは匿名セッションを表す ID やランダムな UUID にすることができます。これにより、ユーザーがログインしていない場合でもコメントのフラグ付け/フラグ解除をサポートできます。つまり、同じ 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 エンドポイントは、特定のユーザーのコメントのフラグ解除を行う機能を提供します。

Notes:

• この呼び出しは常にユーザーのコンテキストで行う必要があります。ユーザーは 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 ユーザー、およびテナントユーザーによって書かれたコメントからのブロックをサポートします。

この操作の実行後に、クライアント上で他に表示されている可能性のあるコメントをブロック/ブロック解除すべきかを確認するための 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/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エンドポイントはメールテンプレートを作成する機能を提供します。

注意:

• 同じドメイン内で同じ emailTemplateId を持つテンプレートを複数作成することはできません。
• しかしワイルドカードテンプレート（domain = *）と同じ emailTemplateId に対するドメイン固有のテンプレートを共存させることはできます。
• domain を指定するのは、異なるドメインごとにテンプレートを持ちたい場合や、テスト用に特定のテンプレートを使いたい場合（例：domain を localhost に設定）にのみ関連します。
• 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