Documentação API REST

Documentação completa dos endpoints disponíveis na API do FarmaDepósito

URL Base da API: https://apifarma.roboticasuassuna.com.br/
POST /farma/login POST
https://apifarma.roboticasuassuna.com.br/farma/login

Parâmetros (Body)

  • email
    Email do usuário
  • senha
    Senha do usuário

Respostas Possíveis

  • Status 1 Login realizado com sucesso
  • Status 0 Usuário ou senha inválidos
  • Status 2 Erro interno do servidor

Exemplo de Resposta

{ "status": 1, "msg": "Login realizado com sucesso" }

Testar Endpoint

Resposta da API

POST /farma/recuperarSenha POST
https://apifarma.roboticasuassuna.com.br/farma/recuperarSenha

Parâmetros (Body)

  • codigo
    Código de recuperação
  • email
    Email do usuário

Descrição

Este endpoint gera uma URL encriptada e a envia para o email fornecido. Quando o usuário acessa a URL, o sistema valida as informações e solicita a criação de uma nova senha.

POST /farma/salvarCuidador POST
https://apifarma.roboticasuassuna.com.br/farma/salvarCuidador
Nota: Este endpoint é para primeiro acesso. O parâmetro "operacao" tem valor padrão 1, representando acesso permitido.

Parâmetros (Body)

  • codigo
    Código do cuidador
  • nome
    Nome completo do cuidador
  • email
    Email do cuidador
  • fone
    Telefone do cuidador
  • senha
    Senha do cuidador
  • operacao
    Valor padrão: 1 (acesso permitido)
POST /medicamento/salvarMedicamento POST
https://apifarma.roboticasuassuna.com.br/medicamento/salvarMedicamento
Nota: Este endpoint usa file_get_contents para receber os dados. O parâmetro fotoBlob deve conter a imagem em formato blob/base64.

Parâmetros (Body)

  • nome
    Nome do medicamento
  • nome_quimico
    Nome químico do medicamento
  • classificacao
    Classificação do medicamento
  • descricao
    Descrição do medicamento
  • contra_indicacao
    Contraindicações
  • efeito_colateral
    Efeitos colaterais
  • fotoBlob
    Imagem do medicamento em formato blob
  • operacao
    Operação a ser realizada
GET /medicamento/listarAllMedicamentos GET
https://apifarma.roboticasuassuna.com.br/medicamento/listarAllMedicamentos

Descrição

Lista todos os medicamentos existentes, exceto a foto. Retorna um array de objetos com os dados de cada medicamento.

Exemplo de Resposta

{ "status": 1, "msg": "Sucesso", "data": [ { "id": 1, "nome": "Paracetamol", "nome_quimico": "Acetaminofen", "classificacao": "Analgésico", "descricao": "Medicamento para dor e febre", "contra_indicacao": "Hipersensibilidade", "efeito_colateral": "Pode causar danos hepáticos" } ] }
GET /medicamento/getFotoMedicamentoId/{id} GET
https://apifarma.roboticasuassuna.com.br/medicamento/getFotoMedicamentoId/{id}

Parâmetros (URL)

  • id
    ID do medicamento (inteiro)

Descrição

Retorna a foto do medicamento com o ID especificado. A resposta é a imagem binária.

DELETE /medicamento/deleteMedicamentoId/{id} DELETE
https://apifarma.roboticasuassuna.com.br/medicamento/deleteMedicamentoId/{id}

Parâmetros (URL)

  • id
    ID do medicamento a ser deletado (inteiro)

Respostas Possíveis

  • Status 1 Sucesso
  • Status 0 Não encontrado
  • Status 2 Erro interno do servidor
POST /paciente/salvarPaciente POST
https://apifarma.roboticasuassuna.com.br/paciente/salvarPaciente
Nota: Este endpoint usa file_get_contents para receber os dados. O parâmetro fotoBlob deve conter a imagem em formato blob/base64.

Parâmetros (Body)

  • nome
    Nome do paciente
  • cuidador
    ID do cuidador responsável
  • idade
    Idade do paciente
  • informacao
    Informações adicionais sobre o paciente
  • fotoBlob
    Foto do paciente em formato blob
  • operacao
    Operação a ser realizada
GET /paciente/listarAllPacientes GET
https://apifarma.roboticasuassuna.com.br/paciente/listarAllPacientes

Descrição

Lista todos os pacientes existentes, exceto a foto. Retorna um array de objetos com os dados de cada paciente.

Respostas Possíveis

{ "status": 1, "msg": "Sucesso", "data": [ { "id": 1, "nome": "João Silva", "cuidador": 2, "idade": 75, "informacao": "Paciente com hipertensão" } ] } // Ou quando não há pacientes: { "status": 0, "msg": "Sem pacientes" }
POST /cuidador/salvarCuidador POST
https://apifarma.roboticasuassuna.com.br/cuidador/salvarCuidador
Nota: O parâmetro codigo deve ser passado como CPF ou RG do cuidador.

Parâmetros (Body)

  • codigo
    CPF ou RG do cuidador
  • nome
    Nome completo do cuidador
  • email
    Email do cuidador
  • fone
    Telefone do cuidador
  • operacao
    Operação a ser realizada
GET /cuidador/listarAllCuidadores GET
https://apifarma.roboticasuassuna.com.br/cuidador/listarAllCuidadores

Descrição

Lista todos os cuidadores existentes, exceto a foto. Retorna um array de objetos com os dados de cada cuidador.

Respostas Possíveis

{ "status": 1, "msg": "Sucesso", "data": [ { "codigo": "12345678900", "nome": "Maria Santos", "email": "maria@exemplo.com", "fone": "(11) 99999-9999" } ] } // Ou quando não há cuidadores: { "status": 0, "msg": "Sem cuidadores" }
GET /agenda/onCompartimento/{id} GET
https://apifarma.roboticasuassuna.com.br/agenda/onCompartimento/{id}

Parâmetros (URL)

  • id
    ID do compartimento (1 a 5)

Respostas Possíveis

  • Status 1 Ativado
  • Status -1 Compartimento inválido

Exemplo de Resposta

{ "status": 1, "msg": "Ativado" }
GET /agenda/offCompartimento/{id} GET
https://apifarma.roboticasuassuna.com.br/agenda/offCompartimento/{id}

Parâmetros (URL)

  • id
    ID do compartimento (1 a 5)

Respostas Possíveis

  • Status 0 Desativado
  • Status -1 Compartimento inválido
GET /agenda/alterarDose/{compartimento}-{dose}-{informacao} GET
https://apifarma.roboticasuassuna.com.br/agenda/alterarDose/{compartimento}-{dose}-{informacao}
Exemplo: /alterarDose/3-5-ml equivale a 5 ml cadastrado no compartimento 3.

Parâmetros (URL)

  • compartimento
    Número do compartimento (1 a 5)
  • dose
    Valor da dose
  • informacao
    Informação adicional (ex: "ml", "comprimidos")

Respostas Possíveis

  • Status 3 Sucesso (ex: "5 ml")
  • Status -1 Erro model
  • Status 2 Erro controller

Exemplo de Resposta

{ "status": 3, "msg": "5 ml" }
GET /agenda/listarAllAgenda GET
https://apifarma.roboticasuassuna.com.br/agenda/listarAllAgenda

Descrição

Retorna todos os compartimentos com todas as informações existentes.