Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.dokstamp.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Estudantes

Estudantes são os destinatários dos certificados. Ao contrário de instituições e cursos, os estudantes são registados ao nível do tenant — não estão vinculados a uma instituição ou curso específico no momento da criação. Um estudante pode estar matriculado em vários cursos e receber múltiplos certificados.

​
O objeto estudante

{
  "uuid": "f6a7b8c9-d0e1-2345-fghi-456789012345",
  "name": "Maria Fernanda Silva",
  "email": "maria@email.com",
  "date_of_birth": "1998-05-20",
  "gender": "female",
  "social_name": null,
  "created_at": "2024-01-20T14:30:00.000000Z"
}
CampoTipoDescrição
uuidstringIdentificador único
namestringNome legal completo
emailstringEndereço de e-mail
date_of_birthdateData de nascimento (ISO 8601: YYYY-MM-DD)
genderstringIdentidade de género
social_namestring|nullNome social/preferido (utilizado nos certificados quando definido)

​
Listar estudantes

GET /students

# Pesquisar por e-mail para evitar registos duplicados
curl "https://api.dokstamp.com/students?where[user][email]=maria@email.com" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"
Pesquise sempre pelo e-mail antes de criar um novo estudante para evitar duplicados. Utilize GET /students?where[email]=estudante@email.com.

​
Criar um estudante

POST /students
ParâmetroTipoObrigatórioDescrição
namestringSimNome legal completo
emailstringSimEndereço de e-mail (deve ser único dentro do tenant)
date_of_birthdateSimData de nascimento (YYYY-MM-DD)
genderstringNãoIdentidade de género
social_namestringNãoNome social/preferido
curl -X POST https://api.dokstamp.com/students \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "Maria Fernanda Silva",
    "email": "maria@email.com",
    "date_of_birth": "1998-05-20",
    "gender": "female"
  }'
Resposta 201: 
{
  "data": {
    "uuid": "f6a7b8c9-d0e1-2345-fghi-456789012345",
    "name": "Maria Fernanda Silva",
    "email": "maria@email.com",
    "date_of_birth": "1998-05-20",
    "gender": "female",
    "social_name": null
  }
}

​
Obter um estudante

GET /students/{uuid}
Utilize includes para carregar dados relacionados: 
GET /students/{uuid}?includes[enrollments]=1&includes[certificates]=1

​
Atualizar um estudante

PATCH /students/{uuid}
Envie apenas os campos a alterar. Atualizar o nome de um estudante após a emissão de um certificado não altera o nome nos certificados existentes — o snapshot do sujeito da credencial capturado no momento da emissão é imutável.

​
Eliminar um estudante

DELETE /students/{uuid}
DELETE /students/batch/destroy
Eliminação suave (soft delete). Os certificados emitidos para o estudante permanecem no sistema.

​
Recursos relacionados