Uso de Recursos

Deve-se observar que buscar dados da API é contabilizado como uso na sua conta.

Cada recurso listará qual é esse uso em sua própria seção.

Alguns recursos custam mais para serem servidos do que outros. Cada endpoint tem um custo fixo de créditos por chamada de API. Para alguns endpoints, o número de créditos varia com base nas opções e no tamanho das respostas.

O uso da API pode ser verificado na página Análise de Faturamento e é atualizado a cada poucos minutos.

Observação!

Sugerimos ler primeiro a documentação do Pages, para ajudar a reduzir a confusão ao determinar quais valores passar para urlId na API de Comentários.

Esta API agrega documentos agrupando-os (se groupBy for fornecido) e aplicando múltiplas operações. Diferentes operações (por exemplo sum, countDistinct, avg, etc.) são suportadas.

O custo é variável. A cada 500 objetos analisados custa 1 crédito de API.

O uso máximo de memória permitido por chamada de API por padrão é 64MB, e por padrão você pode ter apenas uma agregação em execução por vez. Se você enviar múltiplas agregações simultaneamente, elas serão enfileiradas e executadas na ordem em que foram submetidas. Agregações pendentes aguardarão no máximo 60 segundos, após isso a solicitação expirará. Agregações individuais podem executar por até 5 minutos.

Se você tem tenants gerenciados, pode agregar todos os recursos de tenants filhos em uma única chamada passando o parâmetro de query parentTenantId.

Exemplos

Exemplo: Contar valores únicos

Exemplo cURL: Contar valores únicos

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

Resposta: Contagem de valores únicos

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

Exemplo: Contar distintos

Exemplo cURL: Contar valores distintos

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

Resposta:

Resposta: Contagem de valores distintos

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

Exemplo: Somar valores de múltiplos campos

Exemplo cURL: Soma de valores

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

Resposta:

Resposta: Soma de valores

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

Exemplo: Média dos valores de múltiplos campos

Exemplo cURL: Média de valores

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

Resposta:

Resposta: Média de valores

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

Exemplo: Valores mínimos/máximos de múltiplos campos

Exemplo cURL: Valores mínimos/máximos

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

Resposta:

Resposta: Valores mínimos/máximos

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

Exemplo: Contar valores únicos de múltiplos campos

Exemplo cURL: Contar valores únicos

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

Resposta:

Resposta: Contagem de valores únicos

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

Exemplo: Criação de consulta

Exemplo cURL: Criação de consulta

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

Resposta:

Resposta: Criação de consulta

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

Exemplo: Contar comentários pendentes de revisão

Exemplo cURL: Contar comentários pendentes de revisão

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

Resposta:

Resposta: Contagem de comentários pendentes de revisão

Copy

1

2{

3 "status": "success",

4 "data": [

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

6 ],

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

8}

9

Exemplo: Distribuição de comentários aprovados, revisados e spam

Exemplo cURL: Distribuição dos comentários

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

Resposta:

Resposta: Distribuição dos comentários

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

Estruturas

Estrutura da Requisição Aggregate

Copy

1

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

3

4/** Uma operação que será aplicada a um campo */

5export interface AggregationOperation {

6 /** O campo sobre o qual operar */

7 field: string;

8 /** O tipo de operação */

9 op: AggregationOpType;

10 /** Alias opcional para a saída; se não fornecido, um alias padrão é calculado */

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

Estrutura da Resposta Aggregate

Copy

1

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

3

4export interface AggregationResponse {

5 status: APIStatus,

6 data: AggregationItem[];

7 stats?: {

8 scanned: number;

9 timeMS: number;

10 };

11}

12

Os seguintes recursos podem ser agregados:

• 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

Esta API usa paginação, fornecida pelos parâmetros skip, before e after. AuditLogs são retornados em páginas de 1000, ordenados por when e id.

Buscar cada 1000 logs tem um custo de crédito de 10.

Por padrão, você receberá uma lista com os itens mais novos primeiro. Dessa forma, você pode consultar começando com skip=0, paginando até encontrar o último registro que consumiu.

Alternativamente, você pode ordenar do mais antigo para o mais novo e paginar até não haver mais registros.

A ordenação pode ser feita definindo order como ASC ou DESC. O padrão é ASC.

Consultar por data é possível via before e after como timestamps com milissegundos. before e after NÃO são inclusivos.

Exemplo cURL do AuditLog

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

Estrutura de Requisição do 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

Estrutura de Resposta do AuditLog

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 /** Os logs! **/

9 auditLogs: AuditLog[]

10}

11

