Documentação da API de Cerimônias, Endereços e Salas

Autenticação

Todos os endpoints são protegidos por autenticação usando o middleware auth:sanctum. Certifique-se de enviar um cabeçalho de autorização contendo um token Bearer válido:

Authorization: Bearer {token}

Os endpoints de cerimônias são prefixados com /v1/cerimonias, os de endereços com /v1/enderecos e os de salas com /v1/salas.

Endpoints de Cerimônias

1. Listar Cerimônias

Rota: https://app.sistemamemoriam.com/api/v1/cerimonias/listar

Descrição: Retorna uma lista paginada de cerimônias de acordo com o status.

Status: A requisição deve conter os status: ativas ou inativas.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/cerimonias/listar?status=ativas
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "data": {
      "current_page": 1,
      "data": [
        {
          "nome": "João da Silva",
          "data_nascimento": "1980-05-20",
          "data_falecimento": "2023-06-15",
          "inicio_cerimonia": "2023-06-20 10:00",
          "final_cerimonia": "2023-06-20 12:00",
          "endereco_cerimonia_id": 12,
          "endereco_sepultamento_id": 33,
          "sala_id": 2,
          "local_cerimonia": "Sala 2"
        }
      ],
      "per_page": 10,
      "total": 50
    }
}

Erros Possíveis:

500 Internal Server Error: Erro interno do servidor ao listar cerimônias.

2. Cadastrar Cerimônia

Rota: https://app.sistemamemoriam.com/api/v1/cerimonias/cadastrar

Descrição: Cria uma nova cerimônia com status 'inativa'.

Exemplo de Requisição:

POST https://app.sistemamemoriam.com/api/v1/cerimonias/cadastrar
Authorization: Bearer {token}
Content-Type: application/json

{
  "nome": "Maria da Silva",
  "data_nascimento": "1940-03-10",
  "data_falecimento": "2023-07-01",
  "inicio_cerimonia": "2023-07-05 09:00:00",
  "final_cerimonia": "2023-07-05 11:00:00",
  "endereco_cerimonia_id": 1,
  "endereco_sepultamento_id": 2,
  "sala_id": 3,
  "local_cerimonia": "Capela A"
  "id_origem":  123
}

Resposta de Sucesso:

{
    "success": true,
    "message": "Cerimônia criada com sucesso!",
    "data": {
      "id": 1,
      "nome": "Maria da Silva",
      "status": "0"
    }
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
500 Internal Server Error: Erro interno do servidor ao criar cerimônia.

3. Exibir Cerimônia Específica

Rota: https://app.sistemamemoriam.com/api/v1/cerimonias/exibir/{id}

Descrição: Retorna os detalhes de uma cerimônia específica.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/cerimonias/exibir/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "data": {
      "nome": "Maria da Silva",
      "data_nascimento": "1940-03-10",
      "data_falecimento": "2023-07-01",
      "inicio_cerimonia": "2023-07-05 09:00",
      "final_cerimonia": "2023-07-05 11:00",
      "local_cerimonia": "Capela A"
      "id_origem": '123'
    }
}

Erros Possíveis:

404 Not Found: Cerimônia não encontrada.
500 Internal Server Error: Erro interno do servidor ao exibir cerimônia.

3. Exibir Cerimônia Específica pelo id de origem

Rota: https://app.sistemamemoriam.com/api/v1/cerimonias/exibirpororigem/{id}

Descrição: Retorna os detalhes de uma cerimônia específica.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/cerimonias/exibirpororigem/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "data": {
      "nome": "Maria da Silva",
      "data_nascimento": "1940-03-10",
      "data_falecimento": "2023-07-01",
      "inicio_cerimonia": "2023-07-05 09:00",
      "final_cerimonia": "2023-07-05 11:00",
      "local_cerimonia": "Capela A"
      "id_origem": '123'
    }
}

Erros Possíveis:

404 Not Found: Cerimônia não encontrada.
500 Internal Server Error: Erro interno do servidor ao exibir cerimônia.

