Zum Inhalt springen
memberfy
de-ch

Emite certificados de um modelo ativo

POST/api/certificates

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.

O modelo vem por `templateId` ou `templateSlug`. Para quem: qualquer combinação de `profileIds`, `memberGroupIds` e `tags` (nomes) / `tagIds`, só membros da comunidade; a união das pessoas, sem repetir quem está em mais de um. `memberGroupId` e `tagId` no singular continuam aceitos. Emissão por e-mail não existe mais: `emails` responde 400. Quem já tem um certificado vigente do modelo é avisado e pulado (`skipped`, motivo `alreadyHas`), a menos que `issueAnyway: true`. Nome com caractere que nenhuma fonte desenha é pulado (`unsupportedName`). `dryRun: true` responde 200 com essa conferência sem gravar. Emitindo, responde **202**: as linhas nascem `PENDING` com a data e hora deste pedido, e a renderização vai para a fila; com mais de uma pessoa há um `batch` para acompanhar. Limite de 1.000 pessoas por pedido.

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
templateIdoptionalstring (uuid)Ou `templateSlug`.
templateSlugoptionalstring
profileIdsoptionalstring (uuid)[]
memberGroupIdsoptionalstring (uuid)[]
tagsoptionalstring[]Nomes das tags, como em `GET /api/profiles/tags`.
tagIdsoptionalstring (uuid)[]Ids de `CommunityTag` (só existem para tags com cor).
memberGroupIdoptionalstring (uuid)
tagIdoptionalstring (uuid)
overridesoptionalobjectValores desta emissão; ausentes vêm do modelo.
overrides.titleoptionalstring
overrides.descriptionoptionalstring
overrides.workloadHoursoptionalnumber
overrides.subjectTitleoptionalstringDo que é o certificado (um curso, um evento, uma mentoria). Preenche {assunto} e o campo `subjectTitle` da arte.
overrides.courseTitleoptionalstringApelido de `subjectTitle`.
overrides.eventTitleoptionalstringApelido de `subjectTitle`.
sendEmailoptionalboolean
issueAnywayoptionalboolean"Emitir mesmo assim" para quem já tem.
dryRunoptionalboolean

Antworten

StatusBeschreibung
200Conferência (`dryRun`) ou nada a emitir.
202Emissão aceita, renderizando na fila.
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 POST "https://api.memberfy.net/api/certificates" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'