Essa API é usada para obter comentários para exibição a um usuário. Por exemplo, ela filtra automaticamente comentários não aprovados ou spam.

Pagination

A paginação pode ser feita de duas maneiras, dependendo dos requisitos de desempenho e do caso de uso:

1. Mais rápido: Paginação Precalculada:
   1. É assim que o FastComments funciona quando você usa nossos widgets e clientes pré-construídos.
   2. Ao clicar em "next" simplesmente aumenta a contagem de páginas.
   3. Você pode pensar nisso como sendo recuperado por um armazenamento chave-valor.
   4. Dessa forma, defina simplesmente um parâmetro page começando em 0 e uma direção de ordenação como direction.
   5. Os tamanhos de página podem ser personalizados via regras de personalização.
2. Mais flexível: Paginação Flexível:
   1. Dessa forma você pode definir parâmetros personalizados limit e skip. Não passe page.
   2. A ordenação direction também é suportada.
   3. limit é o total a ser retornado após a aplicação de skip.
      • Exemplo: defina skip = 200, limit = 100 quando page size = 100 e page = 2.
   4. Comentários filhos ainda contam na paginação. Você pode contornar isso usando a opção asTree.
      • Você pode paginar filhos via limitChildren e skipChildren.
      • Você pode limitar a profundidade das threads retornadas via maxTreeDepth.

Threads

1. Ao usar Precalculated Pagination, os comentários são agrupados por page e comentários em threads afetam a página como um todo.
   1. Dessa forma, as threads podem ser determinadas no cliente com base em parentId.
   2. Por exemplo, em uma página com um comentário de nível superior e 29 respostas, ao definir page=0 na API — você obterá apenas o comentário de nível superior e os 29 filhos.
   3. Exemplo de imagem aqui ilustrando múltiplas páginas.
2. Ao usar Flexible Pagination, você pode definir um parâmetro parentId.
   1. Defina isso como null para obter apenas comentários de nível superior.
   2. Então, para visualizar threads, chame a API novamente e passe parentId.
   3. Uma solução comum é fazer uma chamada à API para os comentários de nível superior e então fazer chamadas paralelas à API para obter comentários dos filhos de cada comentário.
3. NOVO a partir de fev de 2023! Busque como árvore usando &asTree=true.
   1. Você pode pensar nisso como Flexible Pagination as a Tree.
   2. Apenas os comentários de nível superior contam na paginação.
   3. Defina parentId=null para iniciar a árvore na raiz (você deve definir parentId).
   4. Defina skip e limit para paginação.
   5. Defina asTree como true.
   6. O custo de créditos aumenta em 2x, pois nosso backend precisa fazer muito mais trabalho nesse cenário.
   7. Defina maxTreeDepth, limitChildren e skipChildren conforme desejado.

Trees Explained

Ao usar asTree, pode ser difícil raciocinar sobre a paginação. Aqui está um gráfico útil:

Diagrama de Paginação em Árvore

Fetching Comments in The Context of a User

A API /comments pode ser usada em dois contextos, para diferentes casos de uso:

• Para retornar comentários ordenados e marcados com informações para construir seu próprio cliente.
  • Nesse caso, defina um parâmetro de query contextUserId.
• Para buscar comentários a partir do seu backend para integrações customizadas.
  • A plataforma assumirá este caso por padrão sem contextUserId.

Paginação Precalculada de Comentários

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

Paginação Flexível de Comentários

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

Paginação Flexível de Comentários no Contexto do Usuário

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

Paginação Flexível de Comentários no Contexto do Usuário (Apenas Comentários de Primeiro Nível)

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

É possível obter os comentários retornados como uma árvore, com a paginação contando apenas os comentários de nível superior.

Comentários em Árvore no Contexto do Usuário

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

Quer obter apenas os comentários de nível superior e os filhos imediatos? Aqui está uma maneira:

Comentários em Árvore com Profundidade Máx.

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

No entanto, na sua UI pode ser necessário saber se deve exibir um botão "mostrar respostas" em cada comentário. Ao buscar comentários via árvore, existe uma propriedade hasChildren adicionada aos comentários quando aplicável.

Get Comments as a Tree, Searching by Hash Tag

É possível buscar por hashtag usando a API, em todo o seu tenant (não limitado a uma página, ou urlId).

Neste exemplo, omitimos urlId, e buscamos por múltiplas hashtags. A API retornará apenas comentários que contenham todas as hashtags requisitadas.

Comentários em Árvore no Contexto do Usuário, por Hashtag

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

Estrutura de Requisição de Comentários

