← InícioFleetPay / API

Consultar painel diário de alocação do gestor

Parâmetros, estrutura de dados e respostas do contrato versionado.

GET/gestor/painel-alocacao
consultarPainelAlocacaoGestorBase de Homologação: https://api.fleetpay.site/v1

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Agrega demanda operacional, vagas preenchidas vs abertas, ofertas em curso e status de início de viagem na data informada. Exige escopo operacao.

Autenticação

Escopo Necessário
operacao — Operação
Módulo
Gestor de Transporte e Alocação
Perfis Aplicáveis
Gestor de Transporte
Mecanismos
OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.

Parâmetros

datequery · stringOpcional

Data operacional (YYYY-MM-DD, padrão hoje).

Restrições
{
  "type": "string"
}

Respostas

200 Resposta HTTP

Operação processada com sucesso.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Resposta HTTP

Credencial ausente, inválida ou de outro ambiente.

403 Resposta HTTP

Escopo do painel não habilitado ou recurso fora do escopo da company.

Definição Completa da Operação
{
  "tags": [
    "Programações & Alocação"
  ],
  "operationId": "consultarPainelAlocacaoGestor",
  "summary": "Consultar painel diário de alocação do gestor",
  "description": "Agrega demanda operacional, vagas preenchidas vs abertas, ofertas em curso e status de início de viagem na data informada. Exige escopo `operacao`.",
  "parameters": [
    {
      "name": "date",
      "in": "query",
      "required": false,
      "description": "Data operacional (YYYY-MM-DD, padrão hoje).",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Operação processada com sucesso.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    }
  },
  "x-fleetpay-scope": "operacao",
  "x-fleetpay-module": "gestor-alocacao",
  "x-fleetpay-profiles": [
    "gestor"
  ],
  "method": "GET",
  "path": "/gestor/painel-alocacao"
}