> ## Documentation Index
> Fetch the complete documentation index at: https://docs.weve.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurar o certificado do curso

> Liga o certificado do curso e define título, texto, carga horária e assinatura.

**Ligar vale para quem já concluiu.** Todo aluno que já tinha fechado o curso recebe o
certificado nos minutos seguintes, em lotes — não é só dali para frente.

Desligar **não** revoga o que já foi emitido: certificado emitido é fato, e desfazê-lo é
[revogar](/api-reference/certificates/revoke), com motivo.

O `body` aceita os marcadores `{aluno}`, `{curso}`, `{club}`, `{carga_horaria}`, `{data}`,
`{codigo}` e `{aulas}`. Marcador desconhecido é recusado com `invalid_placeholder` (422) — ele
não sai vazio no certificado de ninguém.

```bash theme={null}
curl -X PUT https://api.weve.cx/v1/clubs/$CLUB_ID/courses/$COURSE_ID/certificate \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enabled": true,
    "title": "Certificado de conclusão",
    "hours": 40,
    "body": "concluiu o curso {curso}, com carga horária de {carga_horaria}, em {data}.",
    "signature_name": "Ana Ribeiro",
    "signature_role": "Diretora de ensino"
  }'
```


## OpenAPI

````yaml PUT /v1/clubs/{clubId}/courses/{courseId}/certificate
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
  - name: exports
  - name: certificates
paths:
  /v1/clubs/{clubId}/courses/{courseId}/certificate:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/CourseId'
    put:
      tags:
        - certificates
      summary: Configura o certificado do curso
      description: |
        Liga ou desliga o certificado do curso e define o que ele imprime.

        **Ligar vale para quem JÁ concluiu**: a varredura emite para todo aluno
        que já tinha fechado o curso, em lotes, nos minutos seguintes — não é
        só dali para frente. Desligar não revoga nada do que já foi emitido:
        certificado emitido é fato, e desfazê-lo é `revoke`, com motivo.

        O `body` aceita os marcadores `{aluno}`, `{curso}`, `{club}`,
        `{carga_horaria}`, `{data}`, `{codigo}` e `{aulas}`. Marcador
        desconhecido é **recusado** (422 `invalid_placeholder`) em vez de sair
        vazio no certificado de alguém.

        `hours` é o que vai IMPRESSO, e é decisão de quem assina — a API
        sugere, não decide. Nulo imprime o certificado sem carga horária.

        Exige permissão de administração do club.

        Erros: `invalid_placeholder` (422, marcador desconhecido no `body`);
        `media_not_found` (422, a assinatura não é uma imagem da biblioteca
        deste club).
      operationId: setCourseCertificate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CourseCertificateInput'
      responses:
        '200':
          description: A configuração gravada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseCertificateResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
    CourseId:
      name: courseId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    CourseCertificateInput:
      type: object
      required:
        - enabled
        - title
      properties:
        enabled:
          type: boolean
        title:
          type: string
          minLength: 1
          maxLength: 120
        body:
          type: string
          nullable: true
          maxLength: 600
        hours:
          type: integer
          nullable: true
          minimum: 1
          maximum: 10000
        signature_media_id:
          type: string
          format: uuid
          nullable: true
        signature_name:
          type: string
          nullable: true
          maxLength: 120
        signature_role:
          type: string
          nullable: true
          maxLength: 120
    CourseCertificateResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/CourseCertificate'
    CourseCertificate:
      type: object
      required:
        - enabled
        - title
        - suggested_hours
        - issued_count
      description: |
        O que o curso imprime no certificado. Curso que nunca configurou nada
        responde com os padrões e `enabled: false`.
      properties:
        enabled:
          type: boolean
          description: |
            Nasce falso. Ligar é o club dizendo "este curso vale um
            certificado", e vale também para quem já concluiu — a varredura
            emite para a base nos minutos seguintes.
        title:
          type: string
          minLength: 1
          maxLength: 120
          description: O título impresso no alto. Padrão "Certificado de conclusão".
        body:
          type: string
          nullable: true
          maxLength: 600
          description: |
            O texto do meio, com os marcadores `{aluno}`, `{curso}`, `{club}`,
            `{carga_horaria}`, `{data}`, `{codigo}` e `{aulas}`. Nulo imprime o
            texto padrão — o club que não escreve nada continua com uma frase
            correta, em vez de um retângulo vazio.
        hours:
          type: integer
          nullable: true
          minimum: 1
          maximum: 10000
          description: |
            A carga horária IMPRESSA, em horas. É decisão de quem assina, não
            derivação da duração dos vídeos. Nulo imprime sem carga horária.
        suggested_hours:
          type: integer
          minimum: 0
          description: |
            A soma das durações das aulas que contam, em horas, arredondada
            para cima. É sugestão para o campo nascer preenchido; o que vale
            impresso é `hours`.
        signature_media_id:
          type: string
          format: uuid
          nullable: true
          description: A imagem da assinatura, da biblioteca do club.
        signature_url:
          type: string
          nullable: true
          description: Endereço para MOSTRAR a assinatura, assinado e de curta duração.
        signature_name:
          type: string
          nullable: true
          maxLength: 120
          description: Quem assina.
        signature_role:
          type: string
          nullable: true
          maxLength: 120
          description: Em que qualidade assina ("Diretora de ensino").
        issued_count:
          type: integer
          minimum: 0
          description: Quantos certificados este curso já emitiu.
        updated_at:
          type: string
          format: date-time
          nullable: true
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: Campos obrigatórios ausentes ou inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    userSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de quem administra, emitido por
        `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo
        desenho do `studentSession`, para a outra identidade.

        É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
        `studentSession`; uma rota consumida pelos dois declara os dois
        esquemas, e o middleware aceita qualquer um deles. As duas credenciais
        são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
        que cada uma existe.

        O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
        `Authorization` a cada chamada.

````

## Related topics

- [Ver o certificado do curso](/api-reference/certificates/course-get.md)
- [Listar certificados](/api-reference/certificates/list.md)
- [Ver um certificado](/api-reference/certificates/get.md)
- [Reemitir um certificado](/api-reference/certificates/reissue.md)
- [Revogar um certificado](/api-reference/certificates/revoke.md)