Instrutores
Instrutores são as pessoas que ministram os cursos. Daqui saem as opções de instrutor nas turmas e nos cursos, a assinatura que aparece nos certificados e os contatos usados para enviar certificados para assinatura eletrônica. Corresponde à tela Instrutores (módulo Administrativo), com as abas Arquivos, Especialização e Cursos, descritas nas páginas deste recurso.
Todo instrutor também aparece na lista de colaboradores, porque os dois recursos compartilham o mesmo cadastro de pessoa. Veja Colaboradores.
Identificadores
O uuid do instrutor é o mesmo do registro de colaborador compartilhado. Ele é usado em
/administrative/instructors/{uuid}, na assinatura, nos arquivos, nas especializações e
nos cursos. Os caminhos de contatos e endereços usam o customer_vendor.uuid do
instrutor, retornado na consulta.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /administrative/instructors | Lista os instrutores |
| POST | /administrative/instructors | Cadastra um instrutor |
| GET | /administrative/instructors/{uuid} | Consulta um instrutor |
| PUT | /administrative/instructors/{uuid} | Altera um instrutor |
| DELETE | /administrative/instructors/{uuid} | Remove um instrutor da lista |
| POST | /administrative/instructors/{uuid}/signature | Cadastra ou troca a assinatura |
| GET | /administrative/instructors/{uuid}/signature | Baixa a assinatura |
| DELETE | /administrative/instructors/{uuid}/signature | Remove a assinatura |
| GET | /administrative/instructors/export | Baixa a lista de instrutores em Excel |
Os recursos de cada aba têm página própria:
| Aba da tela | Página |
|---|---|
| Arquivos | Arquivos |
| Especialização | Especialização |
| Cursos | Cursos |
| Endereço | Endereços |
| Contatos | Contatos |
Para autenticação, formato de respostas, paginação e erros, veja Autenticação e Convenções.
Regras
- CPF repetido. Se a pessoa já existe no mesmo cliente, como aluno, empresa ou colaborador, o cadastro dela é reaproveitado e atualizado. Se o instrutor foi removido antes, cadastrar de novo com o mesmo CPF o restaura.
- E-mail repetido. Se o e-mail já pertence a outra pessoa do mesmo cliente, ele não é gravado e a resposta não traz aviso.
- Exclusão. A exclusão é lógica e não verifica se o instrutor está em turmas, cursos ou certificados. O instrutor removido também deixa de aparecer na lista de colaboradores, porque o cadastro é o mesmo.
Listar, consultar, cadastrar, alterar e apagar
GET /administrative/instructors
Lista os instrutores do cliente. Sem per_page, a resposta é a lista direta; com
per_page, a resposta é paginada.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
| search | Busca por nome, razão social, documento e nome ou nome curto de um curso que o instrutor está habilitado a ministrar |
| columnName e orderData | Ordenação: coluna e direção |
| per_page e page | Paginação |
Resposta: 200, lista de instrutores com uuid, name, company_name, document,
role (função), admission_date, daily_rate (diária), phonenumber, cellphone,
email, observation, user_id, o endereço resumido, a chave da foto (photo_key) e
os nomes de quem criou e alterou o registro.
curl "https://api.pedagogo.app/administrative/instructors?search=Instrutor%20exemplo&per_page=15" \
-H "Accept: application/json" \
-H "Authorization: Bearer <token-de-sessao>"
POST /administrative/instructors
Cadastra um instrutor. Ao informar admission_date, o instrutor também é marcado como
colaborador. Os campos de endereço são gravados no endereço do cadastro da pessoa.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| name | Sim | Texto | Nome do instrutor |
| document | Não | Texto | CPF ou CNPJ válido, no formato 000.000.000-00 ou 00.000.000/0000-00 |
| user_id | Condicional | Inteiro | Id do usuário do sistema. Obrigatório quando supervisor ou inspector for true |
| supervisor | Não | Booleano | Marca o instrutor como supervisor |
| inspector | Não | Booleano | Marca o instrutor como inspetor |
| birth_date | Não | Data (AAAA-MM-DD) | Data de nascimento |
| role | Não | Texto | Função ou cargo |
| admission_date | Não | Data (AAAA-MM-DD) | Data de admissão. Marca o instrutor como colaborador |
| daily_rate | Não | Número | Valor da diária |
| Não | Texto | ||
| phonenumber | Não | Texto | Telefone |
| cellphone | Não | Texto | Celular |
| observation | Não | Texto | Observação |
| zip_code | Não | Texto | CEP |
| street | Não | Texto | Endereço (rua) |
| number | Não | Texto | Número |
| complement | Não | Texto | Complemento |
| neighborhood | Não | Texto | Bairro |
| city | Não | Texto | Cidade |
| state | Não | Texto | Estado |
Resposta: 201, com o instrutor criado. Se o CPF já existia no cliente, o cadastro
existente é atualizado e devolvido.
curl -X POST https://api.pedagogo.app/administrative/instructors \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"name": "Instrutor exemplo", "daily_rate": 350}'
GET /administrative/instructors/{uuid} e DELETE /administrative/instructors/{uuid}
Consultar e remover um instrutor. A consulta devolve o cadastro com a foto e a assinatura, quando houver. A remoção segue as regras desta página.
Resposta: 200.
PUT /administrative/instructors/{uuid}
Altera um instrutor. Envie somente os campos que mudam. Nenhum campo é obrigatório nesta
chamada, mas as regras de user_id, supervisor e inspector valem quando informados.
A alteração mantém o cadastro marcado como instrutor e colaborador.
Se o document enviado já existir em outro cadastro do mesmo cliente, a alteração não é
feita e a resposta traz a chave error com a mensagem Documento já cadastrado..
Resposta: 200, com o instrutor alterado.
Assinatura
A assinatura é a imagem impressa nos certificados dos alunos das turmas do instrutor. Enviar uma assinatura não envia e-mail.
POST /administrative/instructors/{uuid}/signature
Cadastra ou troca a assinatura. Envie a imagem no campo file, em multipart/form-data.
Uma nova assinatura substitui a anterior.
Resposta: 200, com o instrutor.
GET /administrative/instructors/{uuid}/signature
Baixa a imagem da assinatura. Se o instrutor não tiver assinatura, a resposta é 200
com {"success": true}.
Resposta: 200, arquivo de imagem para download, ou o JSON acima.
DELETE /administrative/instructors/{uuid}/signature
Remove a assinatura. Os certificados emitidos depois da remoção saem sem assinatura. Se o
instrutor não tiver assinatura, a resposta é 200 com {"success": true}.
Resposta: 200, com o instrutor, ou o JSON acima.
Exportar
GET /administrative/instructors/export
Baixa um arquivo .xlsx com a lista de instrutores. A planilha respeita o parâmetro
search e traz nome, documento, função, data de admissão, diária e se o instrutor tem
assinatura cadastrada (Sim ou Não).
Resposta: 200, arquivo para download.