QorumVisão geral
O Qorum guarda e entrega os comentários do seu site. Você escolhe se mostra com o widget pronto ou se monta a interface com a API. Esta página explica as peças e ajuda a escolher o caminho.
Como funciona
Quando alguém abre uma página do seu site:
- A página carrega o widget (ou chama a API) passando a chave pública do site e o ref, que diz qual conversa mostrar.
- O Qorum confere se a página está num domínio liberado para aquele site e devolve os comentários daquela conversa.
- Se a pessoa estiver logada, o widget manda junto um token de login. Com ele, ela pode comentar, responder, curtir e denunciar.
- Quando algo acontece (comentário novo, resposta, denúncia), o Qorum pode avisar o seu servidor por webhook.
Os comentários ficam guardados no Qorum. Seu site não precisa de banco de dados para eles.
As peças
| Peça | O que é |
|---|---|
| Site | Cada site que você cadastra no painel. Tem domínios liberados, chaves, aparência e regras próprias. |
Conversa (ref) | Um texto que identifica a página dos comentários, como post-42. Mesmo ref, mesma conversa. Você escolhe o formato. |
| Chave pública | Começa com pk_. Vai na página, junto do widget. Pode aparecer para qualquer pessoa. |
| Chave secreta | Começa com sk_. Fica só no seu servidor. Assina os logins e libera a API de gerência. |
| Segredo do webhook | Começa com wh_. Seu servidor usa para conferir que um aviso veio mesmo do Qorum. |
| Login do seu site | Quem já tem conta no seu site comenta com ela. Seu servidor gera um token assinado com a chave secreta. |
| Conta Qorum | Para sites sem login: a pessoa cria usuário e senha dentro do widget. Vale em todos os sites que usam o Qorum. |
| Moderador | Pessoa da sua equipe que pode aprovar, apagar, fixar e banir, no painel e direto no widget. |
Tudo o que vai para o navegador pode ser lido por qualquer pessoa. Quem tiver a chave secreta consegue apagar comentários, trocar configurações e entrar como qualquer usuário do seu site.
Qual caminho escolher
Widget pronto
Escolha o widget se você quer comentários funcionando hoje, com pouco código. Ele já tem respostas, curtidas, imagens, notificações, login, moderação e cinco templates que você ajusta no painel.
API para o seu design
Escolha a API se o seu site tem um visual próprio e você quer que os comentários sigam exatamente esse visual, ou se está fazendo um aplicativo. A API devolve cada comentário com o texto já em HTML seguro e o cartão do autor, prontos para você desenhar.
Os dois juntos
Dá para misturar. Um exemplo comum: o widget nas páginas, e a API de gerência dentro do painel administrativo do seu site para a equipe moderar sem abrir o painel do Qorum.
O que você vai precisar
- Uma conta no painel (só usuário e senha).
- O endereço do seu site, para liberar o domínio.
- Acesso para colar um trecho de código nas páginas.
- Opcional: um servidor (PHP, Node, Python, Go ou outro) se você quiser usar o login do seu site ou receber webhooks.
Pronto para começar? Siga os primeiros passos.