VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Blog

Comentários do blog

Lista e modera os comentários dos leitores: aprovar, rejeitar ou apagar.

Listar comentários

Devolve os comentários de todos os posts, do mais novo para o mais antigo. Comentários novos entram como pending e só aparecem na vitrine depois de aprovados.

GET/api/v1/admin/blog/commentsAdmin

Lista os comentários dos posts para moderação

Rota ligada ao módulo blog: com o módulo desligado a resposta é 403. Leitura exige manage_content ou view_content; escrita exige manage_content.

Parâmetros de consulta

post_iduuid
Só comentários desse post.
statusstring
pendingapprovedrejected
Filtra pelo estado.
pageintegerpadrão: 1
Página, a partir de 1.
limitintegerpadrão: 20
Itens por página, 1 a 100; fora disso vale 20.

Exemplo de requisição (Listar comentários)

bash
curl "$BASE_URL/api/v1/admin/blog/comments?status=pending" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Listar comentários)

200Comentários
json
{
  "items": [
    {
      "id": "7d1b6f0a-3a8e-4b8f-9d71-6b0e0b3a9c11",
      "post_id": "91af684b-cf41-4243-a37d-a133a39d6ed3",
      "post_title": "Como escolher o mouse perfeito",
      "user_id": "3093f506-d6af-4c27-9ef6-c245e8e602f9",
      "user_name": "Maria Souza",
      "user_email": "maria.souza@example.com",
      "body": "Ótimo guia!",
      "status": "pending",
      "ip_address": "203.0.113.10",
      "created_at": "2026-10-10T14:00:00Z",
      "updated_at": "2026-10-10T14:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20
}

Campos da resposta

itemsarray

Comentários da página.

iduuid
Identificador do comentário.
post_iduuid
Post comentado.
post_titlestring
Título do post, para exibir (só na lista).
user_iduuid
Cliente que comentou, quando estava logado. Ausente em visitante.
user_namestring
Nome de quem comentou.
user_emailstring
E-mail de quem comentou (dado pessoal).
bodystring
Texto do comentário.
statusstring
pending, approved ou rejected.
ip_addressstring
IP de origem. Ausente quando não registrado.
created_atstring
Criação, RFC 3339.
updated_atstring
Última alteração, RFC 3339.
totalinteger
Total que atende ao filtro.
pageinteger
Página devolvida.
limitinteger
Itens por página usados.

Erros (Listar comentários)

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_content","view_content"]}

Aprovar comentário

Marca o comentário como approved, e ele passa a aparecer na vitrine. Não precisa de corpo.

PUT/api/v1/admin/blog/comments/{id}/approveAdmin

Aprova um comentário

Rota ligada ao módulo blog: com o módulo desligado a resposta é 403. Leitura exige manage_content ou view_content; escrita exige manage_content.

Parâmetros de caminho

iduuidobrigatório
Identificador do comentário.

Exemplo de requisição (Aprovar)

bash
curl -X PUT "$BASE_URL/api/v1/admin/blog/comments/7d1b6f0a-3a8e-4b8f-9d71-6b0e0b3a9c11/approve" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Aprovar)

200Comentário aprovado
json
{
  "id": "7d1b6f0a-3a8e-4b8f-9d71-6b0e0b3a9c11",
  "post_id": "91af684b-cf41-4243-a37d-a133a39d6ed3",
  "post_title": "Como escolher o mouse perfeito",
  "user_id": "3093f506-d6af-4c27-9ef6-c245e8e602f9",
  "user_name": "Maria Souza",
  "user_email": "maria.souza@example.com",
  "body": "Ótimo guia!",
  "status": "approved",
  "ip_address": "203.0.113.10",
  "created_at": "2026-10-10T14:00:00Z",
  "updated_at": "2026-10-10T14:00:00Z"
}

Erros (Aprovar)

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio exigido.{"error":"insufficient privileges","required":"manage_content"}
404Não existe comentário com esse id.{"error":"comment not found"}

Rejeitar comentário

Marca o comentário como rejected: ele deixa de aparecer na vitrine, mas continua guardado. Dá para aprovar de novo depois.

PUT/api/v1/admin/blog/comments/{id}/rejectAdmin

Rejeita um comentário

Rota ligada ao módulo blog: com o módulo desligado a resposta é 403. Leitura exige manage_content ou view_content; escrita exige manage_content.

Parâmetros de caminho

iduuidobrigatório
Identificador do comentário.

Exemplo de requisição (Rejeitar)

bash
curl -X PUT "$BASE_URL/api/v1/admin/blog/comments/7d1b6f0a-3a8e-4b8f-9d71-6b0e0b3a9c11/reject" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Rejeitar)

200Comentário rejeitado
json
{
  "id": "7d1b6f0a-3a8e-4b8f-9d71-6b0e0b3a9c11",
  "post_id": "91af684b-cf41-4243-a37d-a133a39d6ed3",
  "post_title": "Como escolher o mouse perfeito",
  "user_id": "3093f506-d6af-4c27-9ef6-c245e8e602f9",
  "user_name": "Maria Souza",
  "user_email": "maria.souza@example.com",
  "body": "Ótimo guia!",
  "status": "rejected",
  "ip_address": "203.0.113.10",
  "created_at": "2026-10-10T14:00:00Z",
  "updated_at": "2026-10-10T14:00:00Z"
}

Erros (Rejeitar)

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio exigido.{"error":"insufficient privileges","required":"manage_content"}
404Não existe comentário com esse id.{"error":"comment not found"}

Apagar comentário

Remove o comentário de vez. Para apenas escondê-lo, prefira rejeitar.

DELETE/api/v1/admin/blog/comments/{id}Admin

Apaga um comentário

Rota ligada ao módulo blog: com o módulo desligado a resposta é 403. Leitura exige manage_content ou view_content; escrita exige manage_content.

Parâmetros de caminho

iduuidobrigatório
Identificador do comentário.

Exemplo de requisição (Apagar)

bash
curl -X DELETE "$BASE_URL/api/v1/admin/blog/comments/7d1b6f0a-3a8e-4b8f-9d71-6b0e0b3a9c11" \
  -H "Authorization: Bearer $TOKEN"

Resposta (Apagar)

200Comentário apagado
json
{
  "message": "comment deleted"
}

Erros (Apagar)

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio exigido.{"error":"insufficient privileges","required":"manage_content"}
404Não existe comentário com esse id.{"error":"comment not found"}
Exclusão definitiva

Não há como restaurar.

Veja também

  • Listar e consultar posts
  • Categorias do blog
Anterior
Traduções da categoria
Próxima
Imagem de destaque com IA
Nesta página
  • Listar comentários
  • Exemplo de requisição (Listar comentários)
  • Resposta (Listar comentários)
  • Erros (Listar comentários)
  • Aprovar comentário
  • Exemplo de requisição (Aprovar)
  • Resposta (Aprovar)
  • Erros (Aprovar)
  • Rejeitar comentário
  • Exemplo de requisição (Rejeitar)
  • Resposta (Rejeitar)
  • Erros (Rejeitar)
  • Apagar comentário
  • Exemplo de requisição (Apagar)
  • Resposta (Apagar)
  • Erros (Apagar)
  • Veja também