Copy

1

2interface CommentsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** O urlId (URL da página, ou id do artigo) ao qual os comentários estão associados. **/

6 urlId?: string

7 /** Limita os comentários retornados por este usuário. **/

8 userId?: string

9 /** Use isto para buscar por hashtag. Para filtrar pela interseção de múltiplas hashtags, faça &hashTag=a&hashTag=b. **/

10 hashTag?: string

11 /** A direção de ordenação. O padrão é MR (Mais Relevante). Outras opções são OF (Mais Antigos Primeiro) e NF (Mais Recentes Primeiro). **/

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

13 /** Paginação Precalculada: A página a ser buscada, começando em 0. Passe -1 para todos os comentários (até 250). **/

14 page?: number

15 /** Paginação Flexível: Quantos comentários devemos retornar? **/

16 limit?: number

17 /** Paginação Flexível: Quantos comentários filhos devemos retornar para cada pai? **/

18 limitChildren?: number

19 /** Paginação Flexível: Quantos comentários devemos pular? **/

20 skip?: number

21 /** Paginação Flexível: Quantos comentários filhos devemos pular para cada pai? **/

22 skipChildren?: number

23 /** Para determinar comentários bloqueados e sinalizados. **/

24 contextUserId?: string

25 /** Para determinar comentários bloqueados e sinalizados. **/

26 anonUserId?: string

27 /** Para buscar comentários filhos. **/

28 parentId?: string

29 /** Para buscar como uma árvore. **/

30 asTree?: boolean

31 /** Até que profundidade na árvore devemos retornar dados? 0 não retorna filhos. 1 retorna filhos imediatos, etc. **/

32 maxTreeDepth?: number

33}

34

The Response

Estrutura de Resposta de Comentários

Copy

1

2interface CommentsResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

7 reason?: string

8 /** Os comentários! **/

9 comments: Comment[]

10}

11

Helpful Tips

URL ID

Provavelmente você vai querer usar a API Comment com o parâmetro urlId. Você pode chamar a API Pages primeiro, para ver como os valores de urlId disponíveis para você se parecem.

Anonymous Actions

Para comentários anônimos, provavelmente você vai querer passar anonUserId ao buscar comentários, e ao realizar sinalizações e bloqueios.

(!) Isto é exigido por muitas lojas de aplicativos, pois os usuários devem ser capazes de sinalizar conteúdo criado por usuários que eles podem ver, mesmo que não estejam logados. Não fazer isso pode causar a remoção do seu app dessa loja.

Comments Not Being Returned

Verifique se seus comentários estão aprovados e não são spam.

Esta API permite buscar um único comentário por id.

Exemplo cURL: Obter comentário por ID

Copy

1

2curl --request GET \

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

4

Estrutura da Requisição: Obter comentário por ID

Copy

1

2interface CommentsGetByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta: Obter comentário por ID

Copy

1

2interface CommentGetByIdResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 /** O comentário! **/

9 comment?: Comment

10}

11

Este endpoint da API fornece a capacidade de criar comentários.

Casos de uso comuns incluem UIs personalizadas, integrações ou importações.

Notas:

• Esta API pode atualizar o widget de comentários "live" se desejado (isso aumenta o creditsCost de 1 para 2).
• Esta API criará automaticamente objetos de usuário em nosso sistema se o email for fornecido.
• Tentar salvar dois comentários com emails diferentes, mas o mesmo nome de usuário, resultará em um erro para o segundo comentário.
• Se você estiver especificando parentId, e um comentário filho tiver notificationSentForParent como false, enviaremos notificações para o comentário pai. Isso é feito a cada hora (agrupamos as notificações para diminuir o número de emails enviados).
• Se você quiser enviar emails de boas-vindas ao criar usuários, ou emails de verificação de comentário, defina sendEmails como true nos parâmetros de consulta.
• Comentários criados via esta API aparecerão nas páginas de Analytics e Moderation do aplicativo de administração.
• Palavrões ainda são mascarados nos nomes dos comentaristas e no texto do comentário se a configuração estiver ativada.
• Comentários criados via esta API ainda podem ser verificados quanto a spam, se desejado.
• Configurações como comprimento máximo do comentário, se configuradas via a página de administração Customization Rule, serão aplicadas aqui.

Os dados mínimos necessários para enviar que serão exibidos no widget de comentários são os seguintes:

Exemplo mínimo de POST cURL de Comentário

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

Uma requisição mais realista pode ser:

Exemplo de POST cURL para Comentário

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

Estrutura da Requisição POST de Comentário

Copy

