🥑
v1.0.0 Beta

API Reference

Construa integrações poderosas. Controle fluxos, gerencie filas e sincronize dados em tempo real.

Sua Base URL

https://api.breakflow.com/v1
Autenticação Bearer

Todas as chamadas exigem um token JWT no header Authorization.

BASE

Introdução

/v1https://api.breakflow.com/v1

A API do BreakFlow é RESTful, previsível e segura. Todas as respostas são em JSON.

POST

Autenticação

/v1/auth/login

Obtenha seu token JWT. Este token é sua chave mestra. Guarde-o com segurança.

Parâmetros do Body

emailREQ
stringEmail do usuário cadastrado.
passwordREQ
stringSenha do usuário.
GET

Listar Eventos

/v1/events

Recupere todos os tipos de pausa configurados na sua organização e seus status em tempo real.

POST

Iniciar Pausa

/v1/events/:id/join

Tenta iniciar uma pausa. Se houver vaga, retorna sucesso. Se não, coloca na fila.

Parâmetros do Body

idREQ
stringID do evento (na URL).
force
booleanForçar entrada (apenas Admin).