4. Atualizar Cerimônia Específica

Rota: https://app.sistemamemoriam.com/api/v1/cerimonias/editar/{id}

Descrição: Atualiza os detalhes de uma cerimônia específica.

Exemplo de Requisição:

PUT https://app.sistemamemoriam.com/api/v1/cerimonias/editar/1
Authorization: Bearer {token}
Content-Type: application/json

{
  "local_cerimonia": "Capela B"
}

Resposta de Sucesso:

{
    "success": true,
    "message": "Cerimônia atualizada com sucesso!",
    "data": {
      "nome": "Maria da Silva",
      "local_cerimonia": "Capela B"
    }
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
404 Not Found: Cerimônia não encontrada.
500 Internal Server Error: Erro interno do servidor ao atualizar cerimônia.

4. Atualizar Cerimônia Específica pelo id de origem

Rota: https://app.sistemamemoriam.com/api/v1/cerimonias/editarpororigem/{id}

Descrição: Atualiza os detalhes de uma cerimônia específica.

Exemplo de Requisição:

PUT https://app.sistemamemoriam.com/api/v1/cerimonias/editarpororigem/1
Authorization: Bearer {token}
Content-Type: application/json

{
  "local_cerimonia": "Capela B"
}

Resposta de Sucesso:

{
    "success": true,
    "message": "Cerimônia atualizada com sucesso!",
    "data": {
      "nome": "Maria da Silva",
      "local_cerimonia": "Capela B"
    }
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
404 Not Found: Cerimônia não encontrada.
500 Internal Server Error: Erro interno do servidor ao atualizar cerimônia.

5. Deletar Cerimônia Específica

Rota: https://app.sistemamemoriam.com/api/v1/cerimonias/deletar/{id}

Descrição: Deleta uma cerimônia específica.

Exemplo de Requisição:

DELETE https://app.sistemamemoriam.com/api/v1/cerimonias/deletar/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "message": "Cerimônia deletada com sucesso!"
}

Erros Possíveis:

404 Not Found: Cerimônia não encontrada.
500 Internal Server Error: Erro interno do servidor ao deletar cerimônia.

Endpoints de Endereços

1. Listar Endereços

Rota: https://app.sistemamemoriam.com/api/v1/enderecos/listar

Descrição: Retorna uma lista de todos os endereços cadastrados.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/enderecos/listar
Authorization: Bearer {token}

Resposta de Sucesso:

[
    {
        "id": 1,
        "nome": "Capela A",
        "cep": "12345-678",
        "uf": "SP",
        "cidade": "São Paulo",
        "bairro": "Centro",
        "rua": "Rua das Flores",
        "numero": "123",
        "tipo": "capela"
    },
    {
        "id": 2,
        "nome": "Cemitério Municipal",
        "cep": "23456-789",
        "uf": "RJ",
        "cidade": "Rio de Janeiro",
        "bairro": "Botafogo",
        "rua": "Rua da Paz",
        "numero": "456",
        "tipo": "cemiterio"
    }
]

Erros Possíveis:

500 Internal Server Error: Erro interno do servidor ao listar endereços.

2. Cadastrar Endereço

Rota: https://app.sistemamemoriam.com/api/v1/enderecos/cadastrar

Descrição: Cria um novo endereço.

Exemplo de Requisição:

POST https://app.sistemamemoriam.com/api/v1/enderecos/cadastrar
Authorization: Bearer {token}
Content-Type: application/json

{
    "nome": "Capela B",
    "cep": "34567-890",
    "uf": "MG",
    "cidade": "Belo Horizonte",
    "bairro": "Savassi",
    "rua": "Rua do Sol",
    "numero": "789",
    "tipo": "capela"
}

Resposta de Sucesso:

{
    "id": 3,
    "nome": "Capela B",
    "cep": "34567-890",
    "uf": "MG",
    "cidade": "Belo Horizonte",
    "bairro": "Savassi",
    "rua": "Rua do Sol",
    "numero": "789",
    "tipo": "capela"
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
500 Internal Server Error: Erro interno do servidor ao cadastrar endereço.

3. Exibir Endereço Específico

Rota: https://app.sistemamemoriam.com/api/v1/enderecos/exibir/{id}

Descrição: Retorna os detalhes de um endereço específico.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/enderecos/exibir/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "id": 1,
    "nome": "Capela A",
    "cep": "12345-678",
    "uf": "SP",
    "cidade": "São Paulo",
    "bairro": "Centro",
    "rua": "Rua das Flores",
    "numero": "123",
    "tipo": "capela"
}

Erros Possíveis:

404 Not Found: Endereço não encontrado.
500 Internal Server Error: Erro interno do servidor ao exibir endereço.

4. Atualizar Endereço Específico

Rota: https://app.sistemamemoriam.com/api/v1/enderecos/editar/{id}

Descrição: Atualiza os detalhes de um endereço específico.

Exemplo de Requisição:

PUT https://app.sistemamemoriam.com/api/v1/enderecos/editar/1
Authorization: Bearer {token}
Content-Type: application/json

{
    "nome": "Capela C",
    "cep": "45678-123",
    "uf": "SP",
    "cidade": "São Paulo",
    "bairro": "Centro",
    "bairro": "Centro",
    "rua": "Rua das Acácias",
    "numero": "321",
    "tipo": "capela"
}

Resposta de Sucesso:

{
    "id": 1,
    "nome": "Capela C",
    "cep": "45678-123",
    "uf": "SP",
    "cidade": "São Paulo",
    "bairro": "Centro",
    "rua": "Rua das Acácias",
    "numero": "321",
    "tipo": "capela"
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
404 Not Found: Endereço não encontrado.
500 Internal Server Error: Erro interno do servidor ao atualizar endereço.

5. Deletar Endereço Específico

Rota: https://app.sistemamemoriam.com/api/v1/enderecos/deletar/{id}

Descrição: Deleta um endereço específico.

Exemplo de Requisição:

DELETE https://app.sistemamemoriam.com/api/v1/enderecos/deletar/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "message": "Endereço deletado com sucesso"
}

Erros Possíveis:

404 Not Found: Endereço não encontrado.
500 Internal Server Error: Erro interno do servidor ao deletar endereço.

Endpoints de Salas

1. Listar Salas

Rota: https://app.sistemamemoriam.com/api/v1/salas/listar

Descrição: Retorna uma lista de todas as salas cadastradas.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/salas/listar
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "data": [
        {
            "id": 1,
            "nome": "Sala A",
            "endereco_id": 1
        },
        {
            "id": 2,
            "nome": "Sala B",
            "endereco_id": 2
        }
    ]
}