1

2interface CommentPostQueryParams {

3 tenantId: string

4 API_KEY: string

5 doSpamCheck?: 'true' | 'false'

6 /** Se o comentário deve aparecer "live" para usuários visualizando instâncias do widget de comentários com o mesmo urlId. NOTA: Dobra o custo de créditos de 1 para 2. **/

7 isLive?: 'true' | 'false'

8 sendEmails?: 'true' | 'false'

9 populateNotifications?: 'true' | 'false'

10}

11

Estrutura da Resposta POST de Comentário

Copy

1

2

3interface CommentPostResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9 /** O comentário criado. **/

10 comment?: Comment

11 /** O usuário associado, que pode ou não já ter existido. **/

12 user?: User

13}

14

Este endpoint da API fornece a capacidade de atualizar um único comentário.

Notes:

• This API can update the comment widget "live" if desired (this increases base creditsCost from 1 to 2).
  • This can make migrating comments between pages "live" (changing urlId).
  • Migrations cost an additional 2 credits as pages are precalculated and this is CPU intensive.
• Unlike the create API, this API will NOT automatically create user objects in our system if email is provided.
• Comments updated via this API can still be checked for spam if desired.
• Configuration such as max comment length, if configured via the Customization Rule admin page, will apply here.
• To allow users to update their comment text, you can just specify comment in the request body. We will generate the resulting commentHTML.
  • If you define both comment and commentHTML we will not automatically generate the HTML.
  • If the user adds mentions or hashtags in their new text, it will still be processed like the POST API.
• When updating commenterEmail on a comment, it is best to also specify userId. Otherwise, you must ensure the user with this email belongs to your tenant, or the request will fail.

Exemplo mínimo de cURL PATCH de Comentário

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

Estrutura da Requisição PATCH de Comentário

Copy

1

2interface CommentPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** O usuário que está fazendo a atualização. Se desejado, pode ser usado para verificar que ele pode editar o comentário. **/

6 contextUserId?: string

7 /** Devemos verificar se o novo comentário parece spam? **/

8 doSpamCheck?: 'true' | 'false'

9 /** Se o comentário deve aparecer "ao vivo" para usuários que visualizam instâncias do widget de comentários com o mesmo urlId. NOTA: Dobra o custo de créditos de 1 para 2. **/

10 isLive?: 'true' | 'false'

11}

12

Estrutura da Resposta PATCH de Comentário

Copy

1

2

3interface CommentPatchResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9}

10

Este endpoint de API permite excluir um comentário.

Observações:

• Esta API pode atualizar o widget de comentários "live" se desejado (isso aumenta creditsCost de 1 para 2).
• Esta API excluirá todos os comentários filhos.

Exemplo cURL de DELETE de Comentário

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

Estrutura da Requisição DELETE de Comentário

Copy

1

2interface CommentDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** O usuário realizando a atualização. Se desejado, pode ser usado para verificar se ele pode excluir o comentário. **/

6 contextUserId?: string

7 /** Se o comentário deve ser excluído "ao vivo" para usuários visualizando instâncias do widget de comentários com o mesmo urlId. NOTE: Doubles credit cost from 1 to 2. **/

8 isLive?: 'true' | 'false'

9}

10

Estrutura da Resposta DELETE de Comentário

Copy

1

2

3interface CommentDeleteResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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

7 /** Incluído em caso de falha. **/

8 reason?: string

9}

10

Este endpoint da API permite sinalizar um comentário para um usuário específico.

Notas:

• Essa chamada deve sempre ser feita no contexto de um usuário. O usuário pode ser um FastComments.com User, SSO User, ou Tenant User.
• Se um limite de sinalizações-para-ocultar estiver definido, o comentário será automaticamente ocultado ao vivo depois de ter sido sinalizado o número de vezes definido.
• Depois que for automaticamente desaprovado (oculto) - o comentário só poderá ser re-aprovado por um administrador ou moderador. Remover a sinalização não re-aprovará o comentário.

Exemplo cURL de sinalização de comentário

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

Para sinalização anônima, devemos especificar um anonUserId. Isso pode ser um ID que representa a sessão anônima, ou um UUID aleatório. Isso nos permite suportar a sinalização e a remoção da sinalização de comentários mesmo que um usuário não esteja logado. Dessa forma, o comentário pode ser marcado como sinalizado quando os comentários são buscados com o mesmo anonUserId.

Exemplo cURL de sinalização de comentário anônimo

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

Estrutura da Requisição de Sinalização de Comentário

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Estrutura da Resposta de Sinalização de Comentário

