Nova API V1.0 · Referência
Criar ou atualizar avaliação do app conectado
O token identifica o app e as lojas autorizadas. Cria ou atualiza uma única avaliação por aplicativo e restaurante, retornando 200 nos dois casos. Se ela foi excluída logicamente, restaura o mesmo registro com a nova nota e comentário. Sem restaurant_id, infere a loja se o token autoriza somente uma; com várias lojas, o seletor é obrigatório. A nota e o comentário devem ser escolhidos pelo usuário antes do envio. O autor é o usuário do consentimento ou o dono registrado da rede, com acesso ativo verificado. Conexões sem esse usuário precisam passar novamente pelo consentimento. App e instalação são verificados e bloqueados na transação de gravação. Não exige escopo adicional e não aceita IDs de autor ou app no corpo.
O token identifica o app e as lojas autorizadas. Cria ou atualiza uma única avaliação por aplicativo e restaurante, retornando 200 nos dois casos. Se ela foi excluída logicamente, restaura o mesmo registro com a nova nota e comentário. Sem restaurant_id, infere a loja se o token autoriza somente uma; com várias lojas, o seletor é obrigatório. A nota e o comentário devem ser escolhidos pelo usuário antes do envio. O autor é o usuário do consentimento ou o dono registrado da rede, com acesso ativo verificado. Conexões sem esse usuário precisam passar novamente pelo consentimento. App e instalação são verificados e bloqueados na transação de gravação. Não exige escopo adicional e não aceita IDs de autor ou app no corpo.
Authorization
storeOAuth Access token de instalação OAuth Authorization Code + PKCE de app com perfil Restaurante. O client_id identifica o próprio app. Exige consentimento ativo, não expirado e app visível; não exige escopo adicional. API keys, client credentials, sessões humanas, MCP e autorizações de garçom não são aceitos.
In: header
Query Parameters
Loja autorizada nesta conexão. Em GET, filtra avaliações e resumo; omitir lista todas as avaliações do app. Em POST/DELETE, seleciona a loja autora; obrigatório quando o token autoriza várias. Vínculos atuais e consentimento limitam a seleção. Uma loja não autorizada retorna 403.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
Consultar avaliações do app conectado GET
O client_id do token e sua instalação identificam o app; não aceita ID de outro aplicativo. Exige OAuth PKCE de restaurante com instalação ativa, não expirada e app visível. Não exige escopo adicional. Sem restaurant_id, lista todas as avaliações do app. Com o filtro, lista e resumo incluem somente uma loja autorizada na conexão e nos vínculos atuais da rede. Retorna 10 avaliações por página, da mais recente para a mais antiga. IDs de contas e e-mails não são publicados. Avaliações excluídas logicamente não aparecem em data, ownReview, totais ou médias.
Excluir avaliação do próprio restaurante DELETE
Exige uma conexão OAuth de restaurante ativa. O client_id do token identifica o app e o restaurante selecionado deve ser autorizado na conexão e nos vínculos atuais da rede. Só exclui uma avaliação de autoria desse restaurante nesse aplicativo; o usuário individual que escreveu a avaliação não precisa ser o mesmo responsável atual. Registra deleted_at e updated_at, preservando a linha e seu conteúdo. A avaliação deixa de aparecer nas consultas, totais, médias e ownReview da API e da Store. Um novo POST restaura o mesmo registro. Avaliações inexistentes, já excluídas ou de outro app/restaurante retornam o mesmo 404. Não exige escopo adicional.