Vai al contenuto
memberfy
it-it

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

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

Auth
Richiede un token
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

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.

Parametri

NomeDoveTipoDescrizione
idobbligatoriopathstring (uuid)
formatfacoltativoquerypng | pdf

Header

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

Corpo della richiesta application/json

NomeTipoDescrizione
namefacoltativostringNome interno do modelo.
slugfacoltativostringEndereç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
titlefacoltativostringTítulo impresso ("Certificado de conclusão").
descriptionfacoltativostringAceita {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.
workloadHoursfacoltativonumber
languagefacoltativostringNasce com o idioma da comunidade.
timezonefacoltativostringFuso IANA da data impressa.
signersfacoltativoobject[]
signers[].nameobbligatoriostring
signers[].rolefacoltativostring
signers[].signatureImageUrlfacoltativostringURL devolvida pelo upload de assinatura.
layoutfacoltativoobject[]Só no tipo IMAGE.
layout[].keyobbligatoriorecipientName | issuedAt | qr | title | description | workload | subjectTitle | code | signer1 | signer2
layout[].boxobbligatorioobject
layout[].box.xfacoltativonumber≥ 0, ≤ 100
layout[].box.yfacoltativonumber≥ 0, ≤ 100
layout[].box.wfacoltativonumber≥ 0.1, ≤ 100
layout[].box.hfacoltativonumber≥ 0.1, ≤ 100
layout[].fontfacoltativointer | montserrat | lora | playfair-display | eb-garamond | great-vibes | noto-sansObrigatório fora do `qr`.
layout[].weightfacoltativo400 | 700
layout[].sizefacoltativonumber% da altura da página (6 ≈ 36 pt).
layout[].minSizefacoltativonumberO texto encolhe até aqui antes de quebrar em duas linhas.
layout[].colorfacoltativostring
layout[].alignfacoltativoleft | center | right
layout[].valignfacoltativotop | middle | bottom
layout[].uppercasefacoltativoboolean

Risposte

CodiceDescrizione
200A imagem ou o PDF.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Esempio con 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 '{}'