Api Demander - Políticas de horas de uso

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar políticas de tiempos de uso.

Concepto y funcionamiento: Políticas de Horarios de Uso.

Consulta

Enumera las políticas de tiempo de la empresa. Sin filtro, devuelve todo.

Rota: {host}/public/v1/politicas-de-horario?filtroDataAlteracao={data}&operadorFiltro={operador}&mostrarVendedores={boolean}
Método: GET

Precaución

Filtros

• filtroDataAlteracao (opcional) — formato Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (predeterminado >=)
• mostrarVendedores (opcional) — 1/true incluye la lista de códigos de vendedores vinculados

Retorno:

[
  {
    "id": 123,
    "codigo": 1,
    "descricao": "Liberado Seg. a Sex. - 08:00 às 18:00",
    "ativo": true,
    "mensagemBloqueio": "Fora do horário permitido para utilização do aplicativo.",
    "operacoesBloqueadas": [
      "sincronizacaoMobile",
      "iniciarPedidoMobile"
    ],
    "horarios": {
      "segunda": {
        "opcao": "liberadoEntre",
        "intervalos": [
          {
            "inicio": "08:00",
            "fim": "18:00"
          }
        ]
      },
      "terca": {
        "opcao": "liberadoEntre",
        "intervalos": [
          {
            "inicio": "08:00",
            "fim": "18:00"
          }
        ]
      },
      "quarta": {
        "opcao": "liberadoEntre",
        "intervalos": [
          {
            "inicio": "08:00",
            "fim": "12:00"
          },
          {
            "inicio": "13:00",
            "fim": "18:00"
          }
        ]
      },
      "quinta": {
        "opcao": "liberado",
        "intervalos": []
      },
      "sexta": {
        "opcao": "liberado",
        "intervalos": []
      },
      "sabado": {
        "opcao": "bloqueado",
        "intervalos": []
      },
      "domingo": {
        "opcao": "bloqueado",
        "intervalos": []
      }
    },
    "dataAlteracao": "2025-06-10 14:30:00",
    "vendedores": [
      10,
      25,
      30
    ]
  }
]

Consulta única

Devuelve una póliza mediante codigo.

Rota: {host}/public/v1/politicas-de-horario/{codigo}?mostrarVendedores={boolean}
Método: GET

Retorno: mismo objeto que el listado (sin la matriz).

Insertar o actualizar

POST inserción mediante la tecla codigo. Si se omite codigo de la inclusión, Demander genera el siguiente disponible.

Rota: {host}/public/v1/politicas-de-horario
Método: POST
Body: json

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	entero			Código de póliza. La inclusión es opcional (automática). Si ya existe, la solicitud lo actualiza.
descripción	cadena		✓	Nombre de la política.
activo	booleano			Indica si la política está activa. Valor predeterminado de inclusión: true.
mensagemBloqueio	cadena			Mensaje mostrado al vendedor en bloque.
operacoesBloqueadas	matriz		✓	Operaciones bloqueadas fuera de horario. Ver valores aceptados.
horarios	objeto		✓	Configuración de 7 días. Ver configuración de horarios.

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devuelve 200.

Actualización

• Sólo el atributo codigo es obligatorio. Otros campos opcionales (actualización parcial). Devuelve 200.

Cuerpo:

{
  "descricao": "Liberado Seg. a Sex. - 08:00 às 18:00",
  "ativo": true,
  "mensagemBloqueio": "Fora do horário permitido para utilização do aplicativo.",
  "operacoesBloqueadas": [
    "sincronizacaoMobile",
    "iniciarPedidoMobile"
  ],
  "horarios": {
    "segunda": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "terca": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "quarta": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "quinta": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "sexta": {
      "opcao": "liberadoEntre",
      "intervalos": [
        {
          "inicio": "08:00",
          "fim": "18:00"
        }
      ]
    },
    "sabado": {
      "opcao": "bloqueado",
      "intervalos": []
    },
    "domingo": {
      "opcao": "bloqueado",
      "intervalos": []
    }
  }
}

Retorno:

{
  "mensagem": "Política de horário de utilização salva com sucesso.",
  "codigo": 1
}

Eliminar

Elimina la política mediante codigo.

Rota: {host}/public/v1/politicas-de-horario/{codigo}
Método: DELETE

Precaución

Restricciones

• No excluye si está vinculado a vendedores o es política estándar de la empresa. Devolución HTTP 422.

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}

Precaución

Enlace

• Esta API gestiona el registro de pólizas. Para vincular a la empresa o a un vendedor, utilice Demander Web en Configuración de la empresa o Registro de vendedor.

Operaciones bloqueadas

Valores aceptados en operacoesBloqueadas:

Valor	Descripción
sincronizacaoMobile	Sincronización móvil (exportación/importación)
iniciarPedidoMobile	Comience a ingresar un nuevo pedido
editarPedidoMobile	Editar pedido existente
excluirPedidoMobile	Eliminar pedido en el móvil
salvarPedidoMobile	Guardar pedido en el móvil
enviarPedidosParaWS	Exportar pedidos desde el móvil a Demander Web
finalizarPedidosWeb	Finalizar pedidos en Demander Web

Configuración de horarios

El objeto horarios debe contener los 7 días: segunda, terca, quarta, quinta, sexta, sabado, domingo.

Propiedad	Tipo	Obligatorio	Descripción
opción	cadena	✓	liberado, bloqueado o liberadoEntre.
intervalos	matriz		Obligatorio cuando opcao=liberadoEntre (hasta 2 intervalos). Vacíe ([]) a liberado/bloqueado.

Rangos en el formato HH:mm:

"intervalos": [
{ "inicio": "08:00", "fim": "12:00" },
{ "inicio": "13:00", "fim": "18:00" }
]