Skip to content

Avaliações

Visão Geral

As avaliações são análises e críticas feitas por compradores sobre um produto, serviço ou ferramenta, permitindo relatar experiência, satisfação pessoal e recomendações para outros clientes.

Elas trazem transparência para a decisão de compra e fornecem ao lojista feedbacks valiosos, possibilitando melhorias e ajustes para aumentar a satisfação dos clientes.

Entidades Relacionadas

No contexto Uappi, as avaliações estão relacionadas a três tipos principais: App, Produto e Canal de Venda. Apesar das particularidades de cada um, todos compartilham muitas características em relação as avaliações.

Apps - Usuário

Um App funciona como um plug-in para a loja, adicionando funcionalidades extras como login social, métodos de pagamento, cálculo de frete, envio de e-mails ou integração com redes sociais.

As avaliações de Apps permitem ao lojista analisar experiências de outros usuários, ajudando a decidir se vale a pena ativar determinada ferramenta no ecossistema da loja.

Canal de Venda - Cliente

O canal de venda define como a loja é disponibilizada e acessada pelos clientes, incluindo o domínio e o contexto de operação.

As avaliações nesse contexto refletem a experiência do cliente com a loja, indicando confiabilidade e qualidade do serviço/produtos, além de fornecer feedback direto ao lojista.

Produto - Cliente

Um produto pode ser físico ou digital, incluindo serviços, plataformas ou funcionalidades. O foco principal é o valor entregue ao usuário.

As avaliações de produtos ajudam outros clientes a tomar decisões mais conscientes, enquanto permitem ao lojista entender satisfação, pontos fortes e melhorias necessárias.

Regras gerais para Avaliações

  • Uma avaliação não pode ser feita mais de uma vez por item (App, produto ou canal de venda)
  • Toda avaliação feita por um cliente é cadastrada inicialmente como inativa; a ativação é responsabilidade do lojista (no caso de Apps, apenas o Admin Sources)
  • Qualquer ativação ou desativação de avaliação recalcula a nota média do item, considerando ou desconsiderando a avaliação atual

Listagem geral de avaliações de apps feita por usuários

GET /review/app

Listagem geral de avaliações de apps feita por usuários

Descrição

Endpoint responsável por retornar todas as avaliações de aplicativos realizadas pelos usuários da plataforma 🧩⭐.

O status de exibição dessas avaliações é controlado e gerenciado exclusivamente por funcionários da Uappi.

Este endpoint permite que as avaliações de apps sejam consultadas por todos os lojistas, auxiliando administradores na decisão de instalar ou não um aplicativo em sua loja, com base na experiência de outros lojistas do ecossistema Uappi.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {token}Token de autenticação

Campos de Condição Disponíveis

CampoTipoDescrição
appIdintegerFiltra avaliações por id do app
userIditnegerFiltra avaliações por usuário
namestringFiltra avaliações pelo nome
emailstringFiltra avaliações pelo e-mail de quem avaliou
recommendedbooleanFiltra avaliações por clientes que recomendam ou não o produto (true/false)
scoreintFiltra avaliações pela nota (de 0 a 5)
createdAtstringFiltra avaliações baseado na data de cadastro

Campos de Ordenação Disponíveis

CampoDescrição
idOrdena a listagem pelo id da avaliação
appIdOrdena avaliações por app
userIdOrdena avaliações por usuário
nameOrdena a listagem pelo nome da avaliação
scoreOrdena a listagem pela nota da avaliação
createdAtOrdena a listagem pela data em que a avaliação foi criada
updatedAtOrdena a listagem pela data em que a avaliação foi atualizada

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/review/app \
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2  "registers": [
3			{
4				"id": 1,
5				"name": "josé",
6				"email": "jose@uappi.com.br",
7				"comment": "Gostei do app, nota 10",
8				"recommended": true,
9				"score": 3,
10				"active": true,
11				"masked": false,
12				"createdAt": "2026-01-29 12:13:36",
13				"updatedAt": "2026-01-29 12:13:36",
14				"appId": 1,
15				"userId": 1
16			}
17		],
18		"pagination": {
19			"limit": 10,
20			"offset": 0,
21			"pages": 1,
22			"registers": 1
23		}
24	}

Listagem de avaliações de apps feita por usuários

GET /review/app/user

Listagem geral de avaliações de apps do usuários

Descrição

Endpoint responsável por retornar todas as avaliações de aplicativos realizadas pelo usuário autenticado 🧩⭐.

Este endpoint lista apenas as avaliações feitas pelo próprio usuário sobre aplicativos da plataforma, permitindo a consulta e acompanhamento do seu histórico de avaliações.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {token}Token de autenticação

Campos de Condição Disponíveis

CampoTipoDescrição
appIdintegerFiltra avaliações por id do app
namestringFiltra avaliações pelo nome
emailstringFiltra avaliações pelo e-mail de quem avaliou
recommendedbooleanFiltra avaliações por clientes que recomendam ou não o produto (true/false)
scoreintFiltra avaliações pela nota (de 0 a 5)
createdAtstringFiltra avaliações baseado na data de cadastro

Campos de Ordenação Disponíveis