2. Cadastrar Sala

Rota: https://app.sistemamemoriam.com/api/v1/salas/cadastrar

Descrição: Cria uma nova sala.

Exemplo de Requisição:

POST https://app.sistemamemoriam.com/api/v1/salas/cadastrar
Authorization: Bearer {token}
Content-Type: application/json

{
    "nome": "Sala C",
    "id_origem": "123",
    "endereco_id": 1
}

Resposta de Sucesso:

{
    "success": true,
    "message": "Sala cadastrada com sucesso",
    "data": {
        "id": 3,
        "nome": "Sala C",
        "id_origem": "123",
        "endereco_id": 1
    }
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
500 Internal Server Error: Erro interno do servidor ao cadastrar sala.

3. Exibir Sala Específica

Rota: https://app.sistemamemoriam.com/api/v1/salas/exibir/{id}

Descrição: Retorna os detalhes de uma sala específica.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/salas/exibir/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "data": {
        "nome": "Sala A",
        "endereco_id": 1
    }
}

Erros Possíveis:

404 Not Found: Sala não encontrada.
500 Internal Server Error: Erro interno do servidor ao exibir sala.

3. Exibir Sala Específica pelo id de origem

Rota: https://app.sistemamemoriam.com/api/v1/salas/exibirpororigem/{id}

