Documentação da API REST

API REST para integração com o sistema Alfa Credenciamento. Permite consultar status de eventos e formulários, gerenciar inscritos e realizar outras operações via HTTP.

1. Visão geral

2. Autenticação

2.1 Token por evento (Status e Inscritos)

Os endpoints de Status e Inscritos usam autenticação Bearer com token vinculado ao evento.

Obtenção do token:

1. Acesse o painel do operador
2. Selecione o evento
3. Vá em Integrações > API REST
4. Crie um novo token ou use um existente
5. Copie o token exibido na listagem

Uso nas requisições:

Authorization: Bearer SEU_TOKEN_AQUI

Permissões do token: Cada token pode ter permissões diferentes (index, show, store, update, destroy), configuráveis no momento da criação. Um token sem a permissão store, por exemplo, não poderá criar inscritos.

Validade: O token possui data de expiração opcional. Tokens expirados retornam 401 Unauthorized.

3. Endpoints de Status

Todos os endpoints de status exigem autenticação Bearer e usam o evento associado ao token.

3.1 Status do evento

Verifica se o evento está aberto ou fechado para inscrições.

GET /api/status/evento

Resposta (200 OK):

{
  "evento_id": 2430,
  "nome": "Nome do Evento Exemplo",
  "aberto": true,
  "date_start": "2026-03-10T10:00:00.000000Z",
  "date_end": "2026-04-10T18:00:00.000000Z"
}

3.2 Status do formulário

Verifica se um formulário de inscrição específico está aberto ou fechado.

GET /api/status/formulario/{id}

Parâmetro: id (path) — ID do formulário.

Resposta (200 OK):

{
  "formulario_id": 123,
  "nome": "Inscrição Geral",
  "aberto": false,
  "create_off": true,
  "data_abertura": "2026-03-01T09:00:00.000000Z",
  "data_fechamento": "2026-03-31T23:59:59.000000Z"
}

3.3 Status de vagas da categoria

Verifica se uma categoria atingiu o limite de vagas.

GET /api/status/categoria/{id}

Parâmetro: id (path) — ID da categoria.

Resposta (200 OK):

{
  "categoria_id": 45,
  "nome": "Participante VIP",
  "esgotada": true,
  "limite_inscricoes": 100,
  "total_confirmados": 100,
  "vagas_restantes": 0
}

4. Endpoints de Inscritos

Os endpoints de inscritos exigem autenticação Bearer. Os campos do formulário são dinâmicos por evento — use GET /api/inscrito/campos para obter os IDs exatos.

4.1 Obter campos para criar inscrito

GET /api/inscrito/campos

Retorna os IDs dos campos e um exemplo de body para POST /inscrito.

4.2 Listar inscritos

GET /api/inscrito — Requer permissão: index

4.3 Criar inscrito

POST /api/inscrito — Requer permissão: store

Corpo: objeto JSON com os campos do formulário. Pode enviar na raiz ({"nome": "João", "email": "joao@email.com"}) ou dentro de dados.

Campos opcionais: voucher, cupom (conforme configuração do evento).

4.4 Exibir inscrito

GET /api/inscrito/{id} — Requer permissão: show

status: 0 = Pendente, 1 = Liberado, 2 = Recusado.

4.5 Atualizar inscrito

PUT /api/inscrito/{id} — Requer permissão: update

Envie apenas os campos que deseja atualizar: categoria, status ou campos do formulário (ex.: nome, email).

4.6 Remover inscrito

DELETE /api/inscrito/{id} — Requer permissão: destroy

Resposta: 204 No Content.

5. Códigos de resposta e erros

6. Swagger / OpenAPI

A documentação interativa está disponível em:

• Swagger UI: https://adm.alfacredenciamento.com.br/docs — Permite testar os endpoints no navegador.
• Especificação OpenAPI (JSON): https://adm.alfacredenciamento.com.br/docs/spec — Útil para Postman ou gerar clientes.

Uso no Swagger: Clique em Authorize, cole o token (sem o prefixo Bearer ), autorize e teste os endpoints com Try it out.