Skip to content

BasisDocumentação dos Módulos

APIs headless, multitenant e prontas para produção — escolha um módulo e comece a integrar em minutos.

Como os módulos funcionam ​

Todos os módulos da Basis seguem o mesmo desenho de arquitetura. Aprendeu um, aprendeu todos:

Os três pilares de qualquer módulo

  • Instâncias isoladas: cada workspace cria instâncias independentes do módulo, com configurações, usuários e dados totalmente separados.
  • Identificação por header: requisições aos endpoints /v1/<módulo>/** carregam um header próprio (X-Booking-Id, X-Ats-Id, etc.) que resolve a instância e valida a origem.
  • Áreas separadas por público: gestão da instância (dono da conta), operação (staff) e portal do cliente/candidato — cada uma com autenticação e tokens próprios.

Convenções compartilhadas ​

  • Paginação: page/perPage (máx. 100) com resposta { "meta": {...}, "data": [...] }.
  • Listas para dropdown: endpoints GET .../list retornam [{ "value", "label" }], com search opcional.
  • Erros de validação: 422 Unprocessable Entity com errors: [{ "message", "rule", "field" }] (pt/en via i18n).
  • Billing: todas as rotas passam por limite de plano — 402 Payment Required quando o plano não permite a operação.
  • Datas: sempre ISO 8601; filtros de período usam YYYY-MM-DD.

Primeiros passos ​

  1. Escolha um módulo nos cards acima e leia a página de introdução — ela explica as áreas, a autenticação e o controle de acesso.
  2. Crie uma instância pela área de gestão do módulo (/user/<módulo>) e copie o tokenHeader gerado.
  3. Autentique-se no login da área que você vai consumir (staff ou portal) e use o token Bearer retornado.
  4. Integre seguindo as páginas de cada recurso, com exemplos de requisição e resposta.

Não sabe por onde começar?

O Módulo de Booking é um ótimo ponto de partida: ele demonstra todos os padrões da plataforma — instâncias, RBAC, portal do cliente e métricas — em um fluxo simples de entender.