Termos de uso Uappi para Usuários
Os termos de uso são um conjunto de regras, condições e diretrizes que definem como um usuário pode utilizar um produto, site, aplicativo ou serviço.
Eles funcionam como um contrato entre a empresa e o usuário, explicando, de forma clara:
- O que o serviço oferece
- Direitos e responsabilidades das partes
- Permissões e proibições de uso
- Tratamento de dados, segurança e limitações do serviço
- Consequências para uso indevido
De forma simples, são as “regras da casa” que garantem que o serviço funcione corretamente e que tanto o usuário quanto a empresa estejam protegidos juridicamente.
Listagem de termos de uso
/auth/users/sign
Endpoint responsável por listar documentos de termos de uso da plataforma.
Descrição
Endpoint responsável por retornar todos os termos de uso da plataforma que devem ser assinados por um usuário administrador.
Parâmetros de Query
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {token} | Token de autenticação |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/auth/users/sign \3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \✅ Resposta de Sucesso
1{2 "status": true,3 "data": [4 {5 "hash": "termos-de-uso-uappi",6 "html": "https://docterms.html",7 "htmlContent": "",8 "pdf": "https:/docterms.pdf",9 "title": "Termos de Uso",10 "subtitle": "Para utilizar a plataforma Uappi é necessário concordar com nossos termos de uso.",11 "acceptanceText": "Concordo",12 "postponementLimit": 3,13 "date": "2000-01-01 08:00:00",14 "sign": true15 }16 ]17}Aceitar e concordar com os termos de uso
/auth/users/sign/{terms}
Este endpoint possibilita que o usuário aceite e concorde com determinado termo de uso da plataforma
Descrição
Endpoint responsável por permitir que um usuário admin aceite e concorde com determinado termo de uso da plataforma.
Parâmetros de query
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {token} | Token de autenticação do usuário |
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| terms | string | Sim | hash do termo de uso a ser aceito |
Exemplo de Requisição
1curl --request POST \2 --url {{ MAIN_URL }}/auth/users/sign/{terms} \3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \✅ Resposta de Sucesso
1{2 "status": true,3 "data": true4}Ler documento de termos de uso mais tarde
/auth/users/sign/{terms}/skip
Este endpoint possibilita que o usuário leia os termos de uso mais tarde, pulando a etapa temporariamente
Descrição
Endpoint responsável por permitir que o usuário ignore temporariamente a etapa de aceitação dos termos de uso.
A cada login, a aceitação dos termos será solicitada novamente. Caso o usuário tente adiar a leitura por mais de 3 vezes, um erro será exibido.
Parâmetros de query
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Authorization | Bearer {token} | Token de autenticação do usuário |
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| terms | string | Sim | hash do termo de uso a ser aceito |
Exemplo de Requisição
1curl --request POST \2 --url {{MAIN_URL}}/auth/users/sign/{terms}/skip \3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \✅ Resposta de Sucesso
1{2 "status": true,3 "data": true4}⚠️ 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.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_AUTH_DOCUMENT_NOT_SKIPPED | 403 | O documento não pode ser mais ignorado. |
| UAPPI_AUTH_DOCUMENT_NOT_FOUND | 404 | O documento solicitado não foi encontrado. |