Copy

1

2

3interface CommentFlagResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9 /** O comentário foi desaprovado (oculto) devido a ter sido sinalizado muitas vezes? **/

10 wasUnapproved?: boolean;

11}

12

Este endpoint da API fornece a capacidade de remover a sinalização (un-flag) de um comentário para um usuário específico.

Observações:

• Esta chamada deve sempre ser feita no contexto de um usuário. O usuário pode ser um FastComments.com User, SSO User, ou Tenant User.
• Após um comentário ser desaprovado automaticamente (oculto) - o comentário só pode ser reaprovado por um administrador ou moderador. Remover a sinalização (un-flagging) não irá reaprovar o comentário.

Exemplo cURL de remoção de sinalização de comentário

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

Para sinalização anônima, devemos especificar um anonUserId. Isso pode ser um ID que representa a sessão anônima, ou um UUID aleatório.

Exemplo cURL de remoção de sinalização de comentário anônimo

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

Estrutura da Requisição de Remoção de Sinalização de Comentário

Copy

1

2interface CommentFlagQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7}

8

Estrutura da Resposta de Remoção de Sinalização de Comentário

Copy

1

2

3interface CommentUnFlagResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9}

10

Este endpoint da API fornece a capacidade de bloquear um usuário que escreveu um determinado comentário. Ele suporta bloqueio de comentários escritos por FastComments.com Users, SSO Users e Tenant Users.

Ele suporta um parâmetro de corpo commentIdsToCheck para verificar se quaisquer outros comentários potencialmente visíveis no cliente devem ser bloqueados/desbloqueados após esta ação ser realizada.

Notas:

• Esta chamada deve sempre ser feita no contexto de um usuário. O usuário pode ser um FastComments.com User, SSO User ou Tenant User.
• O userId na requisição é o usuário que está fazendo o bloqueio. Por exemplo: User A quer bloquear User B. Passe userId=User A e o id do comentário que User B escreveu.
• Comentários completamente anônimos (sem user id, sem email) não podem ser bloqueados e um erro será retornado.

Exemplo cURL de bloqueio de comentário

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

Para bloqueio anônimo, devemos especificar um anonUserId. Isso pode ser um ID que representa a sessão anônima, ou um UUID aleatório. Isso nos permite suportar o bloqueio de comentários mesmo que um usuário não esteja logado, buscando os comentários com o mesmo anonUserId.

Exemplo cURL de bloqueio de comentário anônimo

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

Estrutura da requisição de bloqueio de comentário

Copy

1

2interface CommentBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Estrutura da resposta de bloqueio de comentário

Copy

1

2

3interface CommentBlockResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9 /** Se commentIdsToCheck estiver definido, entradas neste mapa com true também são bloqueadas. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

Este endpoint da API fornece a capacidade de desbloquear um usuário que escreveu um determinado comentário. Ele suporta o desbloqueio de comentários escritos por FastComments.com Users, SSO Users, and Tenant Users.

Ele suporta um parâmetro de corpo commentIdsToCheck para verificar se quaisquer outros comentários potencialmente visíveis no cliente devem ser bloqueados/desbloqueados após esta ação ser executada.

Notas:

• Esta chamada deve sempre ser feita no contexto de um usuário. O usuário pode ser um FastComments.com User, SSO User, ou Tenant User.
• O userId na requisição é o usuário que está realizando o desbloqueio. Por exemplo: User A quer desbloquear User B. Passe userId=User A e o id do comentário que User B escreveu.
• Comentários completamente anônimos (sem user id, sem email) não podem ser bloqueados e um erro será retornado.

Exemplo cURL de Desbloqueio de Comentário

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

Exemplo cURL de Desbloqueio de Comentário Anônimo

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

Estrutura da Requisição de Desbloqueio de Comentário

Copy

1

2interface CommentUnBlockQueryParams {

3 tenantId: string

4 API_KEY: string

5 userId?: string

6 anonUserId?: string

7 commentIdsToCheck?: string[]

8}

9

Estrutura da Resposta de Desbloqueio de Comentário

Copy

1

2

3interface CommentUnBlockResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9 /** Se commentIdsToCheck estiver definido, entradas neste mapa com true ainda estão bloqueadas. Se false, você pode querer reexibir os comentários para o usuário para que ele não precise atualizar. **/

10 commentStatuses?: Record<string, boolean>;

11}

12

EmailTemplates individuais podem ser obtidos pelo seu id correspondente (NÃO emailTemplateId).

Exemplo cURL de EmailTemplate por ID

Copy