CampoDescrição
idOrdena a listagem pelo id da avaliação
appIdOrdena avaliações por app
nameOrdena a listagem pelo nome da avaliação
scoreOrdena a listagem pela nota da avaliação
createdAtOrdena a listagem pela data em que a avaliação foi criada
updatedAtOrdena a listagem pela data em que a avaliação foi atualizada

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/review/app/user\
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2  "registers": [
3    {
4      "id": 1,
5      "name": "jose",
6      "email": "jose@uappi.com.br",
7      "comment": "Gostei do App, nota 10",
8      "recommended": true,
9      "score": 3,
10      "active": false,
11      "masked": false,
12      "createdAt": "2025-10-15 17:22:01",
13      "updatedAt": "2025-10-15 17:22:01",
14      "appId": 1,
15      "userId": 1
16    },
17    {
18      "id": 1,
19      "name": "marcos",
20      "email": "marcos@uappi.com.br",
21      "comment": "Gostei do app, nota 10",
22      "recommended": true,
23      "score": 3,
24      "active": false,
25      "masked": false,
26      "createdAt": "2026-01-29 12:13:36",
27      "updatedAt": "2026-01-29 12:13:36",
28      "appId": 1,
29      "userId": 1
30    }
31  ],
32  "pagination": {
33    "limit": 10,
34    "offset": 0,
35    "pages": 1,
36    "registers": 2
37  }
38}

Busca por avaliação de cliente

GET /reviews/app/{appId}

Cadastra avaliação realizada pelo usuário atual para um app.

Descrição

Endpoint responsável por buscar e cadastrar a avaliação de um usuário referente a um aplicativo da plataforma 🧩⭐.

Toda avaliação recém-cadastrada é criada automaticamente com status "inativo", permanecendo assim até que um funcionário da Uappi realize a ativação.

As avaliações de aplicativos não são exibidas para clientes finais, sendo destinadas exclusivamente ao uso interno da plataforma.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {UserToken}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
appIdintegerSimID único da entidade de app a ser avaliado

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
commentstring✅Comentário do usuário (max 65535 caracteres)
recommendedbooleano✅Recomendação do usuário
scoreinteger✅Pontuação da avaliação (entre 1 a 5)

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/reviews/sales-channel\
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2	"id": 1,
3  "name": "App Uappi",
4  "email": "mariabatata@email.com.br",
5  "comment": "Gostei do app, nota 10",
6  "recommended": true,
7  "score": 5,
8  "active": false,
9  "masked": false,
10  "createdAt": "2026-01-29 18:09:48",
11  "updatedAt": "2026-01-29 18:09:48",
12  "appId": 1,
13  "userId": 1
14}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

1{
2  "status": false,
3	"data": {
4		"code": 400,
5		"errorCode": "UAPPI_TOOLS_REVIEW_ITEM_EVALUATED",
6		"message": "The requested item was already been evaluated.",
7		"details": []
8  }
9}

Atualização de avaliações de apps

PUT /review/{reviewId}/app/{appId}

Atualiza avaliação do usuário atual sobre um app.

Descrição

Endpoint responsável por buscar e atualizar uma avaliação de aplicativo realizada por um usuário administrador 🧩⚙️.

Trata-se de um endpoint em contexto administrativo, permitindo a consulta e modificação das informações da avaliação.

O acesso é restrito a usuários com perfil admin, sendo que apenas esses podem realizar requisições nesta rota.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
Content-Typeapplication/jsonTipo de conteúdo
AuthorizationBearer {token}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
reviewIdintegerSimID único da entidade de avaliação
appIdintegerSimID único da entidade de app

Parâmetros do Corpo

ParâmetroTipoObrigatórioDescrição
commentstring✅Comentário do cliente (max 65535 caracteres)
recommendedbooleano✅Recomendação do cliente
scoreinteger✅Pontuação da avaliação (entre 1 a 5)

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/review/{reviewId}/app/{appId}
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2	"id": 1,
3		"name": "maria",
4		"email": "mariabatata@email.com.br",
5		"comment": "Gostei do app, nota 10",
6		"recommended": true,
7		"score": 5,
8		"active": false,
9		"masked": false,
10		"createdAt": "2026-01-29 18:09:48",
11		"updatedAt": "2026-01-29 18:09:48",
12		"appId": 1,
13		"userId": 1
14}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_TOOLS_REVIEW_NOT_FOUND",
6    "message": "The requested evaluation was not found."
7  }
8}

Exclusão de avaliação de app

DELETE /review/{review}/app/

Exclui a avaliação de um app realizada por um usuário.

Descrição

Endpoint responsável por excluir uma avaliação de um aplicativo, realizada por um usuário 🗑️🧩.

A exclusão impacta diretamente na nota do aplicativo, pois o cálculo da média é refeito desconsiderando a avaliação removida.

As avaliações de aplicativos não são exibidas para clientes finais, sendo destinadas exclusivamente ao uso interno da plataforma.

Parâmetros de Query

Headers Obrigatórios

HeaderValorDescrição
AuthorizationBearer {token}Token de autenticação

Parâmetros da URL

ParâmetroTipoObrigatórioDescrição
reviewintegerSimID único da avaliação

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/review/{review}/app\
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3	"data": true
4}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_TOOLS_REVIEW_NOT_FOUND",
6    "message": "The requested evaluation was not found."
7  }
8}

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;