Documentação da API

POST /insert_project

Resumo

Este endpoint permite criar um novo projeto em uma unidade específica.

---

Descrição

Utilize este endpoint para inserir um novo projeto no sistema, associado a uma unidade específica. O projeto pode incluir informações como nome, orçamento e observações.

---

Requisição

Body da Requisição

O corpo deve ser um objeto JSON com os seguintes parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_token	string	Sim	Token identificador da unidade.	aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
name	string	Sim	Nome do projeto.	Projeto Alpha
budget	number	Não	Orçamento do projeto (deve ser um número positivo).	15000.50
observation	string	Não	Observação ou descrição do projeto.	Projeto para desenvolvimento de novo sistema

---

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/insert_project' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "name": "<name>",
  "budget": <budget>,
  "observation": "<observation>"
}'

---

Resposta

200 OK

Criação realizada com sucesso.

{
  "success": true,
  "message": "Project inserted successfully",
  "data": {
    "token": "<token>"
  }
}

Erros Comuns

Status	Mensagem	Descrição
400	"Missing parameters"	Algum parâmetro obrigatório (access_token, unit_token, name) não foi enviado.
400	"Invalid parameter: budget must be a positive number"	O parâmetro budget não é um número positivo válido.
403	"Invalid data"	Token de autenticação inválido ou não autorizado.
404	"Unit not found"	A unidade com o unit_token fornecido não foi encontrada.
500	"Something went wrong. Please try again later."	Erro interno no servidor.

---

Observações

• O campo budget deve ser um número positivo, caso seja fornecido. Valores não numéricos ou negativos resultarão em erro.
• O campo observation é opcional e pode ser omitido ou enviado como null.
• A inserção é realizada de forma transacional, garantindo a consistência dos dados no banco.
• O projeto é automaticamente marcado como ativo (active: true) ao ser criado.
• Certifique-se de que os tokens estejam válidos e que a unidade exista no sistema.