Emite certificados de um modelo ativo
POST/api/certificates
- Auth
- Jeton requis
- Clé d’API:
- certificates:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
O modelo vem por `templateId` ou `templateSlug`. Para quem: qualquer combinação de `memberIds`, `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.
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (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
| Nom | Type | Description |
|---|---|---|
templateIdfacultatif | string (uuid) | Ou `templateSlug`. |
templateSlugfacultatif | string | |
memberIdsfacultatif | string (uuid)[] | |
memberGroupIdsfacultatif | string (uuid)[] | |
tagsfacultatif | string[] | Nomes das tags, como em `GET /api/members/tags`. |
tagIdsfacultatif | string (uuid)[] | Ids de `CommunityTag` (só existem para tags com cor). |
memberGroupIdfacultatif | string (uuid) | |
tagIdfacultatif | string (uuid) | |
overridesfacultatif | object | Valores desta emissão; ausentes vêm do modelo. |
overrides.titlefacultatif | string | |
overrides.descriptionfacultatif | string | |
overrides.workloadHoursfacultatif | number | |
overrides.subjectTitlefacultatif | string | Do que é o certificado (um curso, um evento, uma mentoria). Preenche {assunto} e o campo `subjectTitle` da arte. |
overrides.courseTitlefacultatif | string | Apelido de `subjectTitle`. |
overrides.eventTitlefacultatif | string | Apelido de `subjectTitle`. |
sendEmailfacultatif | boolean | |
issueAnywayfacultatif | boolean | "Emitir mesmo assim" para quem já tem. |
dryRunfacultatif | boolean |
Réponses
| Statut | Description |
|---|---|
200 | Conferência (`dryRun`) ou nada a emitir. |
202 | Emissão aceita, renderizando na fila. |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/certificates" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'