Histórico do usuário Logado
/auth/users/history
Endpoint responsável por listar o histórico de ações do próprio usuário autenticado
Descrição
Retorna o histórico de ações registradas para o usuário autenticado na sessão atual. Cada registro representa um evento gerado em contextos como integrações de webhook ou desativações automáticas de integrações.
O histórico armazena os dados do estado antes e depois de cada alteração, permitindo rastrear exatamente o que mudou em cada evento.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação do usuário logado |
Campos de Condição Disponíveis
| Campo | Tipo | Descrição |
|---|---|---|
| origin | string | Filtrar pela origem do histórico. |
| action | string | Filtrar pela ação registrada. |
| createdAt | string | Filtrar pela data de criação do registro |
Campos de Ordenação Disponíveis
| Campo | Descrição |
|---|---|
| id | Ordenar pelo ID do registro de histórico |
| createdAt | Ordenar pela data de criação do registro |
Exemplo de Requisição
1curl --request GET \2 --url https://sua-loja-uappi.com.br/api/v3/auth/users/history \3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \4 --data '{5 "fields": [6 ],7 "order": [8 ],9 "condition": {10 "type": "AND",11 "conditions": [12 ]13 }14 }'✅ Resposta de Sucesso
1{2 "status": true,3 "data": {4 "registers": [5 {6 "id": 1,7 "userId": 42,8 "userName": "Webhook Integrator",9 "userEmail": "y5xb9kav@uappi.store",10 "origin": "webhook",11 "action": "webhook-success-request",12 "before": {},13 "after": {14 "url": "https://minhaplataforma/webhook",15 "request": ["PAYLOAD"],16 "attempts": [17 {18 "attempt": 1,19 "success": false,20 "httpStatus": 400,21 "response": {22 "success": false23 },24 "attemptedAt": "2026-05-28 11:06:19"25 },26 {27 "attempt": 2,28 "success": true,29 "httpStatus": 400,30 "response": {31 "success": true32 },33 "attemptedAt": "2026-05-28 11:06:25"34 }35 ]36 },37 "createdAt": "2025-06-01 10:30:00"38 },39 {40 "id": 2,41 "userId": 42,42 "userName": "Webhook Integrator",43 "userEmail": "y5xb9kav@uappi.store",44 "origin": "integration",45 "action": "integration-disabled",46 "before": {},47 "after": {48 "type": "order",49 "reason": "Integration disabled after 5 failed send attempts."50 },51 "createdAt": "2025-05-28 14:15:00"52 }53 ],54 "pagination": {55 "limit": 10,56 "offset": 0,57 "pages": 1,58 "registers": 259 }60 }61}⚠️ 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_DISABLED_USER | 403 | O usuário autenticado foi desativado pela administração da loja. |
Histórico de um usuário
/auth/users/{userId}/history
Endpoint responsável por listar o histórico de ações de um usuário específico por ID
Descrição
Retorna o histórico de ações registradas para um usuário específico, identificado pelo userId informado na URL.
Este endpoint é destinado ao uso administrativo: o acesso requer que o usuário autenticado possua os escopos USER_READ vinculados ao seu perfil. 🔒
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação com escopos USER_READ e USER_WRITE |
Parâmetros da URL
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| userId | integer | Sim | ID do usuário cujo histórico será listado |
Campos de Condição Disponíveis
| Campo | Tipo | Descrição |
|---|---|---|
| origin | string | Filtrar pela origem do histórico. |
| action | string | Filtrar pela ação registrada. |
| createdAt | string | Filtrar pela data de criação do registro |
Campos de Ordenação Disponíveis
| Campo | Descrição |
|---|---|
| id | Ordenar pelo ID do registro de histórico |
| createdAt | Ordenar pela data de criação do registro |
Exemplo de Requisição
1curl --request GET \2 --url {{MAIN_URL}}/auth/users/42/history \3 --header "Authorization: Bearer SEU_TOKEN_AQUI" \4 --data '{5 "fields": [6 ],7 "order": [8 ],9 "condition": {10 "type": "AND",11 "conditions": [12 ]13 }14 }'✅ Resposta de Sucesso
1{2 "status": true,3 "data": {4 "registers": [5 {6 "id": 1,7 "userId": 42,8 "userName": "Webhook Integrator",9 "userEmail": "y5xb9kav@uappi.store",10 "origin": "webhook",11 "action": "webhook-success-request",12 "before": {},13 "after": {14 "url": "https://minhaplataforma/webhook",15 "request": ["PAYLOAD"],16 "attempts": [17 {18 "attempt": 1,19 "success": false,20 "httpStatus": 400,21 "response": {22 "success": false23 },24 "attemptedAt": "2026-05-28 11:06:19"25 },26 {27 "attempt": 2,28 "success": true,29 "httpStatus": 400,30 "response": {31 "success": true32 },33 "attemptedAt": "2026-05-28 11:06:25"34 }35 ]36 },37 "createdAt": "2025-06-01 10:30:00"38 },39 {40 "id": 2,41 "userId": 42,42 "userName": "Webhook Integrator",43 "userEmail": "y5xb9kav@uappi.store",44 "origin": "integration",45 "action": "integration-disabled",46 "before": {},47 "after": {48 "type": "order",49 "reason": "Integration disabled after 5 failed send attempts."50 },51 "createdAt": "2025-05-28 14:15:00"52 }53 ],54 "pagination": {55 "limit": 10,56 "offset": 0,57 "pages": 1,58 "registers": 259 }60 }61}⚠️ 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_FORBBIDEN_ACCESS | 403 | O usuário não possui os escopos USER_READ necessários para acessar este recurso. |
| UAPPI_AUTH_DISABLED_USER | 403 | O usuário autenticado foi desativado pela administração da loja. |
| UAPPI_AUTH_USER_NOT_FOUND | 404 | O usuário informado no parâmetro userId não foi encontrado. |