1

2curl --request GET \

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

4

Estrutura da Requisição de EmailTemplate por ID

Copy

1

2interface EmailTemplatesByIdRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta de EmailTemplate por ID

Copy

1

2interface EmailTemplateResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 emailTemplate?: EmailTemplate | null

9}

10

Esta API usa paginação, fornecida pelo parâmetro de consulta page. EmailTemplates são retornados em páginas de 100, ordenados por createdAt e depois por id.

Exemplo cURL de EmailTemplate

Copy

1

2curl --request GET \

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

4

Estrutura de Requisição de EmailTemplate

Copy

1

2interface EmailTemplatesRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** A página a ser buscada, começando em 0. **/

6 page: number

7}

8

Estrutura de Resposta de EmailTemplate

Copy

1

2interface EmailTemplatesResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 emailTemplates: EmailTemplate[]

9}

10

Este endpoint da API permite atualizar um modelo de e-mail especificando apenas o id e os atributos a serem atualizados.

Observe que todas as mesmas validações para criar um modelo também se aplicam, por exemplo:

• O modelo deve renderizar. Isso é verificado a cada atualização.
• Não é permitido ter modelos duplicados para o mesmo domínio (caso contrário, um deles seria ignorado silenciosamente).

Exemplo cURL PATCH EmailTemplate

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

Estrutura da Requisição PATCH EmailTemplate

Copy

1

2interface EmailTemplatePatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura de Resposta PATCH EmailTemplate

Copy

1

2

3interface EmailTemplatePatchResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9 /** O modelo de e-mail atualizado. **/

10 emailTemplate?: EmailTemplate

11}

12

This API endpoint provides the ability to create email templates.

Notes:

• You can't have multiple templates with the same emailTemplateId with the same domain.
• But you can have a wildcard template (domain = * and a domain specific template for the same emailTemplateId).
• Specifying domain is only relevant if you have different domains, or want to use specific templates for testing (domain set to localhost etc).
• If you do specify domain it must match a DomainConfig. On error a list of valid domains is provided.
• The template syntax is EJS and is rendered with a 500ms timeout. P99 for rendering is <5ms, so if you hit 500ms something is wrong.
• Your template must render with your given testData to save. Render errors are aggregated and reported on in the dashboard (soon available via API).

The minimum data required to add a template is as follows:

Exemplo mínimo de cURL POST para EmailTemplate

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

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

Exemplo de cURL POST para EmailTemplate

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

Estrutura da Requisição POST de EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta POST de EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

8 reason?: string

9 /** O template criado. **/

10 emailTemplate?: EmailTemplate

11}

12

Este endpoint da API permite visualizar modelos de e-mail.

Exemplo mínimo de cURL POST para pré-visualização de EmailTemplate

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

Estrutura da requisição POST de EmailTemplate

Copy

1

2interface EmailTemplatePostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da resposta POST de EmailTemplate

Copy

1

2

3interface EmailTemplatePostResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

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

7 /** Incluído em caso de falha. **/

8 reason?: string

9 /** O HTML renderizado em caso de sucesso. **/

10 html?: string

11}

12

Esta rota remove um único EmailTemplate por id.

Exemplo de cURL para remoção de EmailTemplate

Copy

1

2curl --request DELETE \

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

4

Estrutura da Requisição de Remoção de EmailTemplate

Copy

1

2interface EmailTemplateRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta de Remoção de EmailTemplate

Copy

1

2interface EmailTemplateDeleteResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8}

9

Esta API usa paginação, fornecida pelo parâmetro de consulta page. HashTags são retornadas em páginas de 100, ordenadas por tag.

Exemplo cURL de HashTag

Copy

1

2curl --request GET \

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

4

Estrutura de Requisição de HashTag

Copy

1

2interface HashTagsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** A página a ser buscada, começando em 0. **/

6 page: number

7}

8

Estrutura de Resposta de HashTag

Copy

1

2interface HashTagsResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 /** As hashtags! **/

9 hashTags: HashTag[]

10}

11

Esta rota permite atualizar um único HashTag.

Exemplo cURL de atualização de HashTag

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

Estrutura de requisição de atualização de HashTag

Copy

1

2interface HashTagPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura de resposta de atualização de HashTag

Copy

1

2interface HashTagPatchResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

7 reason?: string

8 hashTag?: HashTag; // Retornamos a hashtag completa atualizada em caso de sucesso.

9}

10

Esta rota permite adicionar uma única HashTag.

Exemplo cURL de criação de HashTag

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

