Se quiserem mostrar o vosso SaysScore e as avaliações no vosso próprio design ou sistema, podem obtê-los com a API. É REST e JSON, e estes pedidos não exigem chave.
Pontuação e distribuição
GET https://api.trustsays.com/v1/companies/asuaempresa.pt
A resposta contém, entre outros:
- saysScore: o vosso SaysScore.
- reviewCount: número de avaliações.
- distribution: número de avaliações com 1 a 5 estrelas.
Avaliações
GET https://api.trustsays.com/v1/companies/asuaempresa.pt/reviews
A resposta vem em páginas de 10 avaliações. Escolham a página com page. A resposta indica também o número total e o número de páginas. Podem filtrar com:
- stars: p. ex. 4,5 para apenas 4 e 5 estrelas.
- lang: o idioma da avaliação, p. ex. pt.
- country: o país, p. ex. PT.
- verified=true: apenas compras verificadas.
- replied=true: apenas avaliações com resposta.
- sort: newest, helpful, rating_desc ou rating_asc.
Bom saber
- Chamem a API a partir do vosso servidor. Não pode ser chamada diretamente a partir de um navegador noutro domínio.
- As respostas ficam guardadas até 60 segundos, por isso as novas avaliações podem demorar um minuto a aparecer. Não façam pedidos com mais frequência do que o necessário.
- Ainda não existem SDK nem documentação pública. Vejam exemplos em API e programadores.
- As respostas a partir da vossa própria ferramenta de apoio ao cliente e os temas através da API chegam mais tarde.
Se não funcionar
- 404: O domínio não existe na TrustSays. Usem o domínio sem https e sem www.
- Se só quiserem mostrar as estrelas, um widget é mais fácil. Vejam Colocar as estrelas no site.