Conceitos
Conceitos base para uso da API
Existem alguns conceitos a serem entendidos para o consumo desta API:
Token
Escala
Profissionais
Turnos (ou plantões)
Equipes
Slots
Periodos
TOKEN
A chave de API de parceiro deve ser enviada em um cabeçalho de Authorization com o valor “Bearer TOKEN”.
Para gerar o TOKEN entre em contato pelo e-mail: api-integracao@escala-app.com.
Caso seja necessário rotacionar a chave, nos avise que geramos uma nova e lhe enviamos.
Escala
Escala e uma abstração para auxiliar na organização dos horários de trabalhos dos profissionais.
Ela e composta por, equipes, períodos e plantões.
Exemplo: Loja A
Profissionais
Os profissionais são alocados em Turnos de trabalho. Estes turnos de trabalho possuem um dia e horário. Os Turnos estão agrupados dentro de Equipes. Estas Equipes possuem um horário padrão, aplicado automaticamente para todos os Turnos no momento da criação. Cada Turno, porém, pode ter uma modificação de horário (uma modificação pontual).
Equipes
Quando definimos que uma equipe ira trabalhar em um horário pré definido e com vagas disponíveis para trabalhar nestes horários
Exemplo: Manhã das 09:00 ao 12:00 com 2 vagas
Slots
Slots são a quantidade de vagas dentro de uma equipe.
Exemplo: A equipe Manhã tem 2 vagas (slots disponíveis) por período.
Periodos
Períodos são a junção entre as equipes e horários, por isto são paramêtros necessários.
Exemplo: Equipe Manhã tem o período dás 09:00 ao 12:00.
Turnos (Plantões)
Turnos são o conceito definido quando você aloca um profissional para trabalhar em uma escala, esses turnos podem ser únicos, se repetirem ou anunciados.
Exemplo: O profissional A vai trabalhar na escala manhã dás 09:00 ao 12:00 na terça-feira.
Conceitos Gerais
Uma escala é composta por estes elementos.
Para entender melhor como funciona o sistema à nível de usuário, é interessante ler a nossa documentação presente em: https://plantoes-doc.escala.app/
Last updated
