Aller au contenu
memberfy
FR

Pré-visualização do modelo renderizada pelo servidor

POST/api/certificates/templates/{id}/preview

Auth
Jeton requis
Clé d’API:
certificates:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

O mesmo motor da emissão, com dados fictícios (nome longo de propósito). O corpo é opcional e pode trazer edições não salvas (`layout`, `title`, `signers`...). Responde a imagem PNG (1600 px de largura) ou o PDF com `?format=pdf`. O header `X-Certificate-Warnings` lista campos cujo texto não coube nem no tamanho mínimo. Num modelo IMAGE, as caixas `signer1Signature`/`signer2Signature` mostram a imagem da assinatura de quem assina.

Paramètres

NomEmplacementTypeDescription
idobligatoirepathstring (uuid)
formatfacultatifquerypng | pdf

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

NomTypeDescription
namefacultatifstringNome interno do modelo.
slugfacultatifstringEndereço estável do modelo, para outros módulos (gatilhos de curso e evento) apontarem para ele sem o id. Gerado do nome na criação quando não vier; editável; único na comunidade; minúsculas, números e hífens. Renomear o modelo não muda o slug. Inválido ou já usado: 400 com `param: slug`. · max 60
titlefacultatifstringTítulo impresso ("Certificado de conclusão").
descriptionfacultatifstringAceita {nome}, {assunto} e {cargaHoraria} ({curso} e {evento} continuam valendo, como apelidos de {assunto}). Trecho entre colchetes é opcional: `concluiu[ {assunto}], com…` some quando a variável dentro dele está vazia. Fora de colchetes, a oração (entre vírgulas) com uma variável vazia é omitida, exceto a primeira, onde só a variável sai.
workloadHoursfacultatifnumber
languagefacultatifstringNasce com o idioma da comunidade.
timezonefacultatifstringFuso IANA da data impressa. Sem ele, o modelo novo nasce com o fuso da comunidade.
signersfacultatifobject[]
signers[].nameobligatoirestring
signers[].rolefacultatifstring
signers[].signatureImageUrlfacultatifstringURL devolvida pelo upload de assinatura (`POST /api/upload/certificate-template/{templateId}/signature`) de um modelo desta comunidade. Qualquer outra URL dá 400 (`signers[i].signatureImageUrl`).
layoutfacultatifobject[]Só no tipo IMAGE.
layout[].keyobligatoirerecipientName | issuedAt | qr | title | description | workload | subjectTitle | code | signer1 | signer2 | signer1Signature | signer2Signature
layout[].boxobligatoireobject
layout[].box.xfacultatifnumber≥ 0, ≤ 100
layout[].box.yfacultatifnumber≥ 0, ≤ 100
layout[].box.wfacultatifnumber≥ 0.1, ≤ 100
layout[].box.hfacultatifnumber≥ 0.1, ≤ 100
layout[].fontfacultatifinter | montserrat | lora | playfair-display | eb-garamond | great-vibes | noto-sansObrigatório fora do `qr` e das caixas de assinatura.
layout[].weightfacultatif400 | 700
layout[].sizefacultatifnumber% da altura da página (6 ≈ 36 pt).
layout[].minSizefacultatifnumberO texto encolhe até aqui antes de quebrar em duas linhas.
layout[].colorfacultatifstring
layout[].alignfacultatifleft | center | right
layout[].valignfacultatiftop | middle | bottom
layout[].uppercasefacultatifboolean

Réponses

StatutDescription
200A imagem ou o PDF.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/certificates/templates/<id>/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'