Estrutura de Requisição de Criação de HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura de Resposta de Criação de HashTag

Copy

1

2interface HashTagPostResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

7 reason?: string

8 hashTag?: HashTag; // Retornamos a hashtag completa criada em caso de sucesso.

9}

10

Esta rota fornece a capacidade de adicionar até 100 HashTag objects de uma só vez.

Exemplo cURL de criação em massa de HashTag

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

Estrutura de Requisição de Criação em Massa de HashTag

Copy

1

2interface HashTagPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura de Resposta de Criação em Massa de HashTag

Copy

1

2interface HashTagBulkPostResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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 /** Incluído em caso de falha. **/

7 reason?: string

8 results?: HashTagPostResponse[]; // Retornamos uma lista de objetos HashTagPostResponse para cada tag fornecida.

9}

10

Esta rota permite a remoção de um usuário HashTag pelo tag fornecido.

Observe que, a menos que a criação automática de HashTag esteja desativada, hashtags podem ser recriadas por um usuário que fornecer a hashtag ao comentar.

Exemplo cURL de Remoção de HashTag

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

Estrutura de Requisição de Remoção de HashTag

Copy

1

2interface HashTagDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura de Resposta de Remoção de HashTag

Copy

1

2interface HashTagDeleteResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8}

9

Um objeto Moderator representa a configuração para um moderador.

Existem três tipos de moderadores:

1. Usuários administradores que possuem a flag isCommentModeratorAdmin.
2. Usuários SSO com a flag isCommentModeratorAdmin.
3. Comentadores regulares, ou usuários do FastComments.com, que são convidados como Moderadores.

A estrutura Moderator é usada para representar o Estado de Moderação do caso de uso 3.

Se você quiser convidar um usuário para ser moderador via API, use a API Moderator criando um Moderator e inviting o usuário.

Se o usuário não tiver uma conta no FastComments.com, o e-mail de convite ajudará a configurá-la. Se já tiverem uma conta, eles receberão acesso de moderação ao seu tenant e o userId do objeto Moderator será atualizado para apontar para o usuário deles. Você não terá acesso via API ao usuário deles, pois nesse caso a conta pertence a eles e é gerenciada pelo FastComments.com.

Se você precisar de gerenciamento completo da conta do usuário, recomendamos usar SSO ou adicioná-los como um Tenant User e então adicionar um objeto Moderator para rastrear suas estatísticas.

A estrutura Moderator pode ser usada como um mecanismo de rastreamento de estatísticas para os casos de uso 1 e 2. Após criar o usuário, adicione um objeto Moderator com o userId dele definido e suas estatísticas serão rastreadas na Página de Moderadores de Comentários.

A estrutura do objeto Moderator é a seguinte:

Estrutura do 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

Esta rota retorna um único moderador pelo seu id.

Exemplo cURL de Moderador por ID

Copy

1

2curl --request GET \

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

4

Estrutura da Requisição de Moderador

Copy

1

2interface ModeratorByIdQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta de Moderador

Copy

1

2interface ModeratorByIdResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 moderator?: Moderator

9}

10

Esta API usa paginação, fornecida pelo parâmetro de consulta skip. Moderadores são retornados em páginas de 100, ordenados por createdAt e id.

O custo é baseado no número de moderadores retornados, custando 1 credit per 10 moderadores retornados.

Exemplo cURL do Moderador

Copy

1

2curl --request GET \

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

4

Estrutura da Requisição do Moderador

Copy

1

2interface ModeratorsRequestQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** O número de moderadores a pular para paginação. **/

6 skip?: number

7}

8

Estrutura de Resposta do Moderador

Copy

1

2interface ModeratorsResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 moderators?: Moderator[]

9}

10

Este endpoint da API fornece a habilidade de atualizar um Moderator por id.

A atualização de um Moderator tem as seguintes restrições:

• Os seguintes valores não podem ser fornecidos ao atualizar um Moderator:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Quando um userId for especificado, esse usuário deve existir.
• Quando um userId for especificado, esse usuário deve pertencer ao mesmo tenantId especificado nos parâmetros de consulta.
• Dois moderadores no mesmo tenant não podem ser adicionados com o mesmo email.
• Você não pode alterar o tenantId associado a um Moderator.

Exemplo cURL PATCH de Moderator

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

Estrutura da Requisição PATCH de Moderator

Copy

1

2interface ModeratorPatchQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta PATCH de Moderator

Copy

1

2

3interface ModeratorPatchResponse {

4 status: 'success' | 'failed'

5 /** Incluído em caso de falha. **/

6 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found';

7 /** Incluído em caso de falha. **/

8 reason?: string

9}

