Saltar para o conteúdo principal

​
Modelos de Certificado

Os modelos de certificado definem o design visual dos certificados — esquema, tipografia e elementos gráficos. Os modelos são reutilizáveis: um único modelo pode ser aplicado a milhares de certificados. Estão vinculados a uma instituição e, opcionalmente, configurados via Canva para edição visual.

​
O objeto modelo de certificado

{
  "uuid": "i9j0k1l2-m3n4-5678-opqr-789012345678",
  "name": "Diploma de Graduação 2024",
  "version": "1.0",
  "path": "templates/diploma-2024.pdf",
  "preview_image_path": "templates/previews/diploma-2024.png",
  "canva_config": null,
  "is_default": true,
  "status": "active",
  "institution": {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Federal University of Technology"
  }
}
CampoTipoDescrição
uuidstringIdentificador único
namestringNome de apresentação do modelo
versionstringIdentificador de versão
pathstringCaminho interno do ficheiro do modelo
preview_image_pathstring|nullCaminho para a imagem de pré-visualização
canva_configjson|nullObjeto de configuração de design do Canva
is_defaultbooleanSe este é o modelo predefinido da instituição
statusenumactive, inactive

​
Listar modelos

GET /certificate-templates

curl "https://api.dokstamp.eu/certificate-templates?where[status]=active" \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "X-Tenant: {TENANT}"

​
Criar um modelo

POST /certificate-templates
ParâmetroTipoObrigatórioDescrição
namestringSimNome do modelo
versionstringSimString de versão
institution_uuidstringSimUUID da instituição pai
pathstringSimCaminho do ficheiro do documento modelo
preview_image_pathstringNãoCaminho da imagem de pré-visualização
canva_configobjectNãoConfiguração de design do Canva
is_defaultbooleanNãoDefinir como modelo predefinido da instituição
statusenumNãoactive (padrão), inactive
curl -X POST https://api.dokstamp.eu/certificate-templates \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Tenant: {TENANT}" \
  -d '{
    "name": "Diploma de Graduação 2024",
    "version": "1.0",
    "institution_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "path": "templates/diploma-2024.pdf",
    "is_default": true,
    "status": "active"
  }'

​
Obter, atualizar, eliminar

GET    /certificate-templates/{uuid}
PATCH  /certificate-templates/{uuid}
PUT    /certificate-templates/{uuid}
DELETE /certificate-templates/{uuid}
DELETE /certificate-templates/batch/destroy

​
Utilizar um modelo ao emitir certificados

Indique o template_uuid ao criar um certificado: 
{
  "template_uuid": "i9j0k1l2-m3n4-5678-opqr-789012345678",
  ...
}
Se template_uuid for omitido e a instituição possuir um modelo predefinido (is_default: true), o predefinido será aplicado automaticamente.