FastComments の API
FastComments は多数のリソースとやり取りするための API を提供しています。プラットフォームと統合を構築したり、独自のクライアントを作成したりできます！
このドキュメントでは、API がサポートするすべてのリソースを、リクエストとレスポンスの型とともに記載しています。
エンタープライズ顧客向けに、すべての API アクセスは監査ログに記録されます。
生成された SDK
FastComments はコードから API 仕様 を生成するようになりました（まだ完全ではありませんが、多くの API が含まれています）。
We also now have SDKs for popular languages:
- fastcomments-cpp
- fastcomments-go
- fastcomments-java
- fastcomments-sdk-js
- fastcomments-nim
- fastcomments-php
- fastcomments-php-sso
- fastcomments-python
- fastcomments-ruby
- fastcomments-rust
- fastcomments-swift
認証
API は、API キー を X-API-KEY ヘッダーまたは API_KEY クエリパラメータのいずれかとして渡すことで認証されます。API 呼び出しには tenantId も必要です。これは API キー と同じページから取得できます。
セキュリティに関する注意
これらのルートはサーバーから呼び出すことを想定しています。ブラウザから呼び出さないでください。そうすると API キーが公開されてしまい、ページのソースコードを閲覧できる誰にでもアカウントへの完全なアクセス権が与えられてしまいます！
認証オプション 1 - ヘッダー
- ヘッダー:
X-API-KEY - ヘッダー:
X-TENANT-ID
認証オプション 2 - クエリパラメータ
- クエリパラメータ:
API_KEY - クエリパラメータ:
tenantId
APIリソース 
リソース使用量
API からデータを取得する行為は、お客様のアカウントの使用量としてカウントされる点にご注意ください。
各リソースは、その使用量を個別のセクションに記載しています。
リソースによっては、提供にかかるコストが高いものがあります。各エンドポイントには API 呼び出しごとに固定のクレジットコストが設定されています。いくつかのエンドポイントでは、オプションやレスポンスのサイズに応じて必要なクレジット数が変動します。
API の使用状況は 請求アナリティクス ページで確認でき、数分ごとに更新されます。
注意!
Comment API で urlId に渡す値を決める際の混乱を減らすため、まず Pages のドキュメントをお読みになることをお勧めします。
データを集計する
Resource: Aggregate as GET /api/v1/aggregate Credit Cost: 1
この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
監査ログの構造
AuditLog はこの機能にアクセスできるテナントの監査イベントを表すオブジェクトです。
AuditLog オブジェクトの構造は次のとおりです:
AuditLog の構造
Copy
1
2interface AuditLog {
3 id: string;
4 userId?: string;
5 username?: string;
6 resourceName: string;
7 crudType: 'c' | 'r' | 'u' | 'd' | 'login';
8 from: string;
9 url?: string;
10 ip?: string;
11 when: string;
12 description?: string;
13 serverStartDate: string;
14 objectDetails?: object;
15}
16
監査ログは不変です。手動で書き込むこともできません。FastComments.com のみが監査ログに書き込むタイミングを決定できます。ただし、この API を通じて読み取ることはできます。
監査ログ内のイベントは2年で期限切れになります。
GET /api/v1/audit-logs
Resource: AuditLog as GET /api/v1/audit-logs Credit Cost: 10
この API はページネーションを使用します。ページネーションは skip、before、after パラメータで行います。AuditLogs は 1000 件ずつのページで返され、when と id によって順序付けられます。
毎回 1000 件のログを取得するにはクレジット 10 が必要です。
デフォルトでは、最新の項目が先に来るリストが返されます。これにより、skip=0 からポーリングを開始し、最後に消費したレコードが見つかるまでページネーションできます。
あるいは、古い順でソートして、レコードがなくなるまでページネーションすることもできます。
ソートは order を ASC または DESC のいずれかに設定して行います。デフォルトは ASC です。
日付でのクエリは、ミリ秒単位のタイムスタンプとしての before と after で可能です。before と after は含まれません。
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 CommentsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 order?: 'ASC' | 'DESC'
6 skip?: number
7 before?: number
8 after?: number
9}
10
AuditLog レスポンス構造
Copy
1
2interface CommentsResponse {
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 auditLogs: AuditLog[]
10}
11
コメントの構造
A Comment オブジェクトは、ユーザーが残したコメントを表します。
親コメントと子コメントの関係は parentId を通じて定義されます。
Comment オブジェクトの構造は次のとおりです:
コメント構造
Copy
1
2interface Comment {
3 /** 読み取り専用: スパムエンジンがコメントをスパムと判定した場合に true に設定されます。 **/
4 aiDeterminedSpam?: boolean
5 /** コメントが表示承認されているか。コメント保存時に true に設定されます。そうでない場合は非表示になります。 **/
6 approved?: boolean
7 /** ユーザーのアバター。 **/
8 avatarSrc?: string
9 /** 子コメント。すべてのシナリオで設定されるわけではありません。API で asTree を true にした場合に使用されます。 **/
10 children: Comment[]
11 /** コメント投稿者の生のコメント。 **/
12 comment: string
13 /** 読み取り専用: コメント投稿者のコメントを HTML に変換したもの。 **/
14 commentHTML?: string
15 /** コメント投稿者のメールアドレス。匿名コメントが無効の場合は必須です。 **/
16 commenterEmail?: string
17 /** コメント投稿者のリンク（例: ブログ）。 **/
18 commenterLink?: string
19 /** コメント投稿者の名前。常に必須です。利用できない場合は「Anonymous」などに設定してください。 **/
20 commenterName: string
21 /** コメントが残された日付（UTC エポック）。 **/
22 date: number
23 /** コメントの「表示ラベル」— 例えば「Admin」「Moderator」や「VIP User」など。 **/
24 displayLabel?: string
25 /** コメントが投稿されたドメイン。 **/
26 domain?: string
27 /** 読み取り専用: コメントが通報された回数。 **/
28 flagCount?: number
29 /** コメント内で成功裏に解析された #ハッシュタグ。クエリのためにハッシュタグを手動で追加することもできますが、コメント本文には自動的には表示されません。 **/
30 hashTags?: CommentHashTag[]
31 /** 読み取り専用: コメントに画像が含まれているか。 **/
32 hasImages?: boolean
33 /** 読み取り専用: コメントにリンクが含まれているか。 **/
34 hasLinks?: boolean
35 /** 読み取り専用: ユニークなコメント ID。 **/
36 id: string
37 /** 作成時のみ！保存のためにハッシュされます。 **/
38 ip?: string
39 /** 読み取り専用: 現在のユーザーがこのコメントを書いたユーザーをブロックしているか（contextUserId）。 **/
40 isBlocked?: boolean
41 /** 読み取り専用: コメントが管理者によるものか。userId に基づいて自動設定されます。 **/
42 isByAdmin?: boolean
43 /** 読み取り専用: コメントがモデレーターによるものか。userId に基づいて自動設定されます。 **/
44 isByModerator?: boolean
45 /** コメントがソフト削除された場合（何らかの別の設定のためプレースホルダを残す必要があった場合）に true に設定されます。 **/
46 isDeleted?: boolean
47 /** ユーザーのアカウントが削除され、コメントを保持する必要があった場合に true に設定されます。 **/
48 isDeletedUser?: boolean
49 /** 読み取り専用: 現在ログインしているユーザー（contextUserId）によって通報されたか。 **/
50 isFlagged?: boolean
51 /** コメントがピン留めされているか。 **/
52 isPinned?: boolean
53 /** 新しい返信ができないようにロックされているか（モデレーターは引き続き返信可能）。 **/
54 isLocked?: boolean
55 /** コメントがスパムかどうか。 **/
56 isSpam?: boolean
57 /** 読み取り専用: 現在のユーザー（contextUserId）によるダウン投票か。 **/
58 isVotedDown?: boolean
59 /** 読み取り専用: 現在のユーザー（contextUserId）によるアップ投票か。 **/
60 isVotedUp?: boolean
61 /** コメントの言語ロケール。指定がない場合は HTTP の言語受け入れヘッダから決定されます。 **/
62 locale?: 'de_de' | 'en_us' | 'es_es' | 'fr_fr' | 'it_it' | 'ja_jp' | 'ko_kr' | 'pl_pl' | 'pt_br' | 'ru_ru' | 'tr_tr' | 'zh_cn' | 'zh_tw'
63 /** 読み取り専用: コメント内で成功裏に解析された @メンション。 **/
64 mentions?: CommentUserMention[]
65 /** コメントに関連付けられたオプションのメタデータ。 **/
66 meta?: Record<string, string | number | boolean>
67 /** このコメントに関連付けられたモデレーショングループ ID のオプションリスト。 **/
68 moderationGroupIds?: string[]|null
69 /** 読み取り専用: このコメントに対して現在のユーザー（contextUserId）が行った投票に対応する vote オブジェクトの ID。 **/
70 myVoteId?: string
71 /** このコメントに対して返信者向けの通知が送信されたか。インポート時に通知を送らないようにするには、これを true に設定します。 **/
72 notificationSentForParent?: boolean
73 /** テナントユーザー向けの通知が送信されたか。インポート時に通知を送らないようにするには、これを true に設定します。 **/
74 notificationSentForParentTenant?: boolean
75 /** このコメントがあったページのタイトル。 **/
76 pageTitle?: string
77 /** 返信している場合、返信先のコメント ID。 **/
78 parentId?: string|null
79 /** コメントがレビュー済みとしてマークされているか。 **/
80 reviewed: boolean
81 /** コメントが属するテナント ID。 **/
82 tenantId: string
83 /** コメントを書いたユーザー。名前/メールでコメントを保存すると自動的に作成されます。 **/
84 userId?: string|null
85 /** このコメントが表示される場所（例: ブログ記事）の URL。 **/
86 url: string
87 /** あなたが渡した urlId の「クリーン」なバージョン。保存時にはこのフィールドを指定しますが、コメントを取得するときには「クリーン」化され、元の値は "urlIdRaw" に移されます。 **/
88 urlId: string
89 /** 読み取り専用: あなたが渡した元の urlId。 **/
90 urlIdRaw?: string
91 /** ユーザーとこのコメントが検証済みか。 **/
92 verified: boolean
93 /** 賛成票の数。 **/
94 votesUp?: number
95 /** 反対票の数。 **/
96 votesDown?: number
97 /** コメントの「カルマ」（= 賛成票 - 反対票）。 **/
98 votes?: number
99}
100
これらのフィールドの一部は READONLY としてマークされています — これらは API によって返されますが、設定することはできません。
コメントテキストの構造
コメントは FastComments 仕様のマークダウンで記述されます。これはマークダウンに、画像用の従来の bbcode スタイルタグ（[img]path[/img] のような）を追加したものです。
テキストは 2 つのフィールドに保存されます。ユーザーが入力したテキストは修正されず comment フィールドに保存されます。これがレンダリングされ、commentHTML フィールドに保存されます。
許可されている HTML タグは b, u, i, strike, pre, span, code, img, a, strong, ul, ol, li, and br です。
HTML は非常に限定されたサブセットなので、HTML をレンダリングすることを推奨します。レンダラーを作るのは比較的簡単です。例えば React Native や Flutter 用のライブラリがいくつかあります。
comment フィールドの正規化されていない値をレンダリングすることも選択できます。 例のパーサーはこちら。
この例のパーサーは HTML に合わせて調整し、HTML タグをプラットフォームでレンダリングするための期待される要素に変換することもできます。
タギング
ユーザーがコメント内でタグ付けされた場合、その情報は mentions と呼ばれるリストに保存されます。リスト内の各オブジェクトは次の構造を持ちます。
コメントのメンションオブジェクト
Copy Run 
Run 1
2interface CommentUserMention {
3 /** ユーザー ID。SSO ユーザーの場合はテナント ID がプレフィックスとして付与されます。 **/
4 id: string
5 /** 最終的な @メンションのタグテキスト（@ 記号を含む）。 **/
6 tag: string
7 /** 元の @メンションのタグテキスト（@ 記号を含む）。 **/
8 rawTag: string
9 /** タグ付けされたユーザーのタイプ。user = FastComments.com アカウント、sso = SSOUser。 **/
10 type: 'user'|'sso'
11 /** ユーザーが通知をオプトアウトしている場合でも、これは true に設定されます。 **/
12 sent: boolean
13}
14
ハッシュタグ
ハッシュタグが使用され、正常に解析された場合、その情報は hashTags と呼ばれるリストに保存されます。リスト内の各オブジェクトは次の構造を持ちます。retain が設定されている場合、ハッシュタグはクエリ用にコメントの hashTags 配列に手動で追加することもできます。
コメントのハッシュタグオブジェクト
Copy Run
Run 1
2interface CommentHashTag {
3 /** ハッシュタグ ID。 **/
4 id: string
5 /** 最終的な #ハッシュタグのタグテキスト（# 記号を含む）。 **/
6 tag: string
7 /** ハッシュタグがカスタム URL に関連付けられている場合、ここに定義されます。 **/
8 url?: string
9 /** コメントが更新されたときに、コメント本文に存在しない場合でもハッシュタグを保持するか。コメントテキストを変更せずにコメントにタグ付けする場合に便利です。 **/
10 retain?: boolean
11}
12
GET /api/v1/comments
Resource: Comment as GET /api/v1/comments Credit Cost: 1
この API はユーザーに表示するためのコメントを取得するために使用されます。例えば、承認されていないコメントやスパムコメントを自動的にフィルタリングします。
Pagination
ページネーションは、パフォーマンス要件やユースケースに応じて、次のいずれかの方法で行うことができます:
- Fastest: Precalculated Pagination:
- これは、当社の事前構築されたウィジェットやクライアントを使用する場合に FastComments が動作する方法です。
- 「次へ」をクリックすると単にページ数が増加します。
- これはキー・バリュー ストアから取得されるように考えることができます。
- この方法では、
pageパラメータを0から開始して定義し、ソート方向をdirectionとして指定します。 - ページサイズはカスタマイズルールで変更できます。
- Most Flexible: Flexible Pagination:
- この方法ではカスタムの
limitとskipパラメータを定義できます。pageを渡さないでください。 - ソートの
directionもサポートされています。 limitはskipを適用した後に返される合計数です。- 例:
page size = 100かつpage = 2の場合、skip = 200, limit = 100を設定します。
- 例:
- 子コメントもページネーションにカウントされます。
asTreeオプションを使うことでこれを回避できます。limitChildrenとskipChildrenにより子のページネーションが可能です。maxTreeDepthにより返されるスレッドの深さを制限できます。
- この方法ではカスタムの
Threads
Precalculated Paginationを使用する場合、コメントは page ごとにグループ化され、スレッド内のコメントは全体のページに影響します。- この方法では、クライアントは
parentIdに基づいてスレッドを判断できます。 - 例えば、あるページにトップレベルのコメントが1件とその返信が29件あり、API に
page=0を設定すると、トップレベルのコメント1件と29件の子コメントが返されます。 - Example image here illustrating multiple pages.
- この方法では、クライアントは
Flexible Paginationを使用する場合、parentIdパラメータを定義できます。- トップレベルのコメントのみを取得するにはこれを null に設定してください。
- スレッドを表示するには、再度 API を呼び出して
parentIdを渡します。 - 一般的な解決方法としては、トップレベルのコメント用に API 呼び出しを行い、その後各コメントの子コメントを取得するために並列の API 呼び出しを行う方法があります。
- 新機能（2023年2月）!
&asTree=trueを使用してツリーとして取得できます。- これは
Flexible Pagination as a Treeと考えることができます。 - ページネーションにはトップレベルのコメントのみがカウントされます。
- ツリーをルートから開始するには
parentId=nullを設定してください（parentIdを設定する必要があります）。 - ページネーションには
skipとlimitを設定してください。 asTreeをtrueに設定してください。- このシナリオではバックエンドがより多くの処理を行うため、クレジットコストが
2xに増加します。 - 必要に応じて
maxTreeDepth、limitChildren、skipChildrenを設定してください。
- これは
Trees Explained
asTree を使用するとページネーションの考え方が分かりにくくなることがあります。参考になる図はこちらです:
ツリーページネーション図
Fetching Comments in The Context of a User
/comments API は、異なるユースケースに対して 2 つのコンテキストで使用できます:
- 自身のクライアントを構築するための情報でソートおよびタグ付けされたコメントを返す場合。
- この場合は query パラメータに
contextUserIdを定義してください。
- この場合は query パラメータに
- カスタム統合のためにバックエンドからコメントを取得する場合。
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
API を使用してハッシュタグで検索することが可能で、テナント全体（1 ページや 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 /** The urlId (page url, or article id) the comments are associated with. **/
6 urlId?: string
7 /** Limit the comments returned by this user. **/
8 userId?: string
9 /** Use this to search by hashtag. To drill down to the intersection of multiple hashtags, do &hashTag=a&hashTag=b. **/
10 hashTag?: string
11 /** The sort direction. Default is MR (Most Relevant). Other options are OF (Oldest First) and NF (Newest First). **/
12 direction?: 'MR' | 'OF' | 'NF'
13 /** Precalculated Pagination: The page to fetch, starting with 0. Pass -1 for all comments (up to 250). **/
14 page?: number
15 /** Flexible Pagination: How many comments should we return? **/
16 limit?: number
17 /** Flexible Pagination: How many child comments should we return for each parent? **/
18 limitChildren?: number
19 /** Flexible Pagination: How many comments should we skip? **/
20 skip?: number
21 /** Flexible Pagination: How many child comments should we skip for each parent? **/
22 skipChildren?: number
23 /** For determining blocked and flagged comments. **/
24 contextUserId?: string
25 /** For determining blocked and flagged comments. **/
26 anonUserId?: string
27 /** For fetching child comments. **/
28 parentId?: string
29 /** For fetching as a tree. **/
30 asTree?: boolean
31 /** How far into the tree should we return data? 0 returns no children. 1 returns immediate children, etc. **/
32 maxTreeDepth?: number
33}
34
The Response
コメントレスポンス構造
Copy
1
2interface CommentsResponse {
3 status: 'success' | 'failed'
4 /** Included on failure. **/
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 /** Included on failure. **/
7 reason?: string
8 /** The comments! **/
9 comments: Comment[]
10}
11
Helpful Tips
URL ID
おそらく Comment API を urlId パラメータと一緒に使用したいでしょう。まず Pages API を呼び出して、利用可能な urlId の値がどのようになっているかを確認できます。
Anonymous Actions
匿名でコメントする場合、コメントの取得時やフラグ付け・ブロックを行う際に anonUserId を渡すことをお勧めします。
(!) これは多くのアプリストアで必須です。ユーザーはログインしていなくても、自分が見えるユーザー生成コンテンツを通報できる必要があります。これを行わないと、アプリが当該ストアから削除される可能性があります。
Comments Not Being Returned
コメントが承認されており、スパムではないことを確認してください。
GET /api/v1/comments/:id
Resource: Comment as GET /api/v1/comments/:id Credit Cost: 1
この 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
POST /api/v1/comments
Resource: Comment as POST /api/v1/comments Credit Cost: 1
この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
PATCH /api/v1/comments/:id
Resource: Comment as PATCH /api/v1/comments/:id Credit Cost: 1
この API エンドポイントは単一のコメントを更新する機能を提供します。
Notes:
- 必要に応じて、この API はコメントウィジェットを「ライブ」で更新できます（これにより基本の
creditsCostが1から2に増加します）。- これにより、ページ間のコメント移行を「ライブ」で行うことができます（
urlIdの変更）。 - この移行はページが事前計算され CPU 負荷が高いため、追加で
2クレジットがかかります。
- これにより、ページ間のコメント移行を「ライブ」で行うことができます（
- 作成 API と異なり、この API はメールが提供されても当社システム内にユーザーオブジェクトを自動で作成しません。
- この API を介して更新されたコメントでも、必要に応じてスパムチェックが可能です。
- カスタマイズルール管理ページで設定された最大コメント長などの設定はここにも適用されます。
- ユーザーがコメント本文を更新できるようにするには、リクエストボディに
commentを指定するだけです。結果のcommentHTMLを生成します。commentとcommentHTMLの両方を定義した場合、HTML は自動生成されません。- ユーザーが新しいテキストにメンションやハッシュタグを追加した場合でも、
POSTAPI と同様に処理されます。
- コメントの
commenterEmailを更新する際は、userIdも指定するのが最善です。そうでない場合は、このメールアドレスのユーザーがあなたのテナントに属していることを確認する必要があります。そうでなければリクエストは失敗します。
最小のコメント 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'
7 /** 失敗時に含まれる。 **/
8 reason?: string
9}
10
DELETE /api/v1/comments/:id
Resource: Comment as DELETE /api/v1/comments/:id Credit Cost: 1
このAPIエンドポイントはコメントを削除するための機能を提供します。
Notes:
- このAPIは、必要に応じてコメントウィジェットを「ライブ」で更新できます（これにより
creditsCostが1から2に増加します）。 - このAPIはすべての子コメントを削除します。
コメント 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 のコメントウィジェットのインスタンスを閲覧しているユーザーに対してコメントを「ライブ」で削除するかどうか。注: クレジットコストが 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'
7 /** 失敗時に含まれます。 **/
8 reason?: string
9}
10
POST /api/v1/comments/:id/flag
Resource: Comment as POST /api/v1/comments/:id/flag Credit Cost: 1
この 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
POST /api/v1/comments/:id/un-flag
Resource: Comment as POST /api/v1/comments/:id/un-flag Credit Cost: 1
この 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
POST /api/v1/comments/:id/block
Resource: Comment as POST /api/v1/comments/:id/block Credit Cost: 1
この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
POST /api/v1/comments/:id/un-block
Resource: Comment as POST /api/v1/comments/:id/un-block Credit Cost: 1
この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
メールテンプレートの構造
An EmailTemplate object represents configuration for a custom email template, for a tenant.
The system will select the email template to use via:
- Its type identifier, we call this
emailTemplateId. These are constants. - The
domain. We will first try to find a template for the domain that the related object (like aComment) is tied to, and if a match is not found then we will try to find a template where domain is null or*.
The structure for the EmailTemplate object is as follows:
メールテンプレートの構造
Copy
1
2interface EmailTemplate {
3 id: string
4 tenantId: string
5 emailTemplateId: string
6 displayName: string
7 /** 読み取り専用 **/
8 createdAt: string
9 /** 読み取り専用 **/
10 updatedAt: string
11 /** 読み取り専用 **/
12 updatedByUserId: string
13 /** テンプレートが関連付けられるドメイン。 **/
14 domain?: string | '*' | null
15 /** EJS 構文で記述されたメールテンプレートの内容。 **/
16 ejs: string
17 /** サポートされている各ロケールごとの、上書きされた翻訳キーから値へのマップ。 **/
18 translationOverridesByLocale: Record<string, Record<string, string>>
19 /** テンプレートのレンダリングコンテキストを表すオブジェクト。 **/
20 testData: object
21}
22
注意
- You can get the valid
emailTemplateIdvalues from the/definitionsendpoint. - The
/definitionsendpoint also includes the default translations and test data. - Templates will fail to save with invalid structure or test data.
GET /api/v1/email-templates/:id
Resource: EmailTemplate as GET /api/v1/email-templates/:id Credit Cost: 1
個々の 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
GET /api/v1/email-templates
Resource: EmailTemplate as GET /api/v1/email-templates Credit Cost: 1
このAPIはページネーションを使用しており、page クエリパラメータで指定します。EmailTemplates は 100 件ごとのページで返され、createdAt の後に id で並びます。
EmailTemplate の cURL 例
Copy
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
PATCH /api/v1/email-templates/:id
Resource: EmailTemplate as PATCH /api/v1/email-templates/:id Credit Cost: 1
この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
POST /api/v1/email-templates
Resource: EmailTemplate as POST /api/v1/email-templates Credit Cost: 1
このAPIエンドポイントはメールテンプレートを作成する機能を提供します。
注意:
- 同じドメイン内で同じ
emailTemplateIdを持つテンプレートを複数作成することはできません。 - しかしワイルドカードテンプレート（
domain=*）と同じemailTemplateIdに対するドメイン固有のテンプレートを共存させることはできます。 domainを指定するのは、異なるドメインごとにテンプレートを持ちたい場合や、テスト用に特定のテンプレートを使いたい場合（例：domainをlocalhostに設定）にのみ関連します。domainを指定する場合、その値はDomainConfigと一致している必要があります。エラー時には有効なドメインの一覧が提供されます。- テンプレート構文は EJS で、レンダリングには 500ms のタイムアウトが設定されています。レンダリングの P99 は <5ms なので、500ms に到達する場合は何か問題があります。
- 保存するにはテンプレートが指定した
testDataでレンダリングされる必要があります。 レンダリングエラーは集約されダッシュボードで報告されます（API でまもなく利用可能になります）。
テンプレートを追加するために必要な最小データは次のとおりです:
最小 EmailTemplate POST cURL の例
Copy
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
POST /api/v1/email-templates/render
Resource: EmailTemplate as POST /api/v1/email-templates/render Credit Cost: 1
この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
DELETE /api/v1/email-templates/:id
Resource: EmailTemplate as DELETE /api/v1/email-templates/:id Credit Cost: 1
このルートは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
ハッシュタグの構造
A HashTag オブジェクトはユーザーが残すことのできるタグを表します。ハッシュタグは外部のコンテンツへのリンクに使用したり、関連するコメントを結びつけるために使用できます。
The structure for the HashTag object is as follows:
HashTag 構造
Copy
1
2interface HashTag {
3 /** "#" または任意の指定文字で始める必要があります。 **/
4 tag: string
5 /** ハッシュタグが指すオプションのURL。ハッシュタグでコメントをフィルタリングする代わりに、UIはクリック時にこのURLへリダイレクトします。 **/
6 url?: string
7 /** 読み取り専用 **/
8 createdAt: string
9}
10
Notes:
- In some API endpoints you will see that the hashtag is used in the URL. Remember to URI-Encoded values. For example,
#should instead be represented as%23. - Some of these fields are marked
READONLY- these are returned by the API but cannot be set.
GET /api/v1/hash-tags
Resource: HashTag as GET /api/v1/hash-tags Credit Cost: 1
この API はページネーションを使用します。page クエリパラメータで指定します。ハッシュタグは tag によって並べ替えられ、1ページあたり 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
PATCH /api/v1/hash-tags/:tag
Resource: HashTag as PATCH /api/v1/hash-tags/:tag Credit Cost: 1
このルートは単一の 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
POST /api/v1/hash-tags
Resource: HashTag as POST /api/v1/hash-tags Credit Cost: 1
このルートは単一の 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
POST /api/v1/hash-tags/bulk
Resource: HashTag as POST /api/v1/hash-tags/bulk Credit Cost: 1
このルートは一度に最大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
HashTag バルク作成 レスポンス構造
Copy
1
2interface HashTagBulkPostResponse {
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 results?: HashTagPostResponse[]; // 提供された各タグに対して HashTagPostResponse オブジェクトのリストを返します。
9}
10
DELETE /api/v1/hash-tags/:tag
Resource: HashTag as DELETE /api/v1/hash-tags/:tag Credit Cost: 1
このルートは、指定されたタグによって HashTag ユーザーを削除します。
自動的な HashTag 作成が無効になっていない限り、ユーザーがコメント時にハッシュタグを指定すると、ハッシュタグは再作成される可能性があることに注意してください。
HashTag 削除 cURL の例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/hash-tags/%23example_hash_tag?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
HashTag 削除リクエスト構造
Copy
1
2interface HashTagDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
HashTag 削除レスポンス構造
Copy
1
2interface HashTagDeleteResponse {
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'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
モデレーターの構造
A Moderator オブジェクトはモデレーターの設定を表します。
モデレーターには3つのタイプがあります:
isCommentModeratorAdminフラグを持つ管理者ユーザー。isCommentModeratorAdminフラグを持つSSOユーザー。- 招待された通常のコメント投稿者、またはFastComments.comのユーザー。
Moderator 構造はユースケース 3 のモデレーション状態を表すために使用されます。
ユーザーをモデレーターとしてAPI経由で招待したい場合は、Moderator APIを使用して Moderator を作成し、彼らを inviting してください。
ユーザーがFastComments.comアカウントを持っていない場合、招待メールがセットアップを手助けします。すでにアカウントを持っている場合は、テナントに対するモデレーションアクセスが付与され、Moderator オブジェクトの userId がそのユーザーを指すように更新されます。この場合、そのユーザーのAPIアクセスはあなたにはなく、FastComments.comによって管理されます。
ユーザーアカウントを完全に管理する必要がある場合は、SSOを使用するか、彼らをテナントユーザーとして追加し、その後に Moderator オブジェクトを追加して統計を追跡することをおすすめします。
Moderator 構造はユースケース 1 と 2 の統計追跡メカニズムとして使用できます。ユーザーを作成した後、userId を定義した Moderator オブジェクトを追加すると、彼らの統計がコメントモデレーターのページで追跡されます。
Moderator オブジェクトの構造は次のとおりです:
Moderator 構造
Copy
1
2interface Moderator {
3 name: string
4 email: string
5 tenantId: string
6 userId?: string|null
7 acceptedInvite?: boolean
8 markReviewedCount?: number
9 deletedCount?: number
10 markedSpamCount?: number
11 approvedCount?: number
12 editedCount?: number
13 bannedCount?: number
14 createdAt: string
15 moderationGroupIds?: string[]|null
16}
17
GET /api/v1/moderators/:id
Resource: Moderator as GET /api/v1/moderators/:id Credit Cost: 1
このルートは、id によって単一のモデレーターを返します。
IDによるモデレーターの cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
モデレーターのリクエスト構造
Copy
1
2interface ModeratorByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
モデレーターのレスポンス構造
Copy
1
2interface ModeratorByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 moderator?: Moderator
9}
10
GET /api/v1/moderators
Resource: Moderator as GET /api/v1/moderators Credit Cost: 1
このAPIはページネーションを使用しており、skip クエリパラメータで提供されます。モデレーターは 100 件ごとのページで返され、createdAt と id の順で並びます。
コストは返されるモデレーターの数に基づき、1 credit per 10 モデレーターごとに課金されます。
モデレーターの cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'
4
モデレーターのリクエスト構造
Copy
1
2interface ModeratorsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ページネーションのためにスキップするモデレーターの数。 **/
6 skip?: number
7}
8
モデレーターのレスポンス構造
Copy
1
2interface ModeratorsResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 moderators?: Moderator[]
9}
10
PATCH /api/v1/moderators/:id
Resource: Moderator as PATCH /api/v1/moderators/:id Credit Cost: 1
このAPIエンドポイントはidによってModeratorを更新する機能を提供します。
Moderatorの更新には以下の制限があります：
- 以下の値は
Moderatorの更新時に指定できません：acceptedInvitemarkReviewedCountdeletedCountmarkedSpamCountapprovedCounteditedCountbannedCountverificationIdcreatedAt
userIdが指定されている場合、そのユーザーは存在している必要があります。userIdが指定されている場合、そのユーザーはクエリパラメータで指定されたのと同じtenantIdに属している必要があります。- 同一テナント内で同じ
emailを持つモデレーターを2人追加することはできません。 Moderatorに関連付けられたtenantIdを変更することはできません。
Moderator PATCH cURL の例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some New Name",
7}'
8
Moderator PATCH リクエスト構造
Copy
1
2interface ModeratorPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Moderator PATCH レスポンス構造
Copy
1
2
3interface ModeratorPatchResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9}
10
POST /api/v1/moderators
Resource: Moderator as POST /api/v1/moderators Credit Cost: 1
このルートは単一の Moderator を追加する機能を提供します。
Moderator を作成する際の制限は次の通りです：
nameとemailは常に提供する必要があります。userIdは任意です。- Moderator を作成する際、次の値は指定できません：
acceptedInvitemarkReviewedCountdeletedCountmarkedSpamCountapprovedCounteditedCountbannedCountverificationIdcreatedAt
userIdが指定されている場合、そのユーザーは存在していなければなりません。userIdが指定されている場合、そのユーザーはクエリパラメータで指定されたのと同じtenantIdに属している必要があります。- 同じテナント内で、同一の
emailを持つモデレーターを二人追加することはできません。
メールアドレスのみが分かっているユーザーのために Moderator を作成できます：
メールでの Moderator 作成 cURL 例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some Name",
7 "email": "someone@someone.com"
8}'
9
または、当社のテナントに所属するユーザーのモデレーション統計を追跡するために Moderator を作成することもできます：
テナントユーザー経由での Moderator 作成 cURL 例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/moderators?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some Name",
7 "email": "someone@someone.com",
8 "userId": "some-tenant-user-id"
9}'
10
Moderator 作成リクエスト構造
Copy
1
2interface ModeratorPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Moderator 作成レスポンス構造
Copy
1
2interface ModeratorPostResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 moderator?: Moderator; // 成功時には作成されたモデレーター全体を返します。
9}
10
POST /api/v1/moderators/:id/send-invite
Resource: Moderator as POST /api/v1/moderators/:id/send-invite Credit Cost: 10
このルートは単一の Moderator を招待する機能を提供します。
招待メールを Moderator に送信するには次の制限があります:
Moderatorは既に存在している必要があります。fromNameは100 charactersを超えてはいけません。
注意:
- 指定したメールアドレスのユーザーが既に存在する場合、そのユーザーはテナントのコメントをモデレートするよう招待されます。
- 指定したメールアドレスのユーザーが 存在しない場合、招待リンクはアカウント作成の手順へ案内します。
- 招待は
30 days後に期限切れになります。
メールアドレスだけしか知らないユーザーのために Moderator を作成できます:
Moderator 招待の cURL 例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz/send-invite?tenantId=demo&API_KEY=DEMO_API_SECRET&fromName=Bob' \
4 --header 'Content-Type: application/json'
5
これにより Bob at TenantName is inviting you to be a moderator... のようなメールが送信されます。
Moderator 招待リクエストの構造
Copy
1
2interface ModeratorSendInviteQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ユーザーに送信されるメールはこの名前から送信されたように表示されます。 **/
6 fromName: string
7}
8
Moderator 招待レスポンスの構造
Copy
1
2interface ModeratorSendInviteResponse {
3 status: 'success' | 'failed'
4 /** Included on failure. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found | 'from-name-required' | 'from-name-invalid'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
DELETE /api/v1/moderators/:id
Resource: Moderator as DELETE /api/v1/moderators/:id Credit Cost: 5
このルートはIDによってModeratorを削除します。
Moderator 削除 cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/moderators/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Moderator 削除リクエスト構造
Copy
1
2interface ModeratorDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Moderator 削除レスポンス構造
Copy
1
2interface ModeratorDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
通知数の構造
NotificationCount オブジェクトはユーザーの未読通知数とメタデータを表します。
未読の通知がない場合、ユーザーに対する NotificationCount は存在しません。
NotificationCount オブジェクトは自動的に作成され、API経由で作成することはできません。これらは1年で期限切れになります。
ユーザーの未読通知数は、その NotificationCount を削除することでクリアできます。
NotificationCount オブジェクトの構造は次のとおりです:
NotificationCount の構造
Copy
1
2interface NotificationCount {
3 id: string // ユーザーID
4 count: number
5 createdAt: string // 日付文字列
6 expireAt: string // 日付文字列
7}
8
GET /api/v1/notification-count/:user_id
Resource: NotificationCount as GET /api/v1/notification-count/:user_id Credit Cost: 1
このルートはユーザーIDによる単一の NotificationCount を返します。SSO を使用している場合、ユーザーID は <tenant id>:<user id> の形式になります。
未読の通知がない場合、NotificationCount は存在しないため、404 が返されます。
notifications/count と異なり、本エンドポイントははるかに高速ですが、フィルタリングはできません。
ID による NotificationCount の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4# -> {"status":"success","data":{"count":1,"createdAt":"2023-03-06T18:45:01.726Z","expireAt":"2024-03-06T01:25:01.726Z","id":"example"}}
5
NotificationCount リクエスト構造
Copy
1
2interface NotificationCountGetQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
NotificationCount レスポンス構造
Copy
1
2interface NotificationCountGetResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 data?: NotificationCount
9}
10
DELETE /api/v1/notification-count/:user_id
Resource: NotificationCount as DELETE /api/v1/notification-count/:user_id Credit Cost: 1
このルートはユーザーIDで単一の NotificationCount を削除します。SSO を使用する場合、ユーザーID は <tenant id>:<user id> の形式です。
これによりユーザーの未読通知数がクリアされます（コメントウィジェットの赤いベルが薄くなり、カウントが消えます）。
DELETE NotificationCount の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/notification-count/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4# -> {"status":"success"}
5
NotificationCount 削除リクエスト構造
Copy
1
2interface NotificationCountDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
NotificationCount 削除レスポンス構造
Copy
1
2interface NotificationCountDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
通知の構造
Notificationオブジェクトはユーザーのための通知を表します。
Notificationオブジェクトは自動的に作成され、API経由で作成することはできません。これらはまた1年後に期限切れになります。
通知は削除できません。ただし、viewedをfalseに設定するよう更新することはでき、viewedでクエリすることができます。
ユーザーは、通知のoptedOutをtrueにすることで特定のコメントの通知をオプトアウトできます。再度受け取りたい場合はfalseに設定してください。
通知にはさまざまなタイプがあります — relatedObjectTypeとtypeを確認してください。
通知の作成方法は非常に柔軟で、多くのシナリオでトリガーされます（NotificationTypeを参照）。
現在、Notificationの存在がメールが送信される、または送信されるべきであることを意味するわけではありません。むしろ、通知は通知フィードおよび関連する統合で使用されます。
Notificationオブジェクトの構造は次のとおりです：
通知の構造
Copy
1
2enum NotificationObjectType {
3 Comment = 0,
4 Profile = 1,
5 Tenant = 2
6}
7
8enum NotificationType {
9 /** 誰かがあなたに返信した場合。 **/
10 RepliedToMe = 0,
11 /** あなたがコメントしたスレッド内のどこか（子の子も含む）で誰かが返信した場合。 **/
12 RepliedTransientChild = 1,
13 /** あなたのコメントがアップボートされた場合。 **/
14 VotedMyComment = 2,
15 /** あなたが購読しているページのルートに新しいコメントが残された場合。 **/
16 SubscriptionReplyRoot = 3,
17 /** 誰かがあなたのプロフィールにコメントした場合。 **/
18 CommentedOnProfile = 4,
19 /** ダイレクトメッセージ（DM）がある場合。 **/
20 DirectMessage = 5,
21 /** TrialLimitsはテナントユーザーのみ対象です。 **/
22 TrialLimits = 6,
23 /** あなたが@メンションされた場合。 **/
24 Mentioned = 7
25}
26
27interface Notification {
28 id: string
29 tenantId: string
30 /** SSOを使用する場合、ユーザーIDの形式は `<tenant id>:<user id>`です。 **/
31 userId?: string
32 /** SSOを扱う際は、`userId`のみ気にすればよいです。 **/
33 anonUserId?: string
34 /** urlIdはほとんどの場合定義されています。テナントレベルの通知の場合のみ省略可能で、これは稀です。 **/
35 urlId?: string
36 /** URLは通知のソースへ迅速に移動できるようキャッシュされます。 **/
37 url?: string
38 /** ページタイトルは通知のソースを素早く確認できるようキャッシュされます。 **/
39 pageTitle?: string
40 relatedObjectType: NotificationObjectType
41 /** 例えば、コメントID。 **/
42 relatedObjectId: string
43 viewed: boolean
44 createdAt: string // 日付文字列
45 type: NotificationType
46 fromCommentId?: string
47 fromVoteId?: string
48 /** fromUserNameとfromUserAvatarSrcは通知の表示を迅速に行うためにここでキャッシュされます。ユーザーが更新されるとこれらも更新されます。 **/
49 fromUserName: string
50 fromUserId: string
51 fromUserAvatarSrc?: string
52 /** これをtrueに設定するとこのオブジェクトの通知を受け取らなくなります。 **/
53 optedOut?: boolean
54}
55
GET /api/v1/notifications
Resource: Notification as GET /api/v1/notifications Credit Cost: 1
このルートは createdAt でソートされた最大30件の Notification オブジェクトを返します。新しいものが先に来ます。
userId でフィルタできます。SSO を使用する場合、ユーザーIDは <tenant id>:<user id> の形式です。
ユーザーの未読通知の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notifications?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false'
4
通知リクエスト構造
Copy
1
2interface NotificationsGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** レコードをスキップしてページングします。 **/
6 skip?: number
7 /** ユーザーでフィルタします。 **/
8 userId?: string
9 /** urlIdでフィルタします。 **/
10 urlId?: string
11 /** 元のコメントでフィルタします。 **/
12 fromCommentId?: string
13 /** 既読/未読でフィルタします。 **/
14 viewed?: 'true' | 'false'
15 /** タイプでフィルタします。 **/
16 type?: NotificationType
17}
18
通知レスポンス構造
Copy
1
2interface NotificationsGetResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 notifications?: Notification[]
9}
10
GET /api/v1/notifications/count
Resource: Notification as GET /api/v1/notifications/count Credit Cost: 2
このルートは、count パラメータの下に通知の数を含むオブジェクトを返します。
これは /notification-count/ より遅く、クレジットの消費は2倍ですが、より多くの次元でフィルタリングできます。
/notifications エンドポイントと同じパラメータ（例：userId）でフィルタリングできます。SSO を使用している場合、ユーザーID は <tenant id>:<user id> の形式になります。
ユーザーの未読通知数（cURL例）
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notifications/count?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false'
4
特定ページのユーザーの未読通知数（cURL例）
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/notifications/count?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID&viewed=false&urlId=some-article-id-or-url'
4
通知数リクエスト構造
Copy
1
2interface NotificationCountGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ユーザーでフィルタします。 **/
6 userId?: string
7 /** urlIdでフィルタします。 **/
8 urlId?: string
9 /** 元のコメントでフィルタします。 **/
10 fromCommentId?: string
11 /** 既読/未読でフィルタします。 **/
12 viewed?: 'true' | 'false'
13 /** タイプでフィルタします。 **/
14 type?: NotificationType
15}
16
通知数レスポンス構造
Copy
1
2interface NotificationCountGetResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 count?: number
9}
10
PATCH /api/v1/notifications/:id
Resource: Notification as PATCH /api/v1/notifications/:id Credit Cost: 1
この API エンドポイントは id によって Notification を更新する機能を提供します。
Notification の更新には次の制限があります:
- 次のフィールドのみ更新できます:
viewedoptedOut
Notification PATCH cURL の例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/notifications/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "viewed": false,
7}'
8
Notification PATCH リクエスト構造
Copy
1
2interface NotificationPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Notification PATCH レスポンス構造
Copy
1
2
3interface NotificationPatchResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9}
10
ページの構造
A Page object represents the page that many comments may belong to. This relationship is defined by
urlId.
A Page stores information such as the page title, comment count, and urlId.
The structure for the Page object is as follows:
ページ構造
Copy
1
2interface Page {
3 id: string
4 urlId: string
5 url: string
6 title?: string
7 createdAt: string
8 commentCount: number
9 rootCommentCount: number
10 /** これを null に設定すると、すべての SSO ユーザーがページを閲覧できます。空のリストは、すべてのユーザーに対して閉じられていることを意味します。 **/
11 accessibleByGroupIds?: string[] | null
12 /** このページは新しいコメントの受付を停止していますか？ **/
13 isClosed?: boolean
14}
15
GET /api/v1/pages
Resource: Page as GET /api/v1/pages Credit Cost: 10
現在、アカウントに関連付けられたページをすべて取得するか（または /by-url-id 経由で単一のページを取得する）ことのみ可能です。より細かい検索を希望する場合は、お問い合わせください。
Pages の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pages?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Pages リクエスト構造
Copy
1
2interface PagesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Pages レスポンス構造
Copy
1
2interface PagesResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 pages: Page[]
9}
10
役立つヒント
Comment API では urlId が必要です。まず Pages API を呼び出して、利用可能な urlId の値がどのようなものかを確認できます。
GET /api/v1/pages/by-url-id
Resource: Page as GET /api/v1/pages/by-url-id Credit Cost: 1
個々のページは対応するurlIdで取得できます。これはページタイトルやコメント数を照会する際に便利です。
URL IDによるページのcURL例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pages/by-url-id?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=example-id-or-url'
4
URL IDによるページのリクエスト構造
Copy
1
2interface PagesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 urlId: string
6}
7
URL IDによるページのレスポンス構造
Copy
1
2interface PagesResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 page?: Page[] | null
9}
10
役立つヒント
urlId のような値はURIエンコードすることを忘れないでください。
PATCH /api/v1/pages/:id
Resource: Page as PATCH /api/v1/pages/:id Credit Cost: 1
このルートは単一の Page を更新する機能を提供します。対応するコメントが更新されます。
ページ更新の cURL 例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/pages/my-page-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "url": "https://example.com/some-page"
7}'
8
ページ更新リクエスト構造
Copy
1
2interface PagePatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
ページ更新レスポンス構造
Copy
1
2interface PagePatchResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-id' | 'page-does-not-exist' | 'empty-request' | 'internal' | 'invalid-input' | 'invalid-title' | 'extra-params' | 'accessible-by-group-ids-not-array' | 'too-many-group-ids' | 'group-id-too-large'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user?: Page; // 成功時には更新されたページ全体を返します。
9}
10
注意
Pageオブジェクトの一部のパラメータは自動的に更新されます。これらは counts と title 属性です。Counts は更新できません
API 経由では、これらは計算された値であるためです。ページの title は API 経由で設定できますが、コメントウィジェットが
同じ urlId で異なるページタイトルのページで使用された場合は上書きされます。
POST /api/v1/pages
Resource: Page as POST /api/v1/pages Credit Cost: 1
このAPIエンドポイントはページを作成する機能を提供します。
一般的なユースケースはアクセス制御です。
注意事項:
- もしあなたがコメントスレッドにコメントしたり、
Commentを作成するためにAPIを呼び出した場合、既にPageオブジェクトが作成されています！同じurlIdをコメントウィジェットに渡したものを使って、/by-url-idのPageルートから取得してみてください。 Page構造にはいくつかの計算された値が含まれます。 現在はcommentCountとrootCommentCountです。 これらは自動で設定され、APIから設定することはできません。設定しようとするとAPIはエラーを返します。
Page POST cURL 例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/pages?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "title": "Test Page",
7 "url": "some0-url",
8 "urlId": "page2",
9 "accessibleByGroupIds": ["SOME_GROUP_ID"]
10}'
11
Page POST リクエスト構造
Copy
1
2interface PagePostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Page POST レスポンス構造
Copy
1
2
3interface PagePostResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'empty-request' | 'internal' | 'invalid-input' | 'invalid-title' | 'extra-params' | 'accessible-by-group-ids-not-array' | 'too-many-group-ids' | 'group-id-too-large';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9 /** 作成されたページ。 **/
10 page?: Page
11}
12
DELETE /api/v1/pages/:id
Resource: Page as DELETE /api/v1/pages/:id Credit Cost: 1
このルートは、idで指定された単一のページの削除を行います。
同じ urlId を持つページのコメントウィジェットに対して操作すると、その Page は単にシームレスに再作成されることに注意してください。
ページ削除のcURL例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/pages/some-page-id?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
ページ削除リクエスト構造
Copy
1
2interface PageDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
ページ削除レスポンス構造
Copy
1
2interface PageDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'page-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
保留中のWebhookイベントの構造
A PendingWebhookEvent object represents a queued webhook event that is pending.
PendingWebhookEvent オブジェクトは自動的に作成され、API 経由で手動作成することはできません。これらはまた 1 年後に期限切れになります。
それらは削除可能で、削除するとキューからタスクが取り除かれます。
異なるイベントタイプがあります — eventType（OutboundSyncEventType）と type（OutboundSyncType）を確認してください。
この API の一般的なユースケースはカスタム監視を実装することです。指定したフィルターに対する未処理数をポーリングするために、/count エンドポイントを定期的に呼び出すことがあるでしょう。
The structure for the PendingWebhookEvent object is as follows:
PendingWebhookEvent の構造
Copy
1
2enum OutboundSyncEventType {
3 Create: 0,
4 Delete: 1,
5 Update: 2
6}
7
8enum OutboundSyncType {
9 /** WordPress-specific sync task. **/
10 WP: 0,
11 Webhook: 1
12}
13
14interface PendingWebhookEvent {
15 id: string
16 /** The comment id associated with the event. **/
17 commentId: string
18 /** The comment object for the event at the time of the event. We started adding these in Nov 2023. **/
19 comment: Comment
20 /** An external id that may be associated with the comment. **/
21 externalId: string | null
22 createdAt: Date
23 tenantId: string
24 attemptCount: number
25 /** Set before first attempt, and after every failure. **/
26 nextAttemptAt: Date
27 /** Whether this is a creation, deletion, or update event... **/
28 eventType: OutboundSyncEventType
29 /** The type of sync to perform (WordPress, call API, etc). **/
30 type: OutboundSyncType
31 /** The domain that matched the comment. We use this domain to pick the API key. **/
32 domain: string
33 /** The last error that occurred. This type is untyped and is a "dump" of whatever happened. Usually it contains an object with statusCode, body, and a headers map. **/
34 lastError: object | null
35}
36
GET /api/v1/pending-webhook-events
Resource: PendingWebhookEvent as GET /api/v1/pending-webhook-events Credit Cost: 2
このルートは、pendingWebhookEvents パラメータの下に保留中の webhook イベントのリストを返します。
この API はページネーションを使用しており、skip パラメータによって提供されます。PendingWebhookEvents は 100 件ずつのページで返され、createdAt の新しい順に並びます。
PendingWebhookEvent の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pending-webhook-events?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
PendingWebhookEvent リクエスト構造
Copy
1
2interface PendingWebhookEventsGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 commentId?: string
6 externalId?: string
7 eventType?: OutboundSyncEventType
8 type?: OutboundSyncType
9 domain?: string
10 /** 指定した数よりも大きい試行回数を持つイベントを検索します。 **/
11 attemptCountGT?: number
12}
13
PendingWebhookEvent レスポンス構造
Copy
1
2interface PendingWebhookEventsGetResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 pendingWebhookEvents?: PendingWebhookEvent[]
9}
10
GET /api/v1/pending-webhook-events/count
Resource: PendingWebhookEvent as GET /api/v1/pending-webhook-events/count Credit Cost: 2
このルートは、保留中の webhook イベントの数を count パラメータとして含むオブジェクトを返します。
/pending-webhook-events エンドポイントと同じパラメータでフィルタできます
PendingWebhookEvent カウントの cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/pending-webhook-events/count?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
PendingWebhookEvent カウントのリクエスト構造
Copy
1
2interface PendingWebhookEventsCountQueryParams {
3 tenantId: string
4 API_KEY: string
5 commentId?: string
6 externalId?: string
7 eventType?: OutboundSyncEventType
8 type?: OutboundSyncType
9 domain?: string
10 /** 指定した数より試行回数が多いイベントを検索するクエリ。 **/
11 attemptCountGT?: number
12}
13
PendingWebhookEvent カウントのレスポンス構造
Copy
1
2interface PendingWebhookEventsCountResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 count?: number
9}
10
DELETE /api/v1/pending-webhook-events/:id
Resource: PendingWebhookEvent as DELETE /api/v1/pending-webhook-events/:id Credit Cost: 1
このルートでは単一の PendingWebhookEvent を削除できます。
一括削除が必要な場合は、ページネーション付きのGET APIを呼び出してから、このAPIを順番に呼び出してください。
DELETE PendingWebhookEvent の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/pending-webhook-events/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
PendingWebhookEvent 削除リクエスト構造
Copy
1
2interface PendingWebhookEventDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
PendingWebhookEvent 削除レスポンス構造
Copy
1
2interface PendingWebhookEventDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
SSOユーザーの構造
FastComments は使いやすい SSO ソリューションを提供します。HMAC ベースの統合を使用したユーザー情報の更新は、ユーザーが更新されたペイロードでページを読み込むだけで簡単に行えます。
ただし、アプリケーションの整合性を高めるために、そのフロー外でユーザーを管理したい場合もあります。
SSO User API は、SSOUsers と呼ぶオブジェクトを CRUD する方法を提供します。これらのオブジェクトは通常の Users と異なり、型安全性のために別に保持されています。
SSOUser オブジェクトの構造は次のとおりです：
SSOUser の構造
Copy
1
2interface SSOUser {
3 id: string
4 username: string
5 email?: string
6 websiteUrl?: string
7 signUpDate: number
8 createdFromUrlId?: string
9 loginCount?: number
10 avatarSrc?: string
11 optedInNotifications?: boolean
12 optedInSubscriptionNotifications?: boolean
13 displayLabel?: string
14 displayName?: string
15 isAccountOwner?: boolean // 管理者権限 - このフラグが付いた SSO ユーザーは SSO 管理者として課金されます（通常の SSO ユーザーとは別扱い）
16 isAdminAdmin?: boolean // 管理者権限 - このフラグが付いた SSO ユーザーは SSO 管理者として課金されます（通常の SSO ユーザーとは別扱い）
17 isCommentModeratorAdmin?: boolean // モデレーター権限 - このフラグが付いた SSO ユーザーは SSO モデレーターとして課金されます（通常の SSO ユーザーとは別扱い）
18 /** null の場合、アクセス制御はユーザーに適用されません。空のリストの場合、このユーザーはページを閲覧したり他のユーザーを @mention することができなくなります。 **/
19 groupIds?: string[] | null
20 createdFromSimpleSSO?: boolean
21 /** 他のユーザーがこのユーザーのプロフィール上のアクティビティ（コメントを含む）を見られないようにします。デフォルトは安全なプロフィールを提供するため true です。 **/
22 isProfileActivityPrivate?: boolean
23 /** 他のユーザーがこのユーザーのプロフィールにコメントを残したり、既存のプロフィールコメントを見たりできないようにします。デフォルトは false です。 **/
24 isProfileCommentsPrivate?: boolean
25 /** 他のユーザーがこのユーザーにダイレクトメッセージを送信できないようにします。デフォルトは false です。 **/
26 isProfileDMDisabled?: boolean
27 karma?: number
28 /** ユーザーバッジのオプション設定。 **/
29 badgeConfig?: {
30 /** ユーザーに割り当てるバッジ ID の配列。30 個までに制限されています。順序は尊重されます。 **/
31 badgeIds: string[]
32 /** true の場合、表示されている既存のバッジをすべて提供されたバッジで置き換えます。false の場合、既存のバッジに追加します。 **/
33 override?: boolean
34 /** true の場合、テナント設定からバッジの表示プロパティを更新します。 **/
35 update?: boolean
36 }
37}
38
SSO ユーザーの課金
SSO ユーザーは権限フラグに応じて異なる方法で課金されます：
- 通常の SSO ユーザー: 管理者またはモデレーター権限を持たないユーザーは通常の SSO ユーザーとして課金されます
- SSO 管理者:
isAccountOwnerまたはisAdminAdminフラグを持つユーザーは、別個に SSO 管理者として課金されます（通常のテナント管理者と同じ料金） - SSO モデレーター:
isCommentModeratorAdminフラグを持つユーザーは、別個に SSO モデレーターとして課金されます（通常のモデレーターと同じ料金）
重要: 二重課金を防ぐため、システムはメールアドレスで SSO ユーザーを通常のテナントユーザーおよびモデレーターと自動的に重複排除します。SSO ユーザーが通常のテナントユーザーまたはモデレーターと同じメールを持っている場合、二重に課金されることはありません。
アクセス制御
ユーザーはグループに分けることができます。これが groupIds フィールドの目的で、オプションです。
@メンション
デフォルトでは、@ を入力すると @mentions は username を使って他の SSO ユーザーを検索します。displayName が使用されている場合、displayName に一致する結果があるときは username に一致する結果は無視され、@mention の検索結果は displayName を使用します。
サブスクリプション
FastComments では、ユーザーはコメントウィジェットのベルアイコンをクリックして「購読」をクリックすることでページを購読できます。
通常ユーザーの場合、通知設定に基づいて通知メールを送信します。
SSO ユーザーについては、後方互換性のためにこれを区別しています。追加の購読通知メールは optedInSubscriptionNotifications を true に設定した場合にのみ送信されます。
バッジ
badgeConfig プロパティを使って SSO ユーザーにバッジを割り当てることができます。バッジはコメント内でユーザー名の横に表示される視覚的な表示です。
badgeIds- ユーザーに割り当てるバッジ ID の配列。これらはあなたの FastComments アカウントで作成された有効なバッジ ID である必要があります。30 個までに制限されています。override- true の場合、コメントに表示されている既存のバッジはすべて提供されたバッジで置き換えられます。false または省略した場合、提供されたバッジは既存のバッジに追加されます。update- true の場合、ユーザーがログインするたびにテナントの設定からバッジの表示プロパティが更新されます。
GET /api/v1/sso-users
Resource: SSOUser as GET /api/v1/sso-users Credit Cost: 10
このルートは SSO ユーザーを 100 件ずつのページで返します。ページネーションは skip パラメータで提供されます。ユーザーは signUpDate と id によってソートされます。
SSOUsers cURL の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/sso-users?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUsers リクエスト構造
Copy
1
2interface SSOUsersRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 skip?: number
6}
7
SSOUsers レスポンス構造
Copy
1
2interface SSOUsersResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 users: SSOUser[]
9}
10
GET /api/v1/sso-users/by-id/:id
Resource: SSOUser as GET /api/v1/sso-users/by-id/:id Credit Cost: 1
このルートは、IDによって単一のSSOユーザーを返します。
SSOUser を ID で取得する cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/sso-users/by-id/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUser リクエスト構造
Copy
1
2interface SSOUserRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
SSOUser レスポンス構造
Copy
1
2interface SSOUserByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user: SSOUser
9}
10
GET /api/v1/sso-users/by-email/:email
Resource: SSOUser as GET /api/v1/sso-users/by-email/:email Credit Cost: 1
このルートはメールアドレスによって単一の SSO ユーザーを返します。
メールで SSOUser を取得する cURL の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/sso-users/by-email/someone@somewhere.com?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUser リクエスト構造
Copy
1
2interface SSOUserRequestByEmailQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
SSOUser レスポンス構造
Copy
1
2interface SSOUserByEmailResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-email' | 'user-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user: SSOUser
9}
10
PATCH /api/v1/sso-users/:id
Resource: SSOUser as PATCH /api/v1/sso-users/:id Credit Cost: 1
このルートは単一の SSO ユーザーを更新する機能を提供します。
SSOUser 更新の cURL 例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/sso-users/my-user-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "notfordperfect"
7}'
8
SSOUser 更新リクエスト構造
Copy
1
2interface SSOUserPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** メールまたはユーザー名が変更された場合に、これを 'true' に設定するとユーザーのコメントも更新できます。これによりクレジットのコストが2倍になります。 **/
6 updateComments: 'true' | 'false'
7}
8
SSOUser 更新レスポンス構造
Copy
1
2interface SSOUserPatchResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user?: SSOUser; // 成功時には更新された完全なユーザーを返します。
9}
10
POST /api/v1/sso-users
Resource: SSOUser as POST /api/v1/sso-users Credit Cost: 1
このルートは単一のSSOユーザーを作成します。
同じIDでユーザーを2つ作成しようとするとエラーになります。
SSOUser 作成の cURL 例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/sso-users?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "id": "my-user-id",
7 "username": "fordperfect",
8 "displayName": "Ford Perfect",
9 "email": "fordperfect@galaxy.com",
10 "groupIds": ["some-optional-group-id"]
11}'
12
この例ではアクセス制御のために groupIds を指定していますが、これはオプションです。
SSOUser 作成リクエストの構造
Copy
1
2interface SSOUserPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
SSOUser 作成レスポンスの構造
Copy
1
2interface SSOUserPostResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user?: SSOUser; // 成功時には作成したユーザーを返します。
9}
10
統合に関する注意
APIによって渡されたデータは、別のSSOユーザHMACペイロードを渡すだけで簡単に上書きできます。例えば、APIでusernameを設定した場合でも、ページ読み込み時のSSOフローで別のusernameを渡すと、自動的にそのusernameが更新されます。
このフローでは、明示的に指定するか null（not undefined）に設定した場合を除き、ユーザーのパラメータは更新しません。
PUT /api/v1/sso-users/:id
Resource: SSOUser as PUT /api/v1/sso-users Credit Cost: 1
このルートは単一のSSOユーザーを更新する機能を提供します。
SSOUser 更新 cURL 例
Copy
1
2curl --request PUT \
3 --url 'https://fastcomments.com/api/v1/sso-users/my-user-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "fordperfect",
7 "displayName": "Ford Perfect",
8 "email": "fordperfect@galaxy.com",
9 "groupIds": ["some-optional-group-id"]
10}'
11
この例ではアクセス制御のために groupIds を指定していますが、これは任意です。
SSOUser 更新リクエスト構造
Copy
1
2interface SSOUserPutQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** メールまたはユーザー名が変更された場合、これをtrueに設定するとユーザーのコメントも更新できます。これによりクレジットコストが2倍になります。 **/
6 updateComments: 'true' | 'false'
7}
8
SSOUser 更新レスポンス構造
Copy
1
2interface SSOUserPutResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'invalid-input' | 'missing-id' | 'user-exists'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user?: SSOUser; // 成功時に更新されたユーザーを返します。
9}
10
DELETE /api/v1/sso-users/:id
Resource: SSOUser as DELETE /api/v1/sso-users/:id Credit Cost: 1
このルートは、IDによって単一のSSOユーザーを削除します。
このユーザーのペイロードでコメントウィジェットを再度読み込むと、そのユーザーはシームレスに再作成されることに注意してください。
ユーザーのコメントは deleteComments クエリパラメータで削除できます。これが true の場合、次のことに注意してください：
- ユーザーのすべてのコメントが即時に削除されます。
- すべての child（現在孤立した）コメントは、各コメントに紐づくページの設定に基づいて削除または匿名化されます。たとえば、スレッド削除モードが "anonymize" の場合は返信は残り、ユーザーのコメントは匿名化されます。これは
commentDeleteModeがRemove（デフォルト値）の場合にのみ適用されます。 creditsCostは2になります。
匿名化されたコメント
ユーザーのコメントを保持したまま匿名化するには、commentDeleteMode=1 に設定します。
ユーザーのコメントが匿名化されると、次の値が null に設定されます：
- commenterName
- commenterEmail
- avatarSrc
- userId
- anonUserId
- mentions
- badgesisDeleted と isDeletedUser は true に設定されます。
レンダリング時、コメントウィジェットはユーザー名に DELETED_USER_PLACEHOLDER（デフォルト: "[deleted]"）を、コメントには DELETED_CONTENT_PLACEHOLDER を使用します。これらはウィジェットカスタマイズUIから変更できます。
例
SSOUser 削除の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/sso-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
SSOUser 削除リクエスト構造
Copy
1
2enum SSOUserCommentDeleteMode {
3 Remove = 0, // デフォルト
4 Anonymize = 1
5}
6
7interface SSOUsersDeleteQueryParams {
8 tenantId: string
9 API_KEY: string
10 /** ユーザーのコメントも削除するにはこれを true に設定できます。これによりクレジットコストが2倍になります。 **/
11 deleteComments?: 'true' | 'false'
12 /** ユーザーのコメントの扱い方法を決定するために任意に設定できます。 **/
13 commentDeleteMode?: SSOUserCommentDeleteMode
14}
15
SSOUser 削除レスポンス構造
Copy
1
2interface SSOUsersResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'user-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user?: SSOUser; // 成功時に削除されたユーザーを返します。
9}
10
サブスクリプションの構造
A Subscription object represents a subscription for a user.
Subscription objects are created when a user clicks the notification bell in the comment widget and clicks "Subscribe to this page".
Subscriptions can also be created via the API.
Having a Subscription object causes Notification objects to be generated, and emails sent, when new comments are left on the root of the associated page
that the Subscription is for. Sending of emails depends on the type of user. For regular users this depends on optedInNotifications. For SSO Users this depends on optedInSubscriptionNotifications. Note that some applications may not have the concept of a web-accessible page, in which case simply set urlId to
the id of the item you are subscribing to (same value for urlId you would pass to the comment widget).
A Subscription オブジェクトはユーザーの購読を表します。
Subscription オブジェクトは、ユーザーがコメントウィジェットの通知ベルをクリックし、"このページを購読する" をクリックしたときに作成されます。
購読はAPI経由でも作成できます。
Subscription オブジェクトが存在すると、該当するページのルートに新しいコメントが投稿された際に Notification オブジェクトが生成され、メールが送信されます。メールの送信はユーザーの種類に依存します。通常のユーザーの場合は optedInNotifications に依存します。SSOユーザーの場合は optedInSubscriptionNotifications に依存します。ウェブでアクセス可能なページという概念がないアプリケーションもある点に注意してください。その場合は、購読対象のアイテムの id（コメントウィジェットに渡す urlId と同じ値）を urlId に設定してください。
The structure for the Subscription object is as follows:
サブスクリプションの構造
Copy
1
2interface Subscription {
3 id: string
4 tenantId: string
5 /** SSOの場合、ユーザーIDは `<tenant id>:<user id>` 形式になります。 **/
6 userId: string
7 anonUserId?: string
8 urlId: string
9 url?: string
10 pageTitle?: string
11 createdAt: string // 日付文字列
12}
13
GET /api/v1/subscriptions/:id
Resource: Subscription as GET /api/v1/subscriptions Credit Cost: 1
このルートは createdAt でソートされた最大30件の Subscription オブジェクトを返します（新しい順）。
userId でフィルターできます。SSO を使用している場合、ユーザーIDは <tenant id>:<user id> の形式です。
ユーザーのサブスクリプション cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/subscriptions?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=SOME_USER_ID'
4
サブスクリプションのリクエスト構造
Copy
1
2interface SubscriptionsGetQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** レコードをスキップしてページングします。 **/
6 skip?: number
7 /** ユーザーでフィルターします。 **/
8 userId?: string
9}
10
サブスクリプションのレスポンス構造
Copy
1
2interface SubscriptionsGetResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 subscriptions?: Subscription[]
9}
10
POST /api/v1/subscriptions
Resource: Subscription as POST /api/v1/subscriptions Credit Cost: 1
このAPIエンドポイントは Subscription を作成する機能を提供します。ユーザーはページごとに1つのサブスクリプションのみ持つことができ、複数は冗長であるため、同じユーザーが同じページに対して複数のサブスクリプションを作成しようとするとエラーになります。
サブスクリプションを作成すると、購読中の urlId のルート（コメントの parentId が null の場合）に新しいコメントが投稿されると Notification オブジェクトが作成されます。
Subscription POST cURL の例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/subscriptions?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "userId": "tenantId:test-user-id",
7 "urlId": "some-page-id-or-url",
8 "url": "https://example.com/page",
9 "pageTitle": "Some Example Page!"
10}'
11
Subscription POST リクエスト構造
Copy
1
2interface SubscriptionPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Subscription POST レスポンス構造
Copy
1
2
3interface SubscriptionPostResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'unauthorized' | 'not-found';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9}
10
DELETE /api/v1/subscriptions/:id
Resource: Subscription as DELETE /api/v1/subscriptions Credit Cost: 1
このルートはIDによって単一の Subscription オブジェクトを削除します。
サブスクリプション削除の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/subscriptions/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
サブスクリプション削除のリクエスト構造
Copy
1
2interface SubscriptionsDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
サブスクリプション削除のレスポンス構造
Copy
1
2interface SubscriptionDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'unauthorized' | 'unexpected-param' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
テナント日次使用量の構造
TenantDailyUsage オブジェクトは、特定の日におけるテナントの使用量を表します。特定のテナントにその日にアクティビティがなかった場合、その日には TenantDailyUsage オブジェクトは存在しません。
TenantDailyUsage オブジェクトは リアルタイムではありません。実際の使用状況より数分遅れることがあります。
TenantDailyUsage オブジェクトの構造は次のとおりです:
TenantDailyUsage の構造
Copy
1
2export interface TenantDailyUsage {
3 yearNumber: number
4 monthNumber: number
5 dayNumber: number
6 commentFetchCount?: number
7 commentCreateCount?: number
8 conversationCreateCount?: number
9 voteCount?: number
10 accountCreatedCount?: number
11 userMentionSearch?: number
12 hashTagSearch?: number
13 gifSearchTrending?: number
14 gifSearch?: number
15 apiCreditsUsed?: number
16 createdAt: string
17 billed: boolean
18 /** 課金対象外。 **/
19 ignored: boolean
20}
21
GET /api/v1/tenant-daily-usage
Resource: TenantDailyUsage as GET /api/v1/tenant-daily-usage Credit Cost: 1
このルートでは、年・月・日ごとにテナントの使用状況を検索できます。最大365件のオブジェクトが返され、コストは10件ごとに1 APIクレジットです。
レスポンスオブジェクトは作成日の順（古いものが先）でソートされます。
TenantDailyUsage 検索 cURL の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-daily-usage?tenantId=demo&API_KEY=DEMO_API_SECRET&yearNumber=2022&monthNumber=2&dayNumber=10'
4
TenantDailyUsage リクエスト構造
Copy
1
2interface TenantDailyUsageQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** UTC に基づく。 **/
6 yearNumber?: number
7 /** 0 ベース。UTC に基づく。 **/
8 monthNumber?: number
9 /** 1 ベース。UTC に基づく。 **/
10 dayNumber?: number
11}
12
TenantDailyUsage レスポンス構造
Copy
1
2interface TenantDailyUsageResponse {
3 status: 'success' | 'failed'
4 /** Failure の場合に含まれる。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** Failure の場合に含まれる。 **/
7 reason?: string
8 tenantDailyUsages: TenantDailyUsage[]
9}
10
テナントの構造
Tenant は FastComments.com の顧客を定義します。ホワイトラベリング権限を持つテナントは API を介してそれらを作成できます。ホワイトラベル化テナントは他のホワイトラベル化テナントを作成できません（ネストは1レベルのみ許可されます）。
Tenant オブジェクトの構造は次の通りです:
テナント構造
Copy
1
2export enum SiteType {
3 Unknown = 0,
4 WordPress = 1
5}
6
7/** これは DomainConfig API でも処理できます。 **/
8export interface TenantDomainConfig {
9 domain: string
10 emailFromName?: string
11 emailFromEmail?: string
12 createdAt?: string,
13 siteType?: FastCommentsSiteType, // おそらく Unknown を使用するでしょう
14 logoSrc?: string, // 元の画像パス
15 logoSrc100px?: string, // サムネイル用にリサイズ済み
16 footerUnsubscribeURL?: string,
17 emailHeaders?: Record<string, string>,
18 disableUnsubscribeLinks?: boolean,
19 dkim?: {
20 domainName: string,
21 keySelector: string,
22 privateKey: string
23 }
24}
25
26export interface TenantBillingInfo {
27 name: string
28 address: string
29 city: string
30 state: string
31 zip: string
32 country: string
33}
34
35export enum TenantPaymentFrequency {
36 Monthly = 0,
37 Annually = 1
38}
39
40export interface Tenant {
41 id: string
42 name: string
43 email?: string
44 signUpDate: number; // number 型は "legacy" の理由による
45 packageId?: string | null
46 paymentFrequency?: TenantPaymentFrequency
47 billingInfoValid?: boolean
48 billingHandledExternally?: boolean
49 createdBy?: string
50 isSetup?: boolean
51 domainConfiguration: FastCommentsAPITenantDomainConfig[]
52 billingInfo?: FastCommentsAPITenantBillingInfo
53 stripeCustomerId?: string
54 stripeSubscriptionId?: string
55 stripePlanId?: string
56 enableProfanityFilter?: boolean
57 enableSpamFilter?: boolean
58 lastBillingIssueReminderDate?: string
59 removeUnverifiedComments?: boolean
60 unverifiedCommentsTTLms?: number
61 commentsRequireApproval?: boolean
62 autoApproveCommentOnVerification?: boolean
63 sendProfaneToSpam?: boolean
64 /** @readonly - packageId に基づいて計算されます。 **/
65 hasFlexPricing?: boolean
66 /** @readonly **/
67 flexLastBilledAmount?: number
68 /** @readonly - packageId に基づいて計算されます。 **/
69 hasAuditing?: boolean
70 /** テナントにキーと値のペアを保存でき、これをクエリに使用できます。キーには "." または "$" を含めることはできず、100 文字を超えることはできません。値は 2k 文字を超えることはできません。 **/
71 meta?: Record<string, string | null>
72}
73
GET /api/v1/tenants/:id
Resource: Tenant as GET /api/v1/tenants/:id Credit Cost: 1
このルートは id によって単一の Tenant を返します。
IDによるTenantのcURL例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
Tenant のリクエスト構造
Copy
1
2interface TenantByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Tenant のレスポンス構造
Copy
1
2interface TenantByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenant?: Tenant
9}
10
GET /api/v1/tenants
Resource: Tenant as GET /api/v1/tenants Credit Cost: 1
このAPIは、あなたのテナントによって管理されているテナントを返します。
ページネーションは skip クエリパラメータで提供されます。テナントは 100 件ずつのページで返され、signUpDate と id の順で並びます。
コストは返されるテナントの数に基づき、返される10件ごとに 1 credit per 10 がかかります。
テナントの cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'
4
Tenant オブジェクトに meta パラメータを定義して一致するテナントをクエリできます。例えば、キーが someKey でメタ値が some-value の場合、このキー/値ペアを含むJSONオブジェクトを作成し、それをURIエンコードしてクエリパラメータとして渡してフィルタリングできます:
メタによるテナントクエリの cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET&meta=%7B%22someKey%22%3A%22some-value%22%7D'
4
テナントのリクエスト構造
Copy
1
2interface TenantsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ページネーションのためにスキップするテナントの数。 **/
6 skip?: number
7 /** meta パラメータでフィルタ。 **/
8 meta?: string
9}
10
テナントのレスポンス構造
Copy
1
2interface TenantsResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenants?: Tenant[]
9}
10
POST /api/v1/tenants
Resource: Tenant as POST /api/v1/tenants Credit Cost: 1
このルートは単一の Tenant を追加する機能を提供します。
Tenant を作成する際の制約は以下の通りです:
nameは必須です。domainConfigurationは必須です。Tenantを作成する際に以下の値を指定してはいけません:hasFlexPricinglastBillingIssueReminderDateflexLastBilledAmount
signUpDateは未来の日付にできません。nameは200 charactersを超えてはいけません。emailは300 charactersを超えてはいけません。emailは FastComments.com の全テナントで一意でなければなりません。- 親テナントに有効な
TenantPackageが定義されていない場合、テナントを作成できません。- もしあなたのテナントが FastComments.com 経由で作成されているなら、この問題は発生しないはずです。
- パッケージで定義されている
maxWhiteLabeledTenantsより多くのテナントを作成することはできません。 - white labeling が有効な
parent tenantの ID であるtenantIdクエリパラメータを指定する必要があります。
少数のパラメータのみで Tenant を作成できます:
Tenant 作成 cURL の例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some Name",
7 "email": "someone@someone.com",
8 "domainConfiguration": [ { "domain": "somedomain.com" } ]
9}'
10
Tenant 作成リクエスト構造
Copy
1
2interface TenantPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Tenant 作成レスポンス構造
Copy
1
2interface TenantPostResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'unexpected-param' | 'sign-up-date-in-future' | 'payment-frequency-invalid' | 'cannot-change-payment-frequency' | 'name-invalid' | 'email-invalid' | 'email-taken' | 'no-package' | 'invalid-package' | 'unauthorized' | 'tenant-limit-reached' | 'cannot-move-tenant' | 'cannot-change-package' | 'invalid-billing-info'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenant?: Tenant; // 成功時に作成された完全な tenant を返します。
9}
10
PATCH /api/v1/tenants/:id
Resource: Tenant as PATCH /api/v1/tenants/:id Credit Cost: 1
このAPIエンドポイントは id によって Tenant を更新する機能を提供します。
Tenant の更新には以下の制限があります：
- 次の値は更新できません：
hasFlexPricinglastBillingIssueReminderDateflexLastBilledAmountmanagedByTenantId
signUpDateは未来日には設定できません。nameは200 charactersを超えてはいけません。emailは300 charactersを超えてはいけません。emailは FastComments.com のすべてのテナント間で一意でなければなりません。billingInfoValidをtrueに設定する場合、同じリクエスト内でbillingInfoを提供する必要があります。- 自身のテナントに紐付いた
packageIdを更新することはできません。 - 自身のテナントに紐付いた
paymentFrequencyを更新することはできません。
Tenant PATCH cURL の例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some New Name",
7}'
8
Tenant PATCH リクエスト構造
Copy
1
2interface TenantPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Tenant PATCH レスポンス構造
Copy
1
2
3interface TenantPatchResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'unexpected-param' | 'sign-up-date-in-future' | 'payment-frequency-invalid' | 'cannot-change-payment-frequency' | 'name-invalid' | 'email-invalid' | 'email-taken' | 'no-package' | 'invalid-package' | 'unauthorized' | 'tenant-limit-reached' | 'cannot-move-tenant' | 'cannot-change-package' | 'invalid-billing-info';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9}
10
DELETE /api/v1/tenants/:id
Resource: Tenant as DELETE /api/v1/tenants/:id Credit Cost: 1,000
このルートはIDによって Tenant およびすべての関連データ（ユーザー、コメントなど）を削除します。
テナント削除に関して次の制限があります：
- テナントはあなた自身のものであるか、あなたが管理するホワイトラベルされたテナントである必要があります。
sureクエリパラメータはtrueに設定されている必要があります。
テナント削除の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/tenants/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
テナント削除のリクエスト構造
Copy
1
2interface TenantDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
テナント削除のレスポンス構造
Copy
1
2interface TenantDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'unsure'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
テナントパッケージの構造
TenantPackage は、Tenant が利用できるパッケージ情報を定義します。テナントは複数のパッケージを利用可能にすることができますが、特定の時点で使用できるのは一つだけです。
packageId が有効な TenantPackage を指していない限り、Tenant はいかなる製品にも使用できません。
TenantPackage オブジェクトには次の2種類があります:
- 固定価格のパッケージ -
hasFlexPricingが false の場合。 - 柔軟価格のパッケージ -
hasFlexPricingが true の場合。
どちらの場合も、パッケージを使用するアカウントに対して制限が定義されますが、Flex の場合はテナントはベース価格に加えて使用量に応じて課金されます。使用量は flex* パラメータで定義されます。
テナントは複数のテナントパッケージを持つことができ、請求情報ページ から自分でパッケージを変更することができます。
テナントの請求をあなたが代行して処理する場合でも、各テナントの制限を定義するためにパッケージを定義する必要があります。Tenant の billingHandledExternally を true に設定するだけで、テナントは自分で請求情報や有効なパッケージを変更できなくなります。
親テナントより高い制限を持つパッケージを作成することはできません。
TenantPackage オブジェクトの構造は次のとおりです:
TenantPackage の構造
Copy
1
2export interface TenantPackage {
3 id: string
4 name: string
5 tenantId: string
6 createdAt: string
7 monthlyCostUSD: number
8 yearlyCostUSD: number
9 monthlyStripePlanId?: string
10 yearlyStripePlanId?: string
11 maxMonthlyPageLoads: number
12 maxMonthlyAPICredits: number
13 maxMonthlyComments: number
14 maxConcurrentUsers: number
15 maxTenantUsers: number
16 maxSSOUsers: number
17 maxModerators: number
18 maxDomains: number
19 maxWhiteLabeledTenants: number
20 hasWhiteLabeling: boolean
21 hasDebranding: boolean
22 forWhoText: string
23 featureTaglines: string[]
24 hasAuditing: boolean
25 hasFlexPricing: boolean
26 flexPageLoadCostCents?: null
27 flexPageLoadUnit?: null
28 flexCommentCostCents?: null
29 flexCommentUnit?: null
30 flexSSOUserCostCents?: null // 管理者／モデレーター権限のない通常のSSOユーザーあたりのコスト
31 flexSSOUserUnit?: null
32 flexAPICreditCostCents?: null
33 flexAPICreditUnit?: null
34 flexModeratorCostCents?: null
35 flexModeratorUnit?: null
36 flexAdminCostCents?: null
37 flexAdminUnit?: null
38 flexDomainCostCents?: null
39 flexDomainUnit?: null
40 flexSSOAdminCostCents?: null // 管理者権限を持つSSOユーザーあたりのコスト（isAccountOwner または isAdminAdmin フラグ）
41 flexSSOAdminUnit?: null
42 flexSSOModeratorCostCents?: null // モデレーター権限を持つSSOユーザーあたりのコスト（isCommentModeratorAdmin フラグ）
43 flexSSOModeratorUnit?: null
44 flexMinimumCostCents?: null
45}
46
GET /api/v1/tenant-packages/:id
Resource: TenantPackage as GET /api/v1/tenant-packages/:id Credit Cost: 1
このルートは id によって単一の Tenant Package を返します。
TenantPackage を ID で取得する cURL の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantPackage リクエスト構造
Copy
1
2interface TenantPackageByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage レスポンス構造
Copy
1
2interface TenantPackageByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenantPackage: TenantPackage
9}
10
GET /api/v1/tenant-packages
Resource: TenantPackage as GET /api/v1/tenant-packages Credit Cost: 1
この API はページネーションを使用しており、skip クエリパラメータで指定します。TenantPackages は 100 件ごとのページで返され、createdAt と id の順でソートされます。
コストは返される tenant packages の数に基づき、10 件ごとに 1 credit がかかります。
TenantPackage の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-packages?tenantId=demo&skip=0&API_KEY=DEMO_API_SECRET'
4
TenantPackage リクエスト構造
Copy
1
2interface TenantPackagesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ページネーションでスキップするテナントパッケージの数。 **/
6 skip?: number
7}
8
TenantPackage レスポンス構造
Copy
1
2interface TenantPackagesResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenantPackages?: TenantPackage[]
9}
10
POST /api/v1/tenant-packages
Resource: TenantPackage as POST /api/v1/tenant-packages Credit Cost: 1
このルートは単一の TenantPackage を追加する機能を提供します。
TenantPackage を作成する際の制限は次のとおりです:
- 次のパラメータは必須です:
nametenantIdmonthlyCostUSD- null にできます。yearlyCostUSD- null にできます。maxMonthlyPageLoadsmaxMonthlyAPICreditsmaxMonthlyCommentsmaxConcurrentUsersmaxTenantUsersmaxSSOUsersmaxModeratorsmaxDomainshasDebrandingforWhoTextfeatureTaglineshasFlexPricing- true の場合、すべてのflex*パラメータが必須になります。
nameは50 charactersを超えることはできません。forWhoTextの各項目は200 charactersを超えてはなりません。featureTaglinesの各項目は100 charactersを超えてはなりません。TenantPackageは親テナントより“小さい”必要があります。例えば、すべてのmax*パラメータは親テナントよりも小さい値でなければなりません。- ホワイトラベルのテナントは最大で五つのパッケージを持つことができます。
- ホワイトラベリングアクセスを持つテナントのみが
TenantPackageを作成できます。 - 自分のテナントにパッケージを追加することはできません。 :)
以下のように TenantPackage を作成できます:
TenantPackage 作成のメール経由 cURL例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenant-packages?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Default Package",
7 "tenantId": "some-child-tenant-id",
8 "monthlyCostUSD": null,
9 "yearlyCostUSD": null,
10 "maxMonthlyPageLoads": 50000,
11 "maxMonthlyAPICredits": 50000,
12 "maxMonthlyComments": 50000,
13 "maxConcurrentUsers": 50000,
14 "maxTenantUsers": 10,
15 "maxSSOUsers": 50000,
16 "maxModerators": 100,
17 "maxDomains": 3,
18 "hasWhiteLabeling": false,
19 "hasDebranding": true,
20 "forWhoText": "For Everyone",
21 "featureTaglines": [
22 "Some Tag",
23 "Some Other Tag"
24 ],
25 "hasFlexPricing": true,
26 "flexPageLoadCostCents": 100,
27 "flexPageLoadUnit": 100000,
28 "flexCommentCostCents": 100,
29 "flexCommentUnit": 100000,
30 "flexSSOUserCostCents": 100,
31 "flexSSOUserUnit": 1000,
32 "flexAPICreditCostCents": 100,
33 "flexAPICreditUnit": 50000,
34 "flexModeratorCostCents": 500,
35 "flexModeratorUnit": 1,
36 "flexAdminCostCents": 1000,
37 "flexAdminUnit": 1,
38 "flexDomainCostCents": 1000,
39 "flexDomainUnit": 1,
40 "flexMinimumCostCents": 99
41}'
42
TenantPackage 作成のリクエスト構造
Copy
1
2interface TenantPackagePostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage 作成のレスポンス構造
Copy
1
2interface TenantPackagePostResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' 'white-labeling-not-allowed' | 'name-too-long' | 'for-who-text-too-long' | 'feature-tag-lines-too-long' | 'no-package' | 'invalid-package' | 'unauthorized' | 'child-tenant-too-large' | 'flex-param-missing' | 'unexpected-flex-param' | 'package-limit-reached' | 'flex-param-missing' | 'unexpected-flex-param'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenantPackage?: TenantPackage; // 成功時に作成された完全な tenant package を返します。
9}
10
PATCH /api/v1/tenant-packages/:id
Resource: TenantPackage as PATCH /api/v1/tenant-packages/:id Credit Cost: 1
この API エンドポイントは、id によって TenantPackage を更新する機能を提供します。
TenantPackage を更新する際の制限は次の通りです：
- もし
hasFlexPricingを true に設定する場合は、同じリクエスト内で全てのflex*パラメータが必須になります。 nameは50 charactersを超えてはなりません。forWhoTextの各項目は200 charactersを超えてはなりません。featureTaglinesの各項目は100 charactersを超えてはなりません。TenantPackageは親テナントより「小さい」必要があります。例えば、すべてのmax*パラメータは親テナントより小さい値でなければなりません。TenantPackageに関連付けられたtenantIdを変更することはできません。
TenantPackage PATCH cURL 例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some New Name",
7}'
8
TenantPackage PATCH リクエスト構造
Copy
1
2interface TenantPackagePatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage PATCH レスポンス構造
Copy
1
2
3interface TenantPackagePatchResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unexpected-param' | 'not-found' | 'white-labeling-not-allowed' | 'name-too-long' | 'for-who-text-too-long' | 'feature-tag-lines-too-long' | 'no-package' | 'invalid-package' | 'unauthorized' | 'child-tenant-too-large' | 'flex-param-missing' | 'unexpected-flex-param' | 'package-limit-reached' | 'flex-param-missing' | 'unexpected-flex-param';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9}
10
DELETE /api/v1/tenant-packages/:id
Resource: TenantPackage as DELETE /api/v1/tenant-packages/:id Credit Cost: 5
このルートはIDによってTenantPackageを削除します。
テナントの packageId がそのパッケージを指しているような、使用中の TenantPackage は削除できません。先に Tenant を更新してください。
TenantPackage 削除の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/tenant-packages/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantPackage 削除リクエスト構造
Copy
1
2interface TenantPackageDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantPackage 削除レスポンス構造
Copy
1
2interface TenantPackageDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'not-found' | 'unauthorized' | 'package-in-use'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
テナントユーザーの構造
TenantUser は特定のテナントによって管理される User を定義します。彼らのアカウントは関連するテナントによって完全に管理され、
彼らのアカウントはUI または API を通じて更新または削除できます。
テナントユーザーは、すべての権限を持ち Tenant へのアクセスができる管理者になれます、または特定の権限に限定されて
コメントのモデレート、APIキーへのアクセスなどを行うことができます。
TenantUser オブジェクトの構造は次のとおりです:
TenantUser の構造
Copy
1
2/** これは通知のためのものです。 **/
3export enum UserDigestEmailFrequency {
4 Disabled = -1,
5 Daily = 0,
6 Weekly = 1,
7 Monthly = 2
8}
9
10export interface TenantUser {
11 id: string
12 tenantId: string
13 username: string
14 /** 例えば、コメント投稿者のブログへのリンク。 **/
15 websiteUrl?: string
16 email: string
17 signUpDate: number
18 createdFromUrlId: string
19 createdFromTenantId: string
20 verified: boolean
21 loginCount: number
22 optedInNotifications: boolean
23 optedInTenantNotifications: boolean
24 hideAccountCode: boolean
25 avatarSrc?: string
26 /** このユーザーはコメント投稿者からのヘルプリクエストを受け取りますか？ **/
27 isHelpRequestAdmin: boolean
28 isAccountOwner: boolean
29 isAdminAdmin: boolean
30 isBillingAdmin: boolean
31 isAnalyticsAdmin: boolean
32 isCustomizationAdmin: boolean
33 isManageDataAdmin: boolean
34 isCommentModeratorAdmin: boolean
35 isAPIAdmin: boolean
36 moderatorIds: string[]
37 locale: FastCommentsLocale
38 digestEmailFrequency: UserDigestEmailFrequency
39 lastLoginDate: string
40 displayLabel?: string
41 karma?: number
42}
43
GET /api/v1/tenant-users/:id
Resource: TenantUser as GET /api/v1/tenant-users/:id Credit Cost: 1
このルートは、id によって単一の TenantUser を返します。
ID による TenantUser の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantUser リクエスト構造
Copy
1
2interface TenantUserByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantUser レスポンス構造
Copy
1
2interface TenantUserByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenantUser?: TenantUser
9}
10
GET /api/v1/tenant-users
Resource: TenantUser as GET /api/v1/tenant-users Credit Cost: 1
このAPIはページネーションを使用しており、skip クエリパラメータで指定します。TenantUsers は 100 件ずつのページで返され、signUpDate、username、id の順に並べられます。
コストは返されるテナントユーザーの数に基づき、返されるテナントユーザー10件ごとに 1 credit per 10 の費用がかかります。
TenantUser の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/tenant-users?tenantId=demo&page=0&API_KEY=DEMO_API_SECRET'
4
TenantUser リクエスト構造
Copy
1
2interface TenantUsersRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ページネーションでスキップするテナントユーザーの数。 **/
6 skip?: number
7}
8
TenantUser レスポンス構造
Copy
1
2interface TenantUsersResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenantUsers?: TenantUser[]
9}
10
POST /api/v1/tenant-users
Resource: TenantUser as POST /api/v1/tenant-users Credit Cost: 1
このルートは単一の TenantUser を追加する機能を提供します。
TenantUser を作成する際には、以下の制約があります:
usernameは必須です。emailは必須です。signUpDateは未来の日付にできません。localeは サポートされているロケール の一覧に含まれている必要があります。usernameは FastComments.com 上で一意である必要があります。もし問題がある場合は、代わりに SSO の使用を推奨します。emailは FastComments.com 上で一意である必要があります。もし問題がある場合は、代わりに SSO の使用を推奨します。- パッケージで定義されている
maxTenantUsersを超えてテナントユーザーを作成することはできません。
次のように TenantUser を作成できます
TenantUser 作成の cURL 例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/tenants?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "Some Name",
7 "email": "someone@someone.com"
8}'
9
TenantUser 作成リクエストの構造
Copy
1
2interface TenantUserPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantUser 作成レスポンスの構造
Copy
1
2interface TenantUserPostResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'username-required' | 'email-required' | 'sign-up-date-in-future' | 'unsupported-locale' | 'unauthorized' | 'username-taken' | 'email-taken' | 'tenant-user-limit-reached'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 tenantUser?: TenantUser; // 成功時に作成された完全な tenantUser を返します。
9}
10
POST /api/v1/tenant-users/:id/send-login-link
Resource: TenantUser as POST /api/v1/tenant-users/:id/send-login-link Credit Cost: 10
このルートは単一の TenantUser にログインリンクを送信する機能を提供します。
ユーザーを一括作成する際に、FastComments.com へのログイン方法を個別に案内する必要がない場合に便利です。これはログイン用の「マジックリンク」を送信し、そのリンクは 30 days で期限切れになります。
TenantUser にログインリンクを送信するための制限は以下のとおりです：
TenantUserは既に存在している必要があります。TenantUserが所属するTenantを管理するアクセス権が必要です。
TenantUser にログインリンクを送信する例は次のとおりです：
TenantUser ログインリンク cURL の例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz/send-login-link?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json'
5
これにより Bob at TenantName is inviting you to be a moderator... のようなメールが送信されます。
TenantUser ログインリンク リクエスト構造
Copy
1
2interface TenantUserPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
TenantUser ログインリンク レスポンス構造
Copy
1
2interface TenantUserPostResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'unauthorized' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
PATCH /api/v1/tenant-users/:id
Resource: TenantUser as PATCH /api/v1/tenant-users/:id Credit Cost: 1
このルートは単一の TenantUser を更新する機能を提供します。
TenantUser を更新する際の制限は次のとおりです:
signUpDateは未来の日付にできません。localeは Supported Locales の一覧に含まれている必要があります。usernameは FastComments.com 全体で一意である必要があります。問題がある場合は、代わりに SSO の使用を推奨します。emailは FastComments.com 全体で一意である必要があります。問題がある場合は、代わりに SSO の使用を推奨します。- ユーザーの
tenantIdを更新することはできません。
次のように TenantUser を作成できます
TenantUser 更新 cURL の例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "username": "Some Name",
7 "email": "someone@someone.com"
8}'
9
TenantUser 更新リクエスト構造
Copy
1
2interface TenantUserPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** email または username が変更されたとき、これを 'true' に設定するとユーザーのコメントも更新できます。これによりクレジットコストが2倍になります。 **/
6 updateComments: 'true' | 'false'
7}
8
TenantUser 更新レスポンス構造
Copy
1
2interface TenantUserPatchResponse {
3 status: 'success' | 'failed'
4 /** Included on failure. **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'sign-up-date-in-future' | 'unsupported-locale' | 'unauthorized' | 'username-taken' | 'email-taken' | 'unauthorized' | 'no-package' | 'invalid-package' | 'tenant-user-limit-reached' | 'user-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
DELETE /api/v1/tenant-users/:id
Resource: TenantUser as DELETE /api/v1/tenant-users/:id Credit Cost: 5
このルートは id によって TenantUser を削除します。
ユーザーのコメントを削除することは、deleteComments クエリパラメータで可能です。これが true の場合は注意してください:
- そのユーザーのコメントはすべてライブで削除されます。
- すべての child（現在孤立した）コメントは、各コメントに関連付けられたページの設定に基づいて削除または匿名化されます。例えば、スレッド削除モードが "anonymize" の場合、返信は残り、ユーザーのコメントは匿名化されます。これは
commentDeleteModeがRemove（デフォルト値）の場合にのみ適用されます。 creditsCostは2になります。
匿名化されたコメント
ユーザーのコメントを保持したまま commentDeleteMode=1 を設定して単に匿名化することができます。
ユーザーのコメントが匿名化されると、次の値が null に設定されます:
- commenterName
- commenterEmail
- avatarSrc
- userId
- anonUserId
- mentions
- badgesisDeleted と isDeletedUser は true に設定されます。
レンダリング時、コメントウィジェットはユーザー名に DELETED_USER_PLACEHOLDER（デフォルト: "[deleted]"）、コメントには DELETED_CONTENT_PLACEHOLDER を使用します。これらはウィジェットカスタマイズ UI でカスタマイズ可能です。
例
TenantUser 削除 cURL の例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/tenant-users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
TenantUser 削除リクエスト構造
Copy
1
2enum TenantUserCommentDeleteMode {
3 Remove = 0, // デフォルト
4 Anonymize = 1
5}
6
7interface TenantUserDeleteQueryParams {
8 tenantId: string
9 API_KEY: string
10 /** ユーザーのコメントも削除するには、これを true に設定できます。これによりクレジットコストが2倍になります。 **/
11 deleteComments?: 'true' | 'false'
12 /** ユーザーのコメントの取り扱い方法を決定するために、必要に応じてこれを設定できます。 **/
13 commentDeleteMode?: TenantUserCommentDeleteMode
14}
15
TenantUser 削除レスポンス構造
Copy
1
2interface TenantUserDeleteResponse {
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
ユーザーの構造
User はすべてのユーザーの最も一般的な共通要素を表すオブジェクトです。
Keep in mind that at FastComments we have a bunch of different use cases for users:
- Secure SSO
- Simple SSO
- Tenant Users (For example: Administrators)
- Commenters
This API is for Commenters and users created via Simple SSO. Basically, any user created
through your site can be accessed via this API. Tenant Users can also be fetched this way, but you'll get more information by interacting with the /tenant-users/ API.
For Secure SSO please use the /sso-users/ API.
You cannot update these types of users. They created their account through your site, so we provide some basic read-only access, but
you cannot make changes. If you want to have this type of flow - you need to setup Secure SSO.
The structure for the User object is as follows:
User の構造
Copy
1
2export interface User {
3 /** これはコメントオブジェクトの userId としても使用される id です。 **/
4 id: string
5 username: string
6 /** 例えば、コメント投稿者のブログへのリンク。 **/
7 websiteUrl?: string
8 email: string
9 signUpDate: number
10 createdFromUrlId: string
11 createdFromTenantId: string
12 avatarSrc?: string
13 locale: FastCommentsLocale
14 displayLabel?: string
15 karma?: number
16}
17
GET /api/v1/users/:id
Resource: User as GET /api/v1/users/:id Credit Cost: 1
このルートはIDで単一のユーザーを返します。
IDでユーザーを取得する cURL例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/users/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
ユーザーのリクエスト構造
Copy
1
2interface UserByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
ユーザーのレスポンス構造
Copy
1
2interface UserByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found' | 'unauthorized'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 user?: User
9}
10
投票の構造
A Vote object represents a vote left by a user.
コメントと投票の関係は commentId によって定義されます。
Vote オブジェクトの構造は次のとおりです:
Vote オブジェクトの構造
Copy
1
2interface Vote {
3 id: string
4 urlId: string
5 commentId: string
6 userId: string
7 direction: 1 | -1
8 createdAt: string
9}
10
GET /api/v1/votes
Resource: Vote as GET /api/v1/votes Credit Cost: 10
投票は urlId によって取得する必要があります。
投票の種類
投票には3種類あります。
- 認証済み投票は対応するコメントに適用されます。これらはこのAPIを通じて作成できます。
- 検証が保留中の認証済み投票であり、そのためまだコメントに適用されていません。これはユーザーが FastComments.com の ログインして投票 機能を使用したときに作成されます。
- 匿名投票は対応するコメントに適用されます。これらは匿名コメントとともに作成されます。
これらは混乱を避けるためにAPIでは別々のリストで返されます。
投票の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test'
4
投票リクエスト構造
Copy
1
2interface VotesRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 urlId: string
6}
7
投票レスポンス構造
Copy
1
2interface VotesResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 /** 認証済みで検証済みの投票。対応するコメントに適用されます。 **/
9 appliedAuthorizedVotes: Vote[]
10 /** 匿名投票。対応するコメントに適用されます。 **/
11 appliedAnonymousVotes: Vote[]
12 /** 検証が保留中の投票。まだ対応するコメントに適用されていません。 **/
13 pendingVotes: Vote[]
14}
15
匿名投票の注意点
このAPIを通じて作成された匿名投票は appliedAuthorizedVotes リストに表示されることに注意してください。これらはAPIで API key を使って作成されたため、承認済みと見なされます。
appliedAnonymousVotes は、メールや API key などがない状態で作成された投票用の構造です。
GET /api/v1/votes/for-user
Resource: Vote as GET /api/v1/votes/for-user Credit Cost: 1
指定した urlId に対してユーザーが行った投票を取得できます。userId は FastComments.com のユーザーまたは SSO User を指定できます。
コメントに対してユーザーが投票したかどうかを表示したい場合に便利です。コメントを取得する際、単にユーザーのために同時にこの API を呼び出し、
同じ urlId を使用してください。
匿名投票を使用している場合は、代わりに anonUserId を渡してください。
ユーザーの投票（cURL）例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/votes/for-user?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test&userId=some-user-id'
4
匿名ユーザーの投票（cURL）例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/votes/for-user?tenantId=demo&API_KEY=DEMO_API_SECRET&urlId=test&anonUserId=some-user-id'
4
匿名の投票は appliedAuthorizedVotes リストに表示されます。API キーを使用して API 経由で作成されたため、承認済みとして扱われます。
ユーザーの投票リクエスト構造
Copy
1
2interface VotesForUserRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 urlId: string
6 userId?: string
7 anonUserId?: string
8}
9
ユーザーの投票レスポンス構造
Copy
1
2interface VotesForUserResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'invalid-user-id'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 /** 承認済みで検証済みの投票。対応するコメントに適用されます。 **/
9 appliedAuthorizedVotes: Vote[]
10 /** 検証待ちの投票。まだ対応するコメントには適用されていません。 **/
11 pendingVotes: Vote[]
12}
13
POST /api/v1/votes
Resource: Vote as POST /api/v1/votes Credit Cost: 1
このルートは、単一の認可された Vote を追加する機能を提供します。投票は up (+1) または down (-1) にできます。
投票作成の cURL リクエスト例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&userId=user-id&commentId=comment-id&direction=up' \
4 --header 'Content-Type: application/json'
5
匿名投票作成の cURL リクエスト例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/votes?tenantId=demo&API_KEY=DEMO_API_SECRET&anonUserId=some-randomly-generated-identifier&commentId=comment-id&direction=up' \
4 --header 'Content-Type: application/json'
5
投票作成リクエスト構造
Copy
1
2interface VotePostQueryParams {
3 tenantId: string
4 API_KEY: string
5 userId?: string
6 anonUserId?: string
7 commentId: string
8 direction: 'up' | 'down'
9}
10
投票作成レスポンス構造
Copy
1
2interface VotePostResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-user-id' | 'invalid-user-id' | 'invalid-comment-id' | 'invalid-direction' | 'duplicate' | 'voting-disabled'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 voteId?: string
9}
10
匿名投票の作成
匿名投票は、クエリパラメータで userId の代わりに anonUserId を設定することで作成できます。
このIDはどこかのユーザーオブジェクトに対応している必要はありません（したがって匿名です）。これは単にセッションの識別子であり、同じセッション内で再度投票を取得して、コメントが投票されているかを確認できます。
もし FastComments のような「匿名セッション」がない場合は、単純にランダムなID（UUIDなど）を設定できます（ただし、スペース節約のために短い識別子の方が好ましいです）。
その他の注意点
- このAPIはテナントレベルの設定に従います。例えば、特定のページで投票を無効にしている場合、API経由で投票を作成しようとすると、エラーコード
voting-disabledで失敗します。 - このAPIはデフォルトでライブです。
- このAPIは対応する
Commentのvotesを更新します。
DELETE /api/v1/votes/:id
Resource: Vote as DELETE /api/v1/votes/:id Credit Cost: 1
このルートは単一の Vote を削除する機能を提供します。
Vote 削除の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/votes/some-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json'
5
Vote 削除リクエスト構造
Copy
1
2interface VoteDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
Vote 削除レスポンス構造
Copy
1
2interface VoteDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
注意事項:
- この API はテナントレベルの設定に従います。たとえば、特定のページで投票を無効にしていて、API 経由で投票を作成しようとすると、エラーコード
voting-disabledで失敗します。 - この API はデフォルトでライブです。
- この API は対応する
Commentのvotesを更新します。
ドメイン設定の構造
A DomainConfig object represents configuration for a domain for a tenant.
The structure for the DomainConfig object is as follows:
ドメイン構成の構造
Copy
1
2interface DomainConfig {
3 /** ドメイン（URLではありません）。例えば "fastcomments.com" や "www.example.com"。サブドメインで制限したい場合はサブドメインを含めてもよい。最大1000文字。 **/
4 domain: string
5 /** メール送信時に使用される送信者名。 **/
6 emailFromName?: string
7 /** メール送信時に使用される送信元メールアドレス。SPF を設定して、mail.fastcomments.com がこの属性で指定されたドメインとしてメールを送信できるようにしてください。 **/
8 emailFromEmail?: string
9 /** READONLY。オブジェクトが作成された日時。 **/
10 createdAt: string
11 /** このドメインに関連するロゴ。メールで使用されます。HTTPS を使用してください。 **/
12 logoSrc?: string
13 /** このドメインに関連する小さいロゴ。HTTPS を使用してください。 **/
14 logoSrc100px?: string
15 /** SSO 専用。送信されるすべてのメールのフッターで使用される URL。"[userId]" 変数をサポートします。 **/
16 footerUnsubscribeURL?: string
17 /** SSO 専用。送信されるすべてのメールで使用されるヘッダー。例として、配信改善のために購読解除関連のヘッダーを設定するのに便利です。この Record の List-Unsubscribe エントリが存在する場合、それは "[userId]" 変数をサポートします。 **/
18 emailHeaders?: Record<string, string>
19 /** すべての購読解除リンクを無効にします。推奨されません。配信率に悪影響を与える可能性があります。 **/
20 disableUnsubscribeLinks?: boolean
21 /** DKIM の設定。 **/
22 dkim?: DomainConfigDKIM
23}
24
DKIM構成の構造
Copy
1
2interface DomainConfigDKIM {
3 /** DKIM レコードに記載するドメイン名。 **/
4 domainName: string
5 /** 使用する DKIM キーのセレクタ。 **/
6 keySelector: string
7 /** 秘密鍵。-----BEGIN PRIVATE KEY----- で始まり -----END PRIVATE KEY----- で終わること。 **/
8 privateKey: string
9}
10
認証について
ドメイン構成は、どのサイトがあなたのアカウントのFastCommentsウィジェットをホストできるかを決定するために使用されます。これは基本的な形態 の認証であり、ドメイン構成の追加または削除はあなたのFastCommentsインストールの可用性に影響を与える可能性があります 本番環境で。
Don't remove or update the domain property of a Domain Config for a domain that is currently in use unless disabling that domain is intended.
This has the same behavior as removing a domain from /auth/my-account/configure-domains.
Also note that removing a domain from the My Domains UI will remove any corresponding configuration for that domain that may have been added via this UI.
メールのカスタマイズについて
The unsubscribe link in the email footer, and the one-click-unsubscribe feature offered by many email clients, can be configured via this API by defining footerUnsubscribeURL and emailHeaders, respectively.
DKIMについて
After defining your DKIM DNS records, simply update the DomainConfig with your DKIM configuration using the defined structure.
GET /api/v1/domain-configs
Resource: Comment as GET /api/v1/domain-configs Credit Cost: 1
この API は、テナントのすべての DomainConfig オブジェクトを取得する機能を提供します。
DomainConfig GET cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/domain-configs?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
DomainConfig GET リクエスト構造
Copy
1
2interface GetDomainConfigsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig GET レスポンス構造
Copy
1
2interface GetDomainConfigsResponse {
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 configurations: DomainConfig[] | null
10}
11
GET /api/v1/domain-configs/:domain
Resource: DomainConfig as GET /api/v1/domain-configs/:domain Credit Cost: 1
個々の DomainConfigs は対応する domain によって取得できます。
ドメインによる Domain Config の cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
ドメインによる Domain Config リクエスト構造
Copy
1
2interface DomainConfigsByDomainRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
ドメインによる Domain Config レスポンス構造
Copy
1
2interface DomainConfigResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'internal' | 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-url-id' | 'missing-domain' | 'update-would-create-duplicate' | 'domain-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 configuration?: DomainConfig | null
9}
10
POST /api/v1/domain-configs
Resource: DomainConfig as POST /api/v1/domain-configs Credit Cost: 1
このAPIエンドポイントはドメイン設定を作成する機能を提供します。
ドメインの設定を追加すると、そのドメインがFastCommentsアカウントで認可されます。
このAPIの一般的な使用例は、初期設定、複数ドメインを追加したい場合、またはメール送信のためのカスタム設定です。
DomainConfig POST cURL の例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/domain-configs?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "domain": "example.com",
7 "emailFromName": "some from name",
8 "emailFromEmail": "some@test.com",
9 "logoSrc": "https://example.com/my-logo-big.png",
10 "logoSrc100px": "https://example.com/my-logo-100px.png",
11 "footerUnsubscribeURL": "http://example.com/unsubscribe-ui",
12 "emailHeaders": {
13 "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
14 "List-Unsubscribe": "<https://example.com/opt-out/[userId]>"
15 }
16}'
17
DomainConfig POST リクエスト構造
Copy
1
2interface DomainConfigPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig POST レスポンス構造
Copy
1
2
3interface DomainConfigPostResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'configuration-exists-for-domain' | 'domain-too-long' | 'domain-invalid';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9 /** 作成された構成。 **/
10 configuration?: DomainConfig
11}
12
PATCH /api/v1/domain-configs/:domain
Resource: DomainConfig as PATCH /api/v1/domain-configs/:domain Credit Cost: 1
このAPIエンドポイントは、ドメインと更新する属性のみを指定してドメイン設定を更新する機能を提供します。
DomainConfig PATCH cURL の例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "emailFromName": "Some New From Name",
7}'
8
DomainConfig PATCH リクエスト構造
Copy
1
2interface DomainConfigPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig PATCH レスポンス構造
Copy
1
2
3interface DomainConfigPatchResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'domain-does-not-exist' | 'update-would-create-duplicate' | 'domain-too-long' | 'domain-invalid';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9 /** 更新された設定。 **/
10 configuration?: DomainConfig
11}
12
PUT /api/v1/domain-configs/:domain
Resource: DomainConfig as PUT /api/v1/domain-configs/:domain Credit Cost: 1
このAPIエンドポイントはドメイン構成を置き換える機能を提供します。
DomainConfig PUT cURL の例
Copy
1
2curl --request PUT \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "domain": "new-domain-example.com",
7 "emailFromName": "some from name",
8 "emailFromEmail": "some@test.com",
9 "logoSrc": "https://example.com/my-logo-big.png",
10 "logoSrc100px": "https://example.com/my-logo-100px.png",
11 "footerUnsubscribeURL": "http://example.com/unsubscribe-ui",
12 "emailHeaders": {
13 "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
14 "List-Unsubscribe": "<https://example.com/opt-out/[userId]>"
15 }
16}'
17
DomainConfig PUT リクエスト構造
Copy
1
2interface DomainConfigPutQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig PUT レスポンス構造
Copy
1
2
3interface DomainConfigPutResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input' | 'missing-domain' | 'domain-does-not-exist' | 'update-would-create-duplicate' | 'domain-too-long' | 'domain-invalid';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9 /** 更新された構成。 **/
10 configuration?: DomainConfig
11}
12
DELETE /api/v1/domain-configs/:domain
Resource: DomainConfig as DELETE /api/v1/domain-configs/:domain Credit Cost: 1
このルートは、IDによって単一の DomainConfig を削除します。
- 注意：
DomainConfigを削除すると、そのドメインは FastComments の使用が許可されなくなります。 - 注意：UIからドメインを再追加すると、オブジェクトが再作成されます（
domainのみが設定されます）。
DomainConfig 削除の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/domain-configs/example.com?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
DomainConfig 削除リクエスト構造
Copy
1
2interface DomainConfigRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
DomainConfig 削除レスポンス構造
Copy
1
2interface DomainConfigDeleteResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-domain' | 'domain-config-does-not-exist'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
質問設定の構造
FastCommentsは、質問を構築しその結果を集計する方法を提供します。例としての質問（以下 QuestionConfig と呼びます）は、星評価、スライダー、またはNPS質問（type により決定）などがあります。
質問データは個別に、まとめて、時間経過で、全体として、ページ別など、さまざまな方法で集計できます。
このフレームワークは、クライアント側ウィジェット（このAPIの前にあなたのサーバーを置く場合）、管理ダッシュボード、レポーティングツールを構築するために必要なすべての機能を備えています。
まず、QuestionConfig を定義する必要があります。構造は次のとおりです:
QuestionConfig の構造
Copy
1
2type QuestionConfigType = 'nps' | 'slider' | 'star' | 'thumbs';
3
4interface QuestionConfig {
5 id: string
6 tenantId: string
7 name: string
8 question: string
9 helpText?: string
10 createdAt: string
11 createdBy: string
12 /** 読み取り専用 - 各新しいレスポンスごとにインクリメントされます。 **/
13 usedCount: number
14 /** 構成が最後に使用された日時の文字列（結果が残されたとき）。 **/
15 lastUsed?: string
16 type: QuestionConfigType
17 numStars?: number
18 min?: number
19 max?: number
20 defaultValue?: number
21 labelNegative?: string
22 labelPositive?: string
23 subQuestionIds?: string[]
24 alwaysShowSubQuestions?: boolean
25 reportingOrder: number
26}
27
GET /api/v1/question-configs
Resource: QuestionConfig as GET /api/v1/question-configs Credit Cost: 1
このルートは一度に最大100件の QuestionConfig オブジェクトをページネートで返します。コストは100件ごとに1です。これらは
question フィールド（質問テキスト）で昇順にソートされます。
QuestionConfig の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-configs?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionConfig リクエスト構造
Copy
1
2interface QuestionConfigRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ページネーション用。0から始まります。 **/
6 skip?: number
7}
8
QuestionConfig レスポンス構造
Copy
1
2interface QuestionConfigByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 questionConfigs: QuestionConfig[]
9}
10
GET /api/v1/question-configs/:id
Resource: QuestionConfig as GET /api/v1/question-configs/:id Credit Cost: 1
このルートはIDにより単一の QuestionConfig を返します。
QuestionConfig を ID で取得する cURL 例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-configs/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionConfig リクエスト構造
Copy
1
2interface QuestionConfigRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig レスポンス構造
Copy
1
2interface QuestionConfigByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 questionConfig?: QuestionConfig
9}
10
POST /api/v1/question-configs
Resource: QuestionConfig as POST /api/v1/question-configs Credit Cost: 1
このAPIエンドポイントは QuestionConfig を作成する機能を提供します。
QuestionConfig POST cURL の例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/question-configs?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "name": "Some name that shows on reports.",
7 "question": "how much do you like this api?",
8 "type": 'slider',
9 "reportingOrder": 0,
10 "min": 0,
11 "max": 10
12}'
13
QuestionConfig POST リクエスト構造
Copy
1
2interface QuestionConfigPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig POST レスポンス構造
Copy
1
2
3interface QuestionConfigPostResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9 /** 作成されたオブジェクト。 **/
10 questionConfig?: QuestionConfig
11}
12
PATCH /api/v1/question-configs/:id
Resource: QuestionConfig as PATCH /api/v1/question-configs/:id Credit Cost: 1
このルートは単一の QuestionConfig を更新する機能を提供します。
以下の構造は変更可能な全ての値を表します:
QuestionConfig 構造
Copy
1
2interface QuestionConfigPatchBody {
3 name?: string
4 question?: string
5 helpText?: string
6 /** 注意：type を変更すると、min/max が異なる場合にレポートに影響を与える可能性があります。 **/
7 type?: QuestionConfigType
8 numStars?: number
9 min?: number
10 max?: number
11 defaultValue?: number
12 labelNegative?: string
13 labelPositive?: string
14 subQuestionIds?: string[]
15 alwaysShowSubQuestions?: boolean
16 reportingOrder?: number
17}
18
QuestionConfig 更新の cURL 例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/question-configs/my-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "question": "some new question text"
7}'
8
QuestionConfig 更新リクエスト構造
Copy
1
2interface QuestionConfigPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig 更新レスポンス構造
Copy
1
2interface QuestionConfigPatchResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
DELETE /api/v1/question-configs/:id
Resource: QuestionConfig as DELETE /api/v1/question-configs/:id Credit Cost: 100
このルートはIDによるQuestionConfigの削除を提供します。
これにより、対応するすべての質問結果が削除されます（コメントは削除されません）。 これは高クレジットコストの一部です。
QuestionConfig 削除の cURL 例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/question-configs/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionConfig 削除リクエスト構造
Copy
1
2interface QuestionConfigDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionConfig 削除レスポンス構造
Copy
1
2interface QuestionConfigResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
質問結果の構造
質問の結果を保存するには、QuestionResult を作成します。次に、質問の結果を集計したり、また
レポート目的でコメントに紐付けたりできます。
QuestionResult の構造
Copy
1
2interface QuestionResultMeta {
3 name: string
4 values: string[]
5}
6
7interface QuestionResult {
8 id: string
9 tenantId: string
10 urlId: string
11 anonUserId?: string
12 userId?: string
13 createdAt?: string
14 value: number
15 commentId?: string
16 questionId: string
17 meta?: QuestionResultMeta[]
18}
19
GET /api/v1/question-results
Resource: QuestionResults as GET /api/v1/question-results Credit Cost: 1
このルートは一度に最大1000件のQuestionResultsオブジェクトをページネーションされた状態で返します。コストは100件ごとに1です。これらは
createdAtで昇順にソートされます。さまざまなパラメータでフィルタできます。
QuestionResults の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionResults リクエスト構造
Copy
1
2interface QuestionResultsRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** ページネーション用。0から始まります。 **/
6 skip?: number
7 /** ページネーション用。 **/
8 limit?: number
9 /** 特定のページからの結果を取得します。 **/
10 urlId?: string
11 /** 特定のユーザーからの結果を取得します。 **/
12 userId?: string
13 startDate?: string | number
14 questionId?: string | string[]
15}
16
QuestionResults レスポンス構造
Copy
1
2interface QuestionResultsResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 questionResults: QuestionResults[]
9}
10
GET /api/v1/question-results/:id
Resource: QuestionResult as GET /api/v1/question-results/:id Credit Cost: 1
このルートは ID によって単一の QuestionResult を返します。
IDによるQuestionResultのcURL例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionResult のリクエスト構造
Copy
1
2interface QuestionResultRequestByIdQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult のレスポンス構造
Copy
1
2interface QuestionResultByIdResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 questionResult?: QuestionResult
9}
10
POST /api/v1/question-results
Resource: QuestionResult as POST /api/v1/question-results Credit Cost: 1
このAPIエンドポイントは、QuestionResult を作成する機能を提供します。
QuestionResult の POST cURL 例
Copy
1
2curl --request POST \
3 --url 'https://fastcomments.com/api/v1/question-results?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "urlId": "some-page-id",
7 "anonUserId": 'anon-0',
8 "userId": 'user-0',
9 "value": 10,
10 "questionId": "some-question-id",
11 "meta": [
12 {
13 name: "example",
14 values: ["value-1", "value-2"]
15 }
16 ]
17}'
18
QuestionResult POST リクエスト構造
Copy
1
2interface QuestionResultPostQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult POST レスポンス構造
Copy
1
2
3interface QuestionResultPostResponse {
4 status: 'success' | 'failed'
5 /** 失敗時に含まれます。 **/
6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'empty-request' | 'internal' | 'invalid-input';
7 /** 失敗時に含まれます。 **/
8 reason?: string
9 /** 作成されたオブジェクト。 **/
10 questionResult?: QuestionResult
11}
12
PATCH /api/v1/question-results/:id
Resource: QuestionResult as PATCH /api/v1/question-results/:id Credit Cost: 1
このルートは単一のQuestionResultを更新する機能を提供します。
以下の構造は変更可能なすべての値を表します：
QuestionResult 構造
Copy
1
2interface QuestionResultPatchBody {
3 urlId?: string
4 anonUserId?: string
5 userId?: string
6 value?: string
7 commentId?: string
8 questionId?: string
9 meta?: QuestionResultMeta[]
10}
11
QuestionResult 更新の cURL 例
Copy
1
2curl --request PATCH \
3 --url 'https://fastcomments.com/api/v1/question-results/my-id?tenantId=demo&API_KEY=DEMO_API_SECRET' \
4 --header 'Content-Type: application/json' \
5 --data '{
6 "value": 5
7}'
8
QuestionResult 更新リクエスト構造
Copy
1
2interface QuestionResultPatchQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult 更新レスポンス構造
Copy
1
2interface QuestionResultPatchResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'unauthorized' | 'missing-api-key' | 'missing-id' | 'not-found' | 'empty-request' | 'invalid-input'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
DELETE /api/v1/question-results/:id
Resource: QuestionResult as DELETE /api/v1/question-results/:id Credit Cost: 1
このルートは、id によって QuestionResult を削除します。
QuestionResult 削除 cURL の例
Copy
1
2curl --request DELETE \
3 --url 'https://fastcomments.com/api/v1/question-results/xyz?tenantId=demo&API_KEY=DEMO_API_SECRET'
4
QuestionResult 削除リクエスト構造
Copy
1
2interface QuestionResultDeleteQueryParams {
3 tenantId: string
4 API_KEY: string
5}
6
QuestionResult 削除レスポンス構造
Copy
1
2interface QuestionResultResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'missing-id' | 'not-found'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8}
9
GET /api/v1/question-results-aggregate
Resource: QuestionResultsAggregate as GET /api/v1/question-results-aggregate Credit Cost: 2
ここでは結果の集計が行われます。
集計のレスポンス構造は以下の通りです:
QuestionResultsAggregationResult の構造
Copy
1
2interface QuestionResultDataPoint {
3 /** 現在のデータポイント（日時バケットまたはページ）における値ごとの出現回数を示すマップ。 **/
4 v: Map<ValueAsString, number>
5 total: number
6}
7
8interface QuestionResultsAggregationResult {
9 /** 注：timeBucket が指定されていない場合は null になります。 **/
10 dataByDateBucket?: Map<DateString, QuestionResultDataPoint>
11 dataByUrlId?: Map<URLIdString, QuestionResultDataPoint>
12 countsByValue?: Map<ValueAsString, number>
13 /** 集計された結果の総数。 **/
14 total: number
15 /** 結果として得られる加重平均。小数で、通常は小数点以下2桁以内です。 **/
16 average: number
17 /** このデータが計算された日時を表す日付文字列（キャッシュから取得される可能性があるため）。 **/
18 createdAt: string
19}
20
集計で利用できるクエリパラメータは以下の通りです:
QuestionResultsAggregation のリクエスト構造
Copy
1
2interface QuestionResultsAggregateRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** 結果は1つまたは複数の質問で集計できます。 **/
6 questionId: string | string[]
7 startDate?: string | number
8 timeBucket?: 'day' | 'month' | 'year'
9 /** 特定のページで集計します。 **/
10 urlId?: string
11 /** 特定のユーザーで集計します。 **/
12 userId?: string
13 /** 今すぐ再計算してキャッシュを更新します。 **/
14 forceRecalculate?: boolean
15}
16
リクエストの例:
QuestionResultsAggregation の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results-aggregation?tenantId=demo&API_KEY=DEMO_API_SECRET&questionId=some-question-id'
4
レスポンス例:
QuestionResultsAggregation のレスポンス例
Copy
1
2 {
3 "average": 8.33,
4 "countsByValue": {
5 "5": 1,
6 "10": 2
7 },
8 "createdAt": "2023-08-30T00:00:00.000Z",
9 "dataByUrlId": {
10 "some-page": {
11 "total": 3,
12 "v": {
13 "5": 1,
14 "10": 2
15 }
16 }
17 },
18 "total": 3
19 }
20
QuestionResultsAggregation のレスポンス構造
Copy
1
2interface QuestionResultsAggregationResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 data: QuestionResultsAggregationResult
9}
10
パフォーマンスに関する注意
- キャッシュミスの場合、集計は通常100万件の結果あたり約5秒かかります。
- それ以外では、リクエストは定数時間で処理されます。
キャッシュとコストに関する注意
forceRecalculateが指定されている場合、通常の2の代わりにコストは常に10になります。- キャッシュが期限切れになりデータが再計算されても、
forceRecalculateが指定されていなければコストは依然として定数の2です。キャッシュの有効期限は集計されるデータセットのサイズに応じて決まり（30秒〜5分の間で変動します）。 - これはキャッシュの利用を促すための仕組みです。
GET /api/v1/question-results-aggregate/combine/comments
Resource: QuestionResultsCombinedWithComments as GET /api/v1/question-results-aggregate/combine/comments Credit Cost: 2
これは結果とコメントを結合するエンドポイントです。たとえば、製品の「最近の肯定的および否定的なコメント」チャートを作成するのに便利です。
値の範囲（両端含む）、1つ以上の質問、開始日（含む）で検索できます。
レスポンス構造は次のとおりです:
QuestionResultsCombinedWithCommentsResponse 構造
Copy
1
2interface SimpleComment {
3 id: string
4 commenterName: string
5 userId?: string
6 date: string
7 commentHTML: string
8}
9
10interface SimpleQuestionResult {
11 id: string
12 value: number
13}
14
15interface CommentAndResult {
16 comment: SimpleComment
17 result: SimpleQuestionResult
18}
19
20interface QuestionResultsCombinedWithCommentsResponse {
21 /** キャッシュから返されることがあるため、このデータが計算された日時を示す日付文字列。 **/
22 createdAt: string
23 results: CommentAndResult[]
24}
25
集計で使用できるクエリパラメータは次のとおりです:
QuestionResultsCombineComments リクエスト構造
Copy
1
2interface QuestionResultsAggregateRequestQueryParams {
3 tenantId: string
4 API_KEY: string
5 /** 1つ以上の質問の結果を集計できます。 **/
6 questionId: string | string[]
7 startDate?: string | number
8 urlId?: string
9 minValue: number
10 maxValue: number
11 limit?: number
12 forceRecalculate?: boolean
13}
14
リクエストの例はこちら:
QuestionResultsCombineComments の例
Copy
1
2curl --request GET \
3 --url 'https://fastcomments.com/api/v1/question-results-aggregation/combine/comments?tenantId=demo&API_KEY=DEMO_API_SECRET&questionId=some-question-id&minValue=5&maxValue=10'
4
レスポンスの例:
QuestionResultsCombineComments レスポンス例
Copy
1
2{
3 "createdAt": "2023-08-30T00:00:00.000Z",
4 "results": [
5 {
6 "comment": {
7 "id": "some-id",
8 "commentHTML": "test-2",
9 "commenterName": "Test",
10 "date": "2023-08-30T00:00:00.000Z",
11 "userId": "some-user-id"
12 },
13 "result": {
14 "id": "some-id",
15 "value": 10
16 }
17 },
18 {
19 "comment": {
20 "id": "some-id",
21 "commentHTML": "test-0",
22 "commenterName": "Some Name",
23 "date": "2023-08-30T00:00:00.000Z",
24 "userId": "some-user-id"
25 },
26 "result": {
27 "id": "some-id",
28 "value": 5
29 }
30 }
31 ]
32}
33
QuestionResultsCombineComments レスポンス構造
Copy
1
2interface QuestionResultsCombineCommentsResponse {
3 status: 'success' | 'failed'
4 /** 失敗時に含まれます。 **/
5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key'
6 /** 失敗時に含まれます。 **/
7 reason?: string
8 data: QuestionResultsCombinedWithCommentsResponse
9}
10
キャッシュとコストに関する注意事項
forceRecalculateが指定されている場合、通常の2ではなくコストは常に10になります。- キャッシュが期限切れになりデータが再計算される場合でも、
forceRecalculateが指定されていなければコストは依然として一定の2です。 - これはキャッシュの利用を奨励するためです。
ユーザーバッジの構造
UserBadge は FastComments システムでユーザーに付与されるバッジを表すオブジェクトです。
バッジは、ユーザーのアクティビティ（コメント数、返信時間、ベテランステータスなど）に基づいて自動的に付与されるか、サイト管理者によって手動で付与されます。
The structure for the UserBadge object is as follows:
UserBadge の構造
Copy
1
2export interface UserBadge {
3 /** このユーザーバッジ割り当ての一意の識別子 */
4 id: string
5 /** このバッジが割り当てられているユーザーのID */
6 userId: string
7 /** テナントのバッジカタログにあるバッジ定義のID */
8 badgeId: string
9 /** このバッジを作成/割り当てたテナントのID */
10 fromTenantId: string
11 /** このバッジが作成された時刻（エポックからのミリ秒） */
12 createdAt?: number
13 /** ユーザーがこのバッジを受け取った時刻（エポックからのミリ秒） */
14 receivedAt?: number
15 /**
16 * バッジの種類:
17 * 0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, 3=CommentsPinned,
18 * 4=Veteran, 5=NightOwl, 6=FastReplyTime, 7=ModeratorCommentsDeleted,
19 * 8=ModeratorCommentsApproved, 9=ModeratorCommentsUnapproved, 10=ModeratorCommentsReviewed,
20 * 11=ModeratorCommentsMarkedSpam, 12=ModeratorCommentsMarkedNotSpam, 13=RepliedToSpecificPage,
21 * 14=Manual
22 */
23 type: number
24 /** 閾値ベースのバッジの場合の閾値 */
25 threshold?: number
26 /** バッジの名前/ラベル */
27 name?: string
28 /** バッジの詳細な説明 */
29 description?: string
30 /** バッジに表示されるテキスト */
31 displayLabel?: string
32 /** バッジに表示される画像のURL */
33 displaySrc?: string
34 /** バッジの背景色（16進数コード） */
35 backgroundColor?: string
36 /** バッジの枠線色（16進数コード） */
37 borderColor?: string
38 /** バッジのテキスト色（16進数コード） */
39 textColor?: string
40 /** スタイリング用の追加CSSクラス */
41 cssClass?: string
42 /** ベテランバッジの場合の時間閾値（ミリ秒） */
43 veteranUserThresholdMillis?: number
44 /** このバッジがユーザーのコメントに表示されるかどうか */
45 displayedOnComments: boolean
46 /** バッジの表示順序 */
47 order?: number
48}
49
GET /api/v1/user-badges
このエンドポイントでは、さまざまな条件でユーザーバッジを取得できます。
Example Request:
GETリクエストの例
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badges?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
結果を絞り込むために、さまざまなクエリパラメータを追加できます：
userId- 特定のユーザーのバッジを取得badgeId- 特定のバッジのインスタンスを取得type- バッジのタイプでフィルタ (0=CommentCount, 1=CommentUpVotes, 2=CommentReplies, など。完全な一覧は UserBadge 構造を参照してください)displayedOnComments- バッジがコメントに表示されるかどうかでフィルタ (true/false)limit- 返されるバッジの最大数 (デフォルト 30、最大 200)skip- スキップするバッジ数（ページネーション用）
Example Response:
レスポンス
Copy
1
2{
3 "status": "success",
4 "userBadges": [
5 {
6 "id": "badge123",
7 "userId": "user456",
8 "badgeId": "badgeDef789",
9 "fromTenantId": "tenant001",
10 "createdAt": 1650532511000,
11 "receivedAt": 1650532511000,
12 "type": 14,
13 "name": "Special Contributor",
14 "description": "Awarded to special contributors to our community",
15 "displayLabel": "Special",
16 "backgroundColor": "#4a5568",
17 "textColor": "#ffffff",
18 "displayedOnComments": true,
19 "order": 1
20 },
21 {
22 "id": "badge124",
23 "userId": "user456",
24 "badgeId": "badgeDef790",
25 "fromTenantId": "tenant001",
26 "createdAt": 1650532598000,
27 "receivedAt": 1650532598000,
28 "type": 0,
29 "threshold": 100,
30 "name": "Centurion",
31 "description": "Made 100 comments",
32 "displayLabel": "100",
33 "backgroundColor": "#2b6cb0",
34 "textColor": "#ffffff",
35 "displayedOnComments": true,
36 "order": 2
37 }
38 ]
39}
40
Possible Error Responses:
エラー: テナントIDがありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: 無効な limit
Copy
1
2{
3 "status": "failed",
4 "code": "invalid-limit",
5 "reason": "The limit (query param: limit) is too large (> 200)."
6}
7
GET /api/v1/user-badges/:id
このエンドポイントを使用すると、一意の ID で特定のユーザーバッジを取得できます。
リクエスト例:
GET リクエストの例
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
レスポンス例:
レスポンス
Copy
1
2{
3 "status": "success",
4 "userBadge": {
5 "id": "badge123",
6 "userId": "user456",
7 "badgeId": "badgeDef789",
8 "fromTenantId": "tenant001",
9 "createdAt": 1650532511000,
10 "receivedAt": 1650532511000,
11 "type": 14,
12 "name": "Special Contributor",
13 "description": "Awarded to special contributors to our community",
14 "displayLabel": "Special",
15 "backgroundColor": "#4a5568",
16 "textColor": "#ffffff",
17 "displayedOnComments": true,
18 "order": 1
19 }
20}
21
想定されるエラー応答:
エラー: テナントIDがありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: 見つかりません
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge badge123 was not found."
6}
7
POST /api/v1/user-badges
このエンドポイントは新しいユーザーバッジの割り当てを作成するためのものです。
Example Request:
POST リクエスト例
Copy Run
Run 1
2curl -X POST "https://fastcomments.com/api/v1/user-badges?tenantId=demo&API_KEY=DEMO_API_SECRET" \
3-H "Content-Type: application/json" \
4-d '{
5 "userId": "user456",
6 "badgeId": "badgeDef789",
7 "displayedOnComments": true
8}'
9
The request body must contain the following parameters:
userId(required) - バッジを割り当てる対象のユーザーのIDbadgeId(required) - 割り当てるバッジのIDdisplayedOnComments(optional) - バッジをユーザーのコメントに表示するかどうか（デフォルトは true）
Important Notes:
- バッジはテナントのバッジカタログに存在し、有効になっている必要があります
- バッジは、あなたのテナントに所属しているユーザー、またはあなたのサイトにコメントしたことのあるユーザーにのみ割り当てることができます
Example Response:
レスポンス
Copy
1
2{
3 "status": "success",
4 "userBadge": {
5 "id": "badge123",
6 "userId": "user456",
7 "badgeId": "badgeDef789",
8 "fromTenantId": "tenant001",
9 "createdAt": 1650532511000,
10 "receivedAt": 1650532511000,
11 "type": 14,
12 "name": "Special Contributor",
13 "description": "Awarded to special contributors to our community",
14 "displayLabel": "Special",
15 "backgroundColor": "#4a5568",
16 "textColor": "#ffffff",
17 "displayedOnComments": true,
18 "order": 1
19 }
20}
21
Possible Error Responses:
エラー: テナントIDがありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: ユーザーIDがありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-user-id",
5 "reason": "User ID (body param: userId) is required."
6}
7
エラー: バッジIDがありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-badge-id",
5 "reason": "Badge ID (body param: badgeId) is required."
6}
7
エラー: バッジが見つかりません
Copy
1
2{
3 "status": "failed",
4 "code": "badge-not-found",
5 "reason": "The badge badgeDef789 was not found or is not enabled."
6}
7
エラー: 権限のないユーザー
Copy
1
2{
3 "status": "failed",
4 "code": "unauthorized-user",
5 "reason": "You can only add badges to users who belong to your tenant or have commented on your site."
6}
7
PUT /api/v1/user-badges/:id
このエンドポイントでは、ユーザーバッジの割り当てを更新できます。
現在、更新可能なプロパティは displayedOnComments のみで、これはバッジがユーザーのコメントに表示されるかどうかを制御します。
リクエスト例：
PUT リクエスト例
Copy Run
Run 1
2curl -X PUT "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET" \
3-H "Content-Type: application/json" \
4-d '{
5 "displayedOnComments": false
6}'
7
レスポンス例：
レスポンス
Copy
1
2{
3 "status": "success"
4}
5
考えられるエラー応答：
エラー: テナントIDがありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: IDがありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-id",
5 "reason": "The User Badge ID (url param: id) is missing."
6}
7
エラー: 見つかりません
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge badge123 was not found."
6}
7
DELETE /api/v1/user-badges/:id
このエンドポイントでは、ユーザーバッジの割り当てを削除できます。
リクエストの例:
DELETE リクエストの例
Copy Run
Run 1
2curl -X DELETE "https://fastcomments.com/api/v1/user-badges/badge123?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
レスポンスの例:
レスポンス
Copy
1
2{
3 "status": "success"
4}
5
考えられるエラー応答:
エラー: テナントIDが欠落しています
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: IDが欠落しています
Copy
1
2{
3 "status": "failed",
4 "code": "missing-id",
5 "reason": "The User Badge ID (url param: id) is missing."
6}
7
エラー: 見つかりません
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge badge123 was not found."
6}
7
ユーザーバッジ進捗の構造
UserBadgeProgress は、FastComments システムでユーザーがさまざまなバッジを獲得するための進捗を表すオブジェクトです。
このトラッキングは、ユーザーの活動やコミュニティへの参加に基づいていつ自動的にバッジを付与するべきかを判断するのに役立ちます。
以下が UserBadgeProgress オブジェクトの構造です：
UserBadgeProgress の構造
Copy
1
2export interface UserBadgeProgress {
3 /** この進捗レコードの一意の識別子 */
4 id: string
5 /** この進捗レコードが属するテナントのID */
6 tenantId: string
7 /** この進捗レコードが追跡するユーザーのID */
8 userId: string
9 /** システム内でのユーザーの最初のコメントのID */
10 firstCommentId?: string
11 /** ユーザーの最初のコメントの日付（エポックからのミリ秒） */
12 firstCommentDate?: number
13 /** ユーザーの活動に基づいて自動計算される信頼度 */
14 autoTrustFactor?: number
15 /** 管理者によって手動で設定される信頼度 */
16 manualTrustFactor?: number
17 /** さまざまな指標を含む詳細な進捗オブジェクト。キーは BadgeType 列挙型と一致します */
18 progress: {
19 /** 0: CommentCount - ユーザーが行ったコメントの数 */
20 '0'?: number
21 /** 1: CommentUpVotes - ユーザーが受け取ったアップボートの数 */
22 '1'?: number
23 /** 2: CommentReplies - ユーザーが行った返信の数 */
24 '2'?: number
25 /** 3: CommentsPinned - ユーザーが持つピン留めされたコメントの数 */
26 '3'?: number
27 /** 4: Veteran - ユーザーのアカウントの経過期間 */
28 '4'?: number
29 /** 5: NightOwl - 夜間の時間帯にユーザーが投稿した回数 */
30 '5'?: number
31 /** 6: FastReplyTime - 平均返信時間（ミリ秒） */
32 '6'?: number
33 /** 7: ModeratorCommentsDeleted - モデレーターバッジ用：削除したコメントの数 */
34 '7'?: number
35 /** 8: ModeratorCommentsApproved - モデレーターバッジ用：承認したコメントの数 */
36 '8'?: number
37 /** 9: ModeratorCommentsUnapproved - モデレーターバッジ用：非承認にしたコメントの数 */
38 '9'?: number
39 /** 10: ModeratorCommentsReviewed - モデレーターバッジ用：レビューしたコメントの数 */
40 '10'?: number
41 /** 11: ModeratorCommentsMarkedSpam - モデレーターバッジ用：スパムとしてマークしたコメントの数 */
42 '11'?: number
43 /** 12: ModeratorCommentsMarkedNotSpam - モデレーターバッジ用：スパムではないとマークしたコメントの数 */
44 '12'?: number
45 /** 13: RepliedToSpecificPage - 各ページごとの返信数 */
46 '13'?: Record<string, number>
47 }
48}
49
GET /api/v1/user-badge-progress
このエンドポイントは、さまざまな条件に基づいてユーザーのバッジ進捗レコードを取得するためのものです。
リクエスト例:
GET リクエストの例
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badge-progress?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
結果をフィルタリングするために、さまざまなクエリパラメータを追加できます:
userId- 特定のユーザーの進捗を取得limit- 返されるレコードの最大数 (デフォルト 30、最大 200)skip- スキップするレコード数 (ページネーション用)
レスポンス例:
レスポンス
Copy
1
2{
3 "status": "success",
4 "userBadgeProgresses": [
5 {
6 "id": "progress123",
7 "tenantId": "tenant001",
8 "userId": "user456",
9 "firstCommentId": "comment789",
10 "firstCommentDate": 1650532511000,
11 "autoTrustFactor": 0.75,
12 "progress": {
13 "0": 42,
14 "1": 120,
15 "2": 15,
16 "3": 3,
17 "5": 5,
18 "6": 1800000,
19 "8": 0,
20 "7": 0
21 }
22 },
23 {
24 "id": "progress124",
25 "tenantId": "tenant001",
26 "userId": "user789",
27 "firstCommentId": "comment790",
28 "firstCommentDate": 1650532598000,
29 "autoTrustFactor": 0.5,
30 "progress": {
31 "0": 12,
32 "1": 15,
33 "2": 4
34 }
35 }
36 ]
37}
38
考えられるエラー応答:
エラー: Tenant ID がありません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: 無効な Limit
Copy
1
2{
3 "status": "failed",
4 "code": "invalid-limit",
5 "reason": "The limit (query param: limit) is too large (> 200)."
6}
7
GET /api/v1/user-badge-progress/:id
このエンドポイントは、固有のIDで特定のユーザーバッジ進捗レコードを取得できます。
リクエストの例:
GET リクエストの例
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badge-progress/progress123?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
レスポンスの例:
レスポンス
Copy
1
2{
3 "status": "success",
4 "userBadgeProgress": {
5 "id": "progress123",
6 "tenantId": "tenant001",
7 "userId": "user456",
8 "firstCommentId": "comment789",
9 "firstCommentDate": 1650532511000,
10 "autoTrustFactor": 0.75,
11 "progress": {
12 "0": 42,
13 "1": 120,
14 "2": 15,
15 "3": 3,
16 "5": 5,
17 "6": 1800000,
18 "8": 0,
19 "7": 0
20 }
21 }
22}
23
想定されるエラー応答:
エラー: テナントIDが見つかりません
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: 見つかりません
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "The user badge progress progress123 was not found."
6}
7
GET /api/v1/user-badge-progress/user/:userId
このエンドポイントでは、ユーザーIDによってユーザーのバッジ進捗レコードを取得できます。
リクエスト例:
GET リクエスト例
Copy Run
Run 1
2curl -X GET "https://fastcomments.com/api/v1/user-badge-progress/user/user456?tenantId=demo&API_KEY=DEMO_API_SECRET"
3
レスポンス例:
レスポンス
Copy
1
2{
3 "status": "success",
4 "userBadgeProgress": {
5 "id": "progress123",
6 "tenantId": "tenant001",
7 "userId": "user456",
8 "firstCommentId": "comment789",
9 "firstCommentDate": 1650532511000,
10 "autoTrustFactor": 0.75,
11 "progress": {
12 "0": 42,
13 "1": 120,
14 "2": 15,
15 "3": 3,
16 "5": 5,
17 "6": 1800000,
18 "8": 0,
19 "7": 0
20 }
21 }
22}
23
可能なエラー応答:
エラー: テナントIDが不足しています
Copy
1
2{
3 "status": "failed",
4 "code": "missing-tenant-id",
5 "reason": "Tenant ID (query param: tenantId) is missing."
6}
7
エラー: ユーザーIDが不足しています
Copy
1
2{
3 "status": "failed",
4 "code": "missing-user-id",
5 "reason": "The User ID (path param: userId) is missing."
6}
7
エラー: 見つかりません
Copy
1
2{
3 "status": "failed",
4 "code": "not-found",
5 "reason": "No badge progress found for user user456 in tenant tenant001."
6}
7
まとめ
当社のAPIドキュメントが網羅的で分かりやすいと感じていただけていれば幸いです。もし不足点を見つけた場合は、下にお知らせください。