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

# Dar acesso

> Matricula o aluno na entrega, com origem `manual` — a mesma concessão do
painel. Se ele já tem acesso ativo a ela, não nasce outra matrícula: a
que existe recebe o prazo novo.

Conflitos: `student_anonymized` (o aluno foi removido).




## OpenAPI

````yaml POST /v1/enrollments
openapi: 3.0.3
info:
  title: weve API
  description: >
    Integrações da Weve para quem tem um club: o servidor MCP, o webhook de
    venda

    que a sua plataforma manda e os webhooks de saída que o club manda para o
    seu sistema.
  version: 0.2.0
servers:
  - url: https://api.useweve.com
    description: produção
security: []
tags:
  - name: api
paths:
  /v1/enrollments:
    post:
      tags:
        - api
      summary: Dá acesso a uma entrega
      description: |
        Matricula o aluno na entrega, com origem `manual` — a mesma concessão do
        painel. Se ele já tem acesso ativo a ela, não nasce outra matrícula: a
        que existe recebe o prazo novo.

        Conflitos: `student_anonymized` (o aluno foi removido).
      operationId: createApiEnrollment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiEnrollmentCreate'
      responses:
        '201':
          description: A matrícula
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiEnrollmentResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/ApiKeyUnauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/ApiKeyForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/ApiKeyTooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - apiKey: []
components:
  schemas:
    ApiEnrollmentCreate:
      type: object
      required:
        - student_id
        - delivery_id
      properties:
        student_id:
          type: string
          format: uuid
        delivery_id:
          type: string
          format: uuid
        cohort_id:
          type: string
          format: uuid
          nullable: true
          description: >
            A turma. Ausente é a turma que estiver matriculando agora, se
            houver;

            `null` é nenhuma turma.
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: |
            Até quando vale. Ausente é o prazo padrão (o da turma ou o da
            entrega); `null` é vitalício. Uma data precisa estar no futuro.
        reason:
          type: string
          maxLength: 500
          description: Fica no histórico de acesso do aluno.
    ApiEnrollmentResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/WebhookEnrollment'
    WebhookEnrollment:
      type: object
      required:
        - id
        - status
        - source
        - student
        - delivery
        - cohort
        - product
        - purchase_id
        - subscription_id
        - starts_at
        - expires_at
        - revoked_at
        - revoke_reason
      description: A matrícula — o direito de um aluno a uma entrega — como está agora.
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/WebhookEnrollmentStatus'
        source:
          $ref: '#/components/schemas/EnrollmentSource'
        student:
          $ref: '#/components/schemas/WebhookStudent'
        delivery:
          $ref: '#/components/schemas/WebhookNamedRef'
        cohort:
          allOf:
            - $ref: '#/components/schemas/WebhookNamedRef'
          nullable: true
        product:
          allOf:
            - $ref: '#/components/schemas/WebhookNamedRef'
          nullable: true
          description: O produto da compra ou da assinatura que abriu a matrícula.
        purchase_id:
          type: string
          format: uuid
          nullable: true
        subscription_id:
          type: string
          format: uuid
          nullable: true
        starts_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: Nulo é vitalício.
        revoked_at:
          type: string
          format: date-time
          nullable: true
        revoke_reason:
          type: string
          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
    WebhookEnrollmentStatus:
      type: string
      enum:
        - active
        - expired
        - revoked
    EnrollmentSource:
      type: string
      enum:
        - purchase
        - subscription
        - manual
        - invitation
        - import
        - open_access
        - registration_link
    WebhookStudent:
      type: object
      required:
        - id
        - name
        - email
        - created_at
      description: >
        O aluno, como está no momento em que o evento é montado — segundos
        depois

        do fato. O documento (CPF) não sai em evento nenhum.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type: string
          format: email
        created_at:
          type: string
          format: date-time
    WebhookNamedRef:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ApiKeyUnauthorized:
      description: Chave ausente, inválida, vencida ou revogada (`unauthorized`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    PaymentRequired:
      description: >
        O plano do club não cobre o pedido. `feature_not_in_plan` é o club não
        ter o

        recurso (falta contratar); `limit_reached` é a franquia de um recurso
        que não

        cobra excedente ter acabado. A `message` diz de qual recurso se trata.

        `payment_failed` é o cartão recusado ao contratar um adicional.


        Nas rotas de quem NÃO administra o club (cadastro, conversa com o
        agente) o

        `code` é o mesmo, e a `message` é dita a essa pessoa — sem falar do
        plano,

        que é conversa do club com a weve.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ApiKeyForbidden:
      description: |
        A chave vale, mas não alcança o pedido: falta o escopo `write`
        (`insufficient_scope`), quem a criou não administra o club
        (`forbidden`), ou o club desligou o acesso por chave
        (`agent_access_disabled`, `agent_access_admins_only`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Conflict:
      description: >-
        Conflito com o estado atual. O `code` diz qual; a descrição da operação
        lista os possíveis.
      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'
    ApiKeyTooManyRequests:
      description: Teto de requisições atingido (`rate_limited`); espere o `Retry-After`
      headers:
        Retry-After:
          schema:
            type: integer
      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:
    apiKey:
      type: http
      scheme: bearer
      description: >
        A chave de API do club (`weve_sk_…`), criada em **Ajustes › Chaves de
        API**.

        Vale para UM club, age em nome de quem a criou e com o papel dessa

        pessoa. O escopo `read` libera as leituras; `write`, o resto.

````