Ir para o conteúdo

Integre nossa API ao seu sistema

Conecte-se rapidamente à nossa API e comece a usar nossos serviços seguindo os passos abaixo.

Como integrar nossa API ao seu sistema?

Gerar suas credenciais de acesso

Para começar, gere sua Chave de API e Chave Secreta na área logada, acessando o menu de cadastros e clicando em 'API'. Essas chaves serão usadas para autenticar e autorizar seu sistema.

Criar e enviar um link de avaliação

Depois que o cliente usa seu serviço, seu sistema faz login na nossa API e cria um link de avaliação. Esse link pode ser enviado automaticamente por e-mail ou WhatsApp, conforme sua preferência. No detalhe do produto/serviço na sua área de cadastro, há um exemplo de requisição pronto para uso, basta substituir os dados do seu cliente.

Seu cliente avalia

O cliente recebe o link e preenche a avaliação, que é enviada diretamente para nossa API.

Análise do feedback

Nosso sistema processa o feedback com inteligência artificial avançada, gerando um relatório completo e personalizado para você.

Acompanhe os resultados

Visualize os insights diretamente no dashboard do portal e use os dados para aprimorar a experiência do seu cliente.

Exemplo de login do seu servidor na API

curl -X 'POST' \
                    'https://api.iareview.ai/v1/signin-with-credentials' \
                    -H 'accept: application/json' \
                    -H 'apiKey: your-api-key' \
                    -H 'secretKey: your-secret-key'

Exemplo de requisição para criar um feedback

curl -X 'POST' \
                    'https://api.iareview.ai/v1/evaluation' \
                    -H 'accept: application/json' \
                    -H 'Authorization: Bearer TOKEN' \
                    -H 'X-Customer-Id: your-api-key' \
                    -H 'Content-Type: application/json' \
                    -d '{
                    "categoryProduct": "category name",
                    "channelEvaluationSended": "Email",
                    "comments": "", //optional
                    "email": "responder email", //if channel is Email
                    "name": "responder name",
                    "phoneNumber": "responder phone number format +5511999881234", //if channel is Whatsapp
                    "productId": "your-product-id", //get from registers -> products/services
                    "productName": "product name",
                    "evaluationType": "CSAT|NPS|BOTH",
                    "templateName": "",
                  }'

Projeto de integração (exemplo)

Quer ver um projeto já integrado? Veja um exemplo completo no GitHub.

Integração via Widget

Você também pode incorporar nosso widget responsivo diretamente no seu site usando um iframe, como no exemplo abaixo.

É possível definir o conteúdo a ser avaliado e o período de exibição.

O mesmo widget pode ser integrado via script JavaScript padrão ou como um componente para React/Next.js.

Além disso, ele pode ser exibido de forma flutuante na lateral da tela — como fazemos na nossa página inicial.

O script de integração pode ser copiado pronto diretamente na área do cliente, acessando o menu Cadastro e a aba Configuração do Widget.