Saltar para o conteúdo principal

​
Instituições

Uma instituição é o órgão emissor — a universidade, escola ou organização que concede certificados. É a entidade de nível mais alto na hierarquia académica e deve ser criada antes de cursos, módulos ou certificados.

​
O objeto instituição

{
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Federal University of Technology",
  "legal_name": "Federal University of Technology Foundation",
  "tax_id": "00.000.000/0001-00",
  "country": "Brazil",
  "website": "https://fut.edu.br",
  "linkedin_organization": "federal-university-of-technology",
  "status": "active",
  "is_badges_enabled": false,
  "badge_image_uuid": null,
  "created_at": "2024-01-15T10:00:00.000000Z",
  "updated_at": "2024-01-15T10:00:00.000000Z"
}
CampoTipoDescrição
uuidstringIdentificador único — utilize este valor em todos os pedidos de recursos relacionados
namestringNome de apresentação
legal_namestringNome oficial da entidade legal
tax_idstringNúmero de registo fiscal (ex.: CNPJ)
countrystringPaís de registo
websitestringSítio web da instituição
linkedin_organizationstringSlug da organização no LinkedIn
statusenumactive, inactive, suspended
is_badges_enabledbooleanIndica se a emissão de Open Badges está ativa
badge_image_uuidstring|nullUUID do ficheiro de imagem do badge (obrigatório se badges estiver ativo)

​
Listar instituições

GET /institutions
Parâmetros de consulta: Consulte Filtragem, Ordenação e Paginação. 
curl https://api.dokstamp.com/institutions \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Criar uma instituição

POST /institutions
ParâmetroTipoObrigatórioDescrição
namestringSimNome de apresentação (máx. 255 caracteres)
countrystringSimPaís de registo
legal_namestringNãoNome oficial da entidade legal
tax_idstringNãoNúmero de registo fiscal
websitestringNãoURL do sítio web da instituição
linkedin_organizationstringNãoIdentificador da organização no LinkedIn
statusenumNãoactive (padrão), inactive, suspended
is_badges_enabledbooleanNãoAtivar emissão de Open Badges
badge_image_uuidstringNão*Obrigatório se is_badges_enabled for true
curl -X POST https://api.dokstamp.com/institutions \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "Federal University of Technology",
    "legal_name": "Federal University of Technology Foundation",
    "tax_id": "00.000.000/0001-00",
    "country": "Brazil",
    "website": "https://fut.edu.br",
    "status": "active"
  }'
Resposta 201: 
{
  "data": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Federal University of Technology",
    ...
  }
}

​
Obter uma instituição

GET /institutions/{uuid}

curl https://api.dokstamp.com/institutions/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Atualizar uma instituição

PATCH /institutions/{uuid}
Envie apenas os campos que pretende alterar. PATCH realiza uma atualização parcial. 
PUT /institutions/{uuid}
PUT substitui o recurso completo — todos os campos devem ser fornecidos.

​
Eliminar uma instituição

DELETE /institutions/{uuid}
Devolve 204 No Content em caso de sucesso. Trata-se de uma eliminação lógica — o registo não é removido permanentemente.
Eliminar uma instituição não elimina os cursos, módulos ou certificados a ela associados. Esses registos permanecerão, mas farão referência a uma instituição eliminada.

​
Eliminação em lote

DELETE /institutions/batch/destroy
ParâmetroTipoObrigatórioDescrição
uuidsarraySimArray de UUIDs de instituições a eliminar
{ "uuids": ["uuid-1", "uuid-2", "uuid-3"] }

​
Obter configuração de emissor de badges

GET /institutions/{uuid}/badges/issuers
Devolve o perfil de emissor de Open Badges da instituição. Utilizado na geração de asserções de badge.