Laravel

Instruções

Como usar o console

Siga as orientações abaixo para operar o Probipe com segurança.

1. Cadastre o endpoint e os tokens na página de Configurações para habilitar as consultas.

2. Volte à página de Conferências e clique em Atualizar conferências para listar os registros disponíveis.

3. As informações ficam apenas na sessão atual; limpe os campos ou feche o navegador para removê-las.

4. Caso encontre erros, valide o endpoint informado e confirme se os tokens são válidos.

Guia de integração

API de conferência que o seu sistema deve expor

O Probipe apenas consome os endpoints abaixo para montar a interface; cabe ao cliente implementá-los com o mesmo formato usado no mock.

Base URL esperada: /conferencia

Autenticação

1O Probipe envia Authorization: Bearer mock-global-token em todas as requisições.
2Também acompanha o header X-User-Token: mock-user-token; sua API deve validar os dois tokens.
3Configure os mesmos valores na página de Configurações. O Probipe usará exatamente esse formato de autenticação.

Estrutura esperada

Conferências: a lista traz id, nome, campos de título (titulo1-3), data_importacao e progresso. Exemplo: [{ "id": 101, "nome": "Vestibular 2024", ... }].
Itens: cada nível retorna dados com id, item, titulo, codigo, situação, contadores (total/total_conferido) e flags de navegação. Inclua pai (quando existir), breadcrumb e os títulos da conferência.
Escaneamento: respostas incluem flag_erro, pai_id para navegação e flag_completou para indicar conclusão. Em erros retorne tipo_erro e mensagem.

Exemplo de itens:

{
  "titulo": "Vestibular 2024",
  "pai": null,
  "dados": [
    {
      "id": 201,
      "item": "Malote de Provas",
      "titulo": "Biologia [MALOTE 1/2]",
      "codigo": 202400101,
      "id_situacao": 2,
      "situacao": "Iniciado",
      "flag_possui_codigo_barras": true,
      "flag_malote": true,
      "flag_permite_limpar": true,
      "flag_permite_navegar_filho": true,
      "total": 3,
      "total_conferido": 1
    }
  ],
  "breadcrumb": [],
  "conferencia": "Vestibular 2024",
  "conferencia_titulo1": "Campus Recife",
  "conferencia_titulo2": "Bloco A",
  "conferencia_titulo3": "Turno manhã"
}

GET /conferencia/conferencias

Retorna a lista de conferências disponíveis. O front lê nome e títulos adicionais para montar os cards.

GET /conferencia/conferencias
Headers:
  Authorization: Bearer mock-global-token
  X-User-Token: mock-user-token

GET /conferencia/conferencias/{id}/itens/{idPai?}

Entrega a estrutura hierárquica. Use pai para preencher o cabeçalho do nível atual e breadcrumb para montar a navegação.

GET /conferencia/conferencias/101/itens
GET /conferencia/conferencias/101/itens/201

POST /conferencia/conferencias/{id}/itens/{idPai?}/escanear/{codigo}

Simula a leitura do código de barras. Em caso de sucesso retorna o pai_id para navegação automática; erros trazem tipo_erro e mensagem.

POST /conferencia/conferencias/101/itens/201/escanear/202400202

POST /conferencia/conferencias/{id}/itens/{idPai}/malote

Gera um malote fictício com campos padrão (codigo, titulo e flags de controle) para testar a criação em massa.

POST /conferencia/conferencias/{id}/arquivar

Alterna o status de arquivamento apenas na simulação. Útil para validar feedbacks visuais do front.

POST /conferencia/conferencias/{id}/limpar/{idPai?}

Retorna todos os itens do nível ao status pendente. O corpo da resposta confirma o pai_id impactado.