{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/apione.homologa.grupofaveni.com" } ], "info": { "name": "one-api API Documentation", "_postman_id": "7453004d-3b1a-4634-9edd-5f8897cafc89", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Auth", "description": "", "item": [ { "name": "Gera o link de autentica\u00e7\u00e3o do Google (via Socialite) para iniciar o fluxo de login.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/google\/link", "query": [ { "key": "redirect_to", "value": "http%3A%2F%2Fwww.bailey.biz%2Fquos-velit-et-fugiat-sunt-nihil-accusantium-harum.html", "description": "O URL completo de redirecionamento ap\u00f3s o login bem-sucedido. Must be a valid URL.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/auth\/google\/link?redirect_to=http%3A%2F%2Fwww.bailey.biz%2Fquos-velit-et-fugiat-sunt-nihil-accusantium-harum.html" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"redirect_to\":\"architecto\"}" }, "description": "Este endpoint recebe o URL de redirecionamento p\u00f3s-login e retorna o link\ndo Google para o qual o frontend deve direcionar o usu\u00e1rio. O par\u00e2metro\n'redirect_to' \u00e9 usado como 'state' no OAuth para manter a seguran\u00e7a e\no contexto da aplica\u00e7\u00e3o.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n\"url\": \"string\"\n}", "name": "" } ] }, { "name": "Callback de Autentica\u00e7\u00e3o via Google Socialite.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/google\/callback", "query": [ { "key": "state", "value": "meu-front.com", "description": "A URL de destino para onde o usu\u00e1rio deve ser redirecionado ap\u00f3s o login.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/auth\/google\/callback?state=meu-front.com" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Este endpoint processa o retorno do Google ap\u00f3s a autoriza\u00e7\u00e3o do usu\u00e1rio.\nEle localiza ou cria o usu\u00e1rio na base de dados, gera um Personal Access Token (Sanctum)\ne redireciona o usu\u00e1rio de volta para o endere\u00e7o fornecido no par\u00e2metro 'state' da query string.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 500, "body": "{\n \"message\": \"Server Error\"\n}", "name": "" } ] }, { "name": "POST api\/v1\/auth\/logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/auth\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/auth\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Department", "description": "", "item": [ { "name": "Listar todos os departamentos.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/departments", "query": [], "raw": "{{baseUrl}}\/api\/v1\/departments" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retorna uma cole\u00e7\u00e3o simples contendo o ID e o nome de todos\nos departamentos cadastrados, ordenados alfabeticamente.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[\n {\"id\": 1, \"name\": \"Financeiro\"},\n {\"id\": 2, \"name\": \"Tecnologia\"}\n]", "name": "" } ] } ] }, { "name": "Disciplinas", "description": "\nEndpoints para consulta e gerenciamento de disciplinas via integra\u00e7\u00e3o ONE.", "item": [ { "name": "GET api\/v1\/disciplines", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/disciplines", "query": [ { "key": "name", "value": "Anatomia", "description": "Filtra pelo nome parcial da disciplina. validation.max.", "disabled": false }, { "key": "page", "value": "1", "description": "N\u00famero da p\u00e1gina para navega\u00e7\u00e3o. validation.min.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Itens por p\u00e1gina (M\u00e1x: 100). validation.min validation.max.", "disabled": false }, { "key": "order", "value": "asc", "description": "Ordena\u00e7\u00e3o.", "disabled": false }, { "key": "sort_by", "value": "name", "description": "Coluna para ordena\u00e7\u00e3o.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/disciplines?name=Anatomia&page=1&per_page=15&order=asc&sort_by=name" }, "method": "GET", "header": [ { "key": "X-Domain", "value": "faveni Identificador do Tenant\/Dom\u00ednio (Obrigat\u00f3rio para definir o contexto da requisi\u00e7\u00e3o)." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/disciplines\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/disciplines\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/disciplines\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the discipline." } ] }, "method": "GET", "header": [ { "key": "X-Domain", "value": "faveni Identificador do Tenant\/Dom\u00ednio (Obrigat\u00f3rio para definir o contexto da requisi\u00e7\u00e3o)." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/disciplines\/{id}\/curriculum", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/disciplines\/:id\/curriculum", "query": [ { "key": "name", "value": "Enfermagem+01%2F2026", "description": "Filtro textual pelo nome da matriz curricular (busca parcial).", "disabled": false }, { "key": "order", "value": "asc", "description": "Dire\u00e7\u00e3o da ordena\u00e7\u00e3o: \"asc\" (crescente) ou \"desc\" (decrescente).", "disabled": false }, { "key": "sort_by", "value": "term", "description": "Coluna utilizada para ordena\u00e7\u00e3o. Aceita campos da matriz (name, source) ou do v\u00ednculo (term).", "disabled": false }, { "key": "page", "value": "1", "description": "N\u00famero da p\u00e1gina atual para navega\u00e7\u00e3o.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Quantidade de itens retornados por p\u00e1gina (M\u00e1x: 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/disciplines\/:id\/curriculum?name=Enfermagem+01%2F2026&order=asc&sort_by=term&page=1&per_page=15", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the discipline." } ] }, "method": "GET", "header": [ { "key": "X-Domain", "value": "faveni Identificador do Tenant\/Dom\u00ednio (Obrigat\u00f3rio para definir o contexto da requisi\u00e7\u00e3o)." }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Domain", "description": "", "item": [ { "name": "GET api\/v1\/domains", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/domains", "query": [], "raw": "{{baseUrl}}\/api\/v1\/domains" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Role", "description": "", "item": [ { "name": "Listar todos as roles.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retorna uma cole\u00e7\u00e3o simples contendo o ID e o nome de todos\nas roles (Cargos) cadastrados, ordenados alfabeticamente.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "[\n {\"id\": 1, \"name\": \"Admin\"},\n {\"id\": 2, \"name\": \"Diretor\"}\n]", "name": "" } ] } ] }, { "name": "User", "description": "", "item": [ { "name": "Obter perfil do usu\u00e1rio autenticado.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me" }, "method": "GET", "header": [ { "key": "Authorization", "value": "string required Exemplo: \"Bearer {token}\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Este endpoint retorna os detalhes do usu\u00e1rio logado, incluindo o cargo (role) \u00fanico\ne o nome do departamento vinculado ao seu registro de funcion\u00e1rio." }, "response": [ { "header": [], "code": 200, "body": "{\n \"uuid\": \"9b12e345-e89b-12d3-a456-426614174000\",\n \"name\": \"Jo\u00e3o Silva\",\n \"email\": \"joao.silva@empresa.com.br\",\n \"avatar_url\": \"lh3.googleusercontent.com...\",\n \"role\": {\n \"id\": 2,\n \"name\": \"gerente\"\n },\n \"department\": {\n \"id\": 2,\n \"name\": \"Marketing\"\n },\n \"status\": \"active\",\n \"created_at\": \"2025-12-19T16:10:00Z\",\n \"updated_at\": \"2025-12-19T16:10:00Z\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" } ] }, { "name": "Atualizar perfil do usu\u00e1rio autenticado.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/me", "query": [], "raw": "{{baseUrl}}\/api\/v1\/me" }, "method": "PUT", "header": [ { "key": "Authorization", "value": "string required Exemplo: \"Bearer {token}\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Jo\u00e3o Silva\",\"role_id\":1,\"department_id\":2,\"email\":\"joao.silva@empresa.com\"}" }, "description": "Este endpoint permite que o usu\u00e1rio logado atualize suas informa\u00e7\u00f5es pessoais.\nA opera\u00e7\u00e3o \u00e9 realizada de forma at\u00f4mica (transa\u00e7\u00e3o)." }, "response": [ { "header": [], "code": 200, "body": "{\n \"uuid\": \"9b12e345-e89b-12d3-a456-426614174000\",\n \"name\": \"Jo\u00e3o Silva\",\n \"email\": \"joao.silva@empresa.com\",\n \"avatar_url\": \"lh3.googleusercontent.com...\",\n \"role_id\": 1,\n \"department\": \"Tecnologia\",\n \"status\": \"active\",\n \"created_at\": \"2025-12-19T16:15:00Z\",\n \"updated_at\": \"2025-12-19T16:20:00Z\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"department_id\": [\"O departamento selecionado \u00e9 inv\u00e1lido.\"],\n \"role\": [\"O cargo selecionado \u00e9 inv\u00e1lido.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Erro interno ao atualizar perfil.\"\n}", "name": "" } ] }, { "name": "Lista usu\u00e1rios paginados.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [ { "key": "status", "value": "approved", "description": "optional Filtra por status.", "disabled": false }, { "key": "order_by", "value": "name", "description": "optional Campo para ordena\u00e7\u00e3o.", "disabled": false }, { "key": "direction", "value": "asc", "description": "optional Dire\u00e7\u00e3o da ordena\u00e7\u00e3o.", "disabled": false }, { "key": "page", "value": "1", "description": "optional P\u00e1gina atual.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional Itens por p\u00e1gina.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/users?status=approved&order_by=name&direction=asc&page=1&limit=10" }, "method": "GET", "header": [ { "key": "Authorization", "value": "string required" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Rota: GET \/v1\/users\nDescri\u00e7\u00e3o: Lista usu\u00e1rios paginados com filtros (status) e ordena mediante ao nome da coluna." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n { \"uuid\":\"...\", \"name\":\"...\", \"email\":\"...\", \"role\":\"admin\", \"department\":\"Tecnologia\", \"status\":\"active\" }\n ],string\n \"meta\": { \"current_page\":1, \"last_page\":10, \"per_page\":15, \"total\":150 }\n}", "name": "" } ] }, { "name": "Obter perfil de determinado usu\u00e1rio.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_uuid", "variable": [ { "id": "user_uuid", "key": "user_uuid", "value": "2", "description": "" } ] }, "method": "GET", "header": [ { "key": "Authorization", "value": "string required Exemplo: \"Bearer {token}\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Este endpoint permite que o adminstrador consiga as informa\u00e7\u00f5es de um determinado usu\u00e1rio" }, "response": [ { "header": [], "code": 200, "body": "{\n\"uuid\": \"d8933aba-2cb7-44d2-925b-7337226b4934\",\n\"name\": \"Juliana Paes\",\n\"email\": \"juliana.paes@empresa.com\",\n\"avatar_url\": null,\n\"role\": {\n \"id\": 2,\n \"name\": \"gerente\"\n},\n\"department\": {\n \"id\": 2,\n \"name\": \"Marketing\"\n},\n\"status\": \"pending\",\n\"is_active\": false,\n\"email_verified_at\": \"2025-12-31T08:43:10.000000Z\",\n\"created_at\": \"2025-12-31T08:43:10.000000Z\",\n\"updated_at\": \"2025-12-31T08:43:10.000000Z\"\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"message\": \"Unauthenticated.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"message\": \"Usu\u00e1rio n\u00e3o encontrado.\"\n}", "name": "" } ] }, { "name": "Atualizar perfil de determinado usu\u00e1rio.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_uuid", "variable": [ { "id": "user_uuid", "key": "user_uuid", "value": "2", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Authorization", "value": "string required Exemplo: \"Bearer {token}\"" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Jo\u00e3o Silva\",\"role_id\":1,\"department_id\":2,\"is_active\":true,\"email\":\"joao.silva@empresa.com\"}" }, "description": "Este endpoint permite que o adminstrador atualize as informa\u00e7\u00f5es de um usu\u00e1rio." }, "response": [ { "header": [], "code": 200, "body": "{\n'message': 'Usu\u00e1rio atualizado com sucesso.',\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"message\": \"The given data was invalid.\",\n \"errors\": {\n \"department_id\": [\"O departamento selecionado \u00e9 inv\u00e1lido.\"],\n \"role\": [\"O cargo selecionado \u00e9 inv\u00e1lido.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"message\": \"Erro interno ao atualizar usu\u00e1rio.\"\n}", "name": "" } ] }, { "name": "Modera\u00e7\u00e3o de usu\u00e1rio (aprovar\/rejeitar).", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_uuid\/moderation", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_uuid\/moderation", "variable": [ { "id": "user_uuid", "key": "user_uuid", "value": "2", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Authorization", "value": "string required" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"architecto\"}" }, "description": "Este endpoit permite que um administrador aprove ou rejeite um usu\u00e1rio pendente.\ncaso aprovado o campo 'approved_by' ser\u00e1 preenchido com o id do administrador que realizou a a\u00e7\u00e3o.\ncaso rejeitado o usu\u00e1rio ser\u00e1 exclu\u00eddo." }, "response": [ { "header": [], "code": 200, "body": "{\n'message' => 'Modera\u00e7\u00e3o realizada com sucesso.',\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"message\": \"Este usu\u00e1rio j\u00e1 foi processado e n\u00e3o est\u00e1 mais pendente.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n'message' => 'Erro interno ao processar a modera\u00e7\u00e3o do usu\u00e1rio.',\n'error' => 'Detalhes do erro',\n}", "name": "" } ] } ] } ], "auth": { "type": "noauth" } }