Modelos de Certificado

Os modelos de certificado definem o design visual dos certificados — layout, tipografia e elementos gráficos. Modelos são reutilizáveis: um único modelo pode ser aplicado a milhares de certificados. Eles sã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"
  }
}

Campo	Tipo	Descrição
`uuid`	string	Identificador único
`name`	string	Nome de exibição do modelo
`version`	string	Identificador de versão
`path`	string	Caminho interno do arquivo do modelo
`preview_image_path`	string\|null	Caminho para a imagem de pré-visualização
`canva_config`	json\|null	Objeto de configuração de design do Canva
`is_default`	boolean	Se este é o modelo padrão da instituição
`status`	enum	`active`, `inactive`

Listar modelos

GET /certificate-templates

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

Criar um modelo

POST /certificate-templates

Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do modelo
`version`	string	Sim	String de versão
`institution_uuid`	string	Sim	UUID da instituição pai
`path`	string	Sim	Caminho do arquivo do documento modelo
`preview_image_path`	string	Não	Caminho da imagem de pré-visualização
`canva_config`	object	Não	Configuração de design do Canva
`is_default`	boolean	Não	Definir como modelo padrão da instituição
`status`	enum	Não	`active` (padrão), `inactive`

curl -X POST https://api.dokstamp.com/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, excluir

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

Usar um modelo ao emitir certificados

Informe 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 padrão (is_default: true), o padrão será aplicado automaticamente.

Primeiros Passos

Conceitos Fundamentais

Autenticação

Instituições

Organizações

Cursos

Módulos

Estudantes

Matrículas

Certificados

Modelos de Certificado

Arquivos

Guias

Guia de Integração

Modelos de Certificado

Modelos de Certificado

O objeto modelo de certificado

Listar modelos

Criar um modelo

Obter, atualizar, excluir

Usar um modelo ao emitir certificados

​Modelos de Certificado

​O objeto modelo de certificado

​Listar modelos

​Criar um modelo

​Obter, atualizar, excluir

​Usar um modelo ao emitir certificados

Modelos de Certificado

O objeto modelo de certificado

Listar modelos

Criar um modelo

Obter, atualizar, excluir

Usar um modelo ao emitir certificados