Descrição: Retorna os detalhes de uma sala específica.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/salas/exibirpororigem/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "data": {
        "nome": "Sala A",
        "endereco_id": 1
    }
}

Erros Possíveis:

404 Not Found: Sala não encontrada.
500 Internal Server Error: Erro interno do servidor ao exibir sala.

4. Atualizar Sala Específica

Rota: https://app.sistemamemoriam.com/api/v1/salas/editar/{id}

Descrição: Atualiza os detalhes de uma sala específica.

Exemplo de Requisição:

PUT https://app.sistemamemoriam.com/api/v1/salas/editar/1
Authorization: Bearer {token}
Content-Type: application/json

{
    "nome": "Sala D",
    "endereco_id": 2
}

Resposta de Sucesso:

{
    "success": true,
    "message": "Sala atualizada com sucesso",
    "data": {
        "id": 1,
        "nome": "Sala D",
        "endereco_id": 2
    }
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
404 Not Found: Sala não encontrada.
500 Internal Server Error: Erro interno do servidor ao atualizar sala.

4. Atualizar Sala Específica

Rota: https://app.sistemamemoriam.com/api/v1/salas/editarpororigem/{id}

Descrição: Atualiza os detalhes de uma sala específica.

Exemplo de Requisição:

PUT https://app.sistemamemoriam.com/api/v1/salas/editarpororigem/1
Authorization: Bearer {token}
Content-Type: application/json

{
    "nome": "Sala D",
    "endereco_id": 2
}

Resposta de Sucesso:

{
    "success": true,
    "message": "Sala atualizada com sucesso",
    "data": {
        "id": 1,
        "nome": "Sala D",
        "endereco_id": 2
    }
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos.
404 Not Found: Sala não encontrada.
500 Internal Server Error: Erro interno do servidor ao atualizar sala.

5. Deletar Sala Específica

Rota: https://app.sistemamemoriam.com/api/v1/salas/deletar/{id}

Descrição: Deleta uma sala específica.

Exemplo de Requisição:

DELETE https://app.sistemamemoriam.com/api/v1/salas/deletar/1
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "message": "Sala deletada com sucesso"
}

Erros Possíveis:

404 Not Found: Sala não encontrada.
500 Internal Server Error: Erro interno do servidor ao deletar sala.

Endpoints de Leads

1. Listar leads

Rota: https://app.sistemamemoriam.com/api/v1/leads/listar

Descrição: Retorna uma lista de todos os leads cadastrados que atendem aos filtros fornecidos.

Parâmetros:

de_data (opcional): Data inicial no formato YYYY-MM-DD.
ate_data (opcional): Data final no formato YYYY-MM-DD.

Exemplo de Requisição:

GET https://app.sistemamemoriam.com/api/v1/leads/listar?de_data=2024-01-01&ate_data=2024-12-31
Authorization: Bearer {token}

Resposta de Sucesso:

{
    "success": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "nome": "Dionatan Martins",
                "telefone": "5555555555",
                "cidade": "Chapecó",
                "email": "email@hotmail.com",
                "cadastrado_em": "2024-10-23T17:50:15.000000Z",
                "aceite": true
            },
            {
                "id": 2,
                "nome": "Dionatan",
                "telefone": "5555555555",
                "cidade": "Chapecó",
                "email": "email@hotmail.com",
                "cadastrado_em": "2024-10-23T17:50:15.000000Z",
                "aceite": true
            }
        ],
        "first_page_url": "https://app.sistemamemoriam.com/api/v1/leads/listar?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://app.sistemamemoriam.com/api/v1/leads/listar?page=1",
        "links": [
            {
                "url": null,
                "label": "« Anterior",
                "active": false
            },
            {
                "url": "https://app.sistemamemoriam.com/api/v1/leads/listar?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Próximo »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://app.sistemamemoriam.com/api/v1/leads/listar",
        "per_page": 100,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    }
}

Erros Possíveis:

400 Bad Request: Parâmetros inválidos (exemplo: datas em formato incorreto).
404 Not Found: Endereço não encontrado.
500 Internal Server Error: Erro interno do servidor.