10

Esta rota permite adicionar um único Moderator.

A criação de um Moderator tem as seguintes restrições:

• Um name e um email devem sempre ser fornecidos. Um userId é opcional.
• Os seguintes valores não podem ser fornecidos ao criar um Moderator:
  • acceptedInvite
  • markReviewedCount
  • deletedCount
  • markedSpamCount
  • approvedCount
  • editedCount
  • bannedCount
  • verificationId
  • createdAt
• Quando um userId é especificado, esse usuário deve existir.
• Quando um userId é especificado, ele deve pertencer ao mesmo tenantId especificado nos parâmetros de consulta.
• Dois moderadores no mesmo tenant não podem ser adicionados com o mesmo email.

Podemos criar um Moderator para um usuário do qual conhecemos apenas o e-mail:

Exemplo cURL: criação de Moderador por e-mail

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

Ou podemos criar um Moderator para um usuário que pertence ao nosso tenant, para rastrear suas estatísticas de moderação:

Exemplo cURL: criação de Moderador via usuário do tenant

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

Estrutura da Requisição de Criação de Moderador

Copy

1

2interface ModeratorPostQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta de Criação de Moderador

Copy

1

2interface ModeratorPostResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

5 code?: 'missing-tenant-id' | 'invalid-tenant-id' | 'invalid-api-key' | 'missing-api-key' | 'name-required' | 'email-required' | 'unexpected-param' | 'not-found'

6 /** Incluído em caso de falha. **/

7 reason?: string

8 moderator?: Moderator; // Retornamos o moderador completo criado em caso de sucesso.

9}

10

Esta rota fornece a capacidade de convidar um único Moderator.

As seguintes restrições existem para enviar um email de convite a um Moderator:

• O Moderator deve já existir.
• O fromName não pode ter mais de 100 characters.

Observações:

• Se um usuário com o e-mail fornecido já existir, ele será convidado a moderar os comentários do seu tenant.
• Se um usuário com o e-mail fornecido não existir, o link de convite o guiará pelo processo de criação da conta.
• O convite expirará após 30 days.

Podemos criar um Moderator para um usuário do qual só sabemos o e-mail:

Exemplo de cURL de convite de Moderador

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

Isso enviará um e-mail como Bob at TenantName is inviting you to be a moderator...

Estrutura da Requisição de Convite de Moderador

Copy

1

2interface ModeratorSendInviteQueryParams {

3 tenantId: string

4 API_KEY: string

5 /** O e-mail enviado ao usuário aparecerá como se tivesse sido enviado por este nome. **/

6 fromName: string

7}

8

Estrutura da Resposta de Convite de Moderador

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 /** Incluído em caso de falha. **/

7 reason?: string

8}

9

Esta rota fornece a remoção de um Moderator por id.

Exemplo cURL de Remoção de Moderator

Copy

1

2curl --request DELETE \

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

4

Estrutura da Requisição de Remoção de Moderator

Copy

1

2interface ModeratorDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta de Remoção de Moderator

Copy

1

2interface ModeratorDeleteResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8}

9

Esta rota retorna um único NotificationCount pelo id do usuário. Com SSO, o id do usuário está no formato <tenant id>:<user id>.

Se não houver notificações não lidas, não haverá um NotificationCount - portanto você receberá um 404.

Isto é diferente de notifications/count pois é muito mais rápido, mas não permite filtragem.

Exemplo cURL de NotificationCount por ID

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

Estrutura de Requisição NotificationCount

Copy

1

2interface NotificationCountGetQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura de Resposta NotificationCount

Copy

1

2interface NotificationCountGetResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8 data?: NotificationCount

9}

10

Esta rota exclui um único NotificationCount pelo id do usuário. Com SSO, o id do usuário está no formato <tenant id>:<user id>.

Isso limpará a contagem de notificações não lidas do usuário (o sino vermelho no widget de comentários desaparecerá e a contagem sumirá).

Exemplo cURL para DELETE de NotificationCount

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

Estrutura da Requisição para Remoção de NotificationCount

Copy

1

2interface NotificationCountDeleteQueryParams {

3 tenantId: string

4 API_KEY: string

5}

6

Estrutura da Resposta para Remoção de NotificationCount

Copy

1

2interface NotificationCountDeleteResponse {

3 status: 'success' | 'failed'

4 /** Incluído em caso de falha. **/

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

6 /** Incluído em caso de falha. **/

7 reason?: string

8}

9