US06 - Criar endpoints para Parameters

[femelloffm]

Contrato REST API - Parâmetros do sistema

Visão Geral

API RESTful para gerenciamento de parâmetros do sistema como perguntas do FAQ e dados de contato com suporte.

Base URL: https://api.pointtils.com/v1

---

1. Parameters Controller

POST /parameters

Criar novo parâmetro do sistema.

Request Headers:

Authorization: Bearer {access_token}

Request Body:

{
  "key": "email_suporte",
  "value": "point.tils.suporte@gmail.com"
}

Responses:

• 201 Created - Parâmetro criado com sucesso

  {
    "success": true,
    "message": "Parâmetro criado com sucesso",
    "data": {
        "id": "2f2ea567-4bd2-4537-b40a-2b6f5f5f705f",
        "key": "email_suporte",
        "value": "point.tils.suporte@gmail.com"
    }
  }

• 400 Bad Request - Dados inválidos
• 401 Unauthorized - Não autenticado
• 403 Forbidden - Sem permissão
• 409 Conflict - Já existe um parâmetro para esta chave no sistema

GET /parameters/{key}

Obter o valor de um parâmetro a partir da chave.

Request Headers:

Authorization: Bearer {access_token}

Path Parameters:

• key - chave do parâmetro

Responses:

• 200 OK - Dados do parâmetro retornada

  {
    "success": true,
    "message": "Parâmetro encontrado com sucesso",
    "data": {
        "id": "2f2ea567-4bd2-4537-b40a-2b6f5f5f705f",
        "key": "email_suporte",
        "value": "point.tils.suporte@gmail.com"
    }
  }

• 401 Unauthorized - Não autenticado
• 403 Forbidden - Sem permissão
• 404 Not Found - Parâmetro não encontrado

PUT /parameters/{id}

Atualizar dados de um parâmetro.

Request Headers:

Authorization: Bearer {access_token}

Path Parameters:

• id - id do parâmetro

Request Body:

{
    "key": "email_suporte",
    "value": "point.tils.suporte2@gmail.com"
}

Responses:

• 200 OK - Parâmetro atualizado com sucesso

  {
    "success": true,
    "message": "Parâmetro atualizado com sucesso",
    "data": {
        "id": "2f2ea567-4bd2-4537-b40a-2b6f5f5f705f",
        "key": "email_suporte",
        "value": "point.tils.suporte2@gmail.com"
    }
  }

• 400 Bad Request - Dados inválidos
• 401 Unauthorized - Não autenticado
• 403 Forbidden - Sem permissão
• 404 Not Found - Parâmetro não encontrado
• 409 Conflict - Já existe um parâmetro para esta chave no sistema

DELETE /parameters/{id}

Excluir parâmetro.

Request Headers:

Authorization: Bearer {access_token}

Path Parameters:

• id - id do parâmetro

Responses:

• 204 No Content - Parâmetro excluído com sucesso
• 401 Unauthorized - Não autenticado
• 403 Forbidden - Sem permissão
• 404 Not Found - Parâmetro não encontrado

Códigos de Status Utilizados

Status	Descrição	Uso
200	OK	Operação bem-sucedida
201	Created	Parâmetro criado com sucesso
204	No Content	Horário excluído com sucesso
400	Bad Request	Dados inválidos
401	Unauthorized	Não autenticado
403	Forbidden	Sem permissão ou restrição
404	Not Found	Recurso não encontrado
409	Conflict	Conflito com parâmetros existentes
500	Internal Server Error	Erro interno do servidor

---

Estrutura do Banco de Dados

Tabela parameters

• id: Identificador único
• key: Chave do parâmetro
• value: Valor do parâmetro

---

Headers de Segurança

X-Frame-Options: DENY
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Strict-Transport-Security: max-age=31536000; includeSubDomains