Zum Inhalt springen

Edita um modelo

PUT/api/certificates/templates/{id}

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Se o modelo já emitiu, `version` sobe; os certificados emitidos guardam a cópia do modelo usado e não mudam. Um modelo ativo que fique sem os campos obrigatórios volta a rascunho.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring (uuid)

Header

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

Request-Body application/json

NameTypBeschreibung
nameoptionalstringNome interno do modelo.
slugoptionalstringEndereç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
titleoptionalstringTítulo impresso ("Certificado de conclusão").
descriptionoptionalstringAceita {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.
workloadHoursoptionalnumber
languageoptionalstringNasce com o idioma da comunidade.
timezoneoptionalstringFuso IANA da data impressa.
signersoptionalobject[]
signers[].namePflichtstring
signers[].roleoptionalstring
signers[].signatureImageUrloptionalstringURL devolvida pelo upload de assinatura.
layoutoptionalobject[]Só no tipo IMAGE.
layout[].keyPflichtrecipientName | issuedAt | qr | title | description | workload | subjectTitle | code | signer1 | signer2
layout[].boxPflichtobject
layout[].box.xoptionalnumber≥ 0, ≤ 100
layout[].box.yoptionalnumber≥ 0, ≤ 100
layout[].box.woptionalnumber≥ 0.1, ≤ 100
layout[].box.hoptionalnumber≥ 0.1, ≤ 100
layout[].fontoptionalinter | montserrat | lora | playfair-display | eb-garamond | great-vibes | noto-sansObrigatório fora do `qr`.
layout[].weightoptional400 | 700
layout[].sizeoptionalnumber% da altura da página (6 ≈ 36 pt).
layout[].minSizeoptionalnumberO texto encolhe até aqui antes de quebrar em duas linhas.
layout[].coloroptionalstring
layout[].alignoptionalleft | center | right
layout[].valignoptionaltop | middle | bottom
layout[].uppercaseoptionalboolean

Antworten

StatusBeschreibung
200Operação realizada com sucesso.
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.

curl-Beispiel

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