> ## 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.

# Cadastro por link

> Cria a conta e abre as entregas do link.



## OpenAPI

````yaml POST /v1/auth/register-by-link
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: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: students
  - name: auth
paths:
  /v1/auth/register-by-link:
    post:
      tags:
        - auth
      summary: Cadastra um aluno por um link de cadastro
      description: |
        O `POST /v1/auth/sign-up` com um código: cria a conta (ou encontra
        a que já existe com aquele e-mail no club) e abre as entregas do
        link, com origem `registration_link`. A resposta é 202 nos dois
        casos, e a caixa de entrada recebe o que cabe: o link de confirmação
        para a conta nova, o aviso de "você já tem conta" para a existente.
        Conta nova ainda não vale até confirmar o e-mail, como no cadastro.

        Link desligado ou inexistente responde 404.
      operationId: registerByLink
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterByLink'
      responses:
        '202':
          $ref: '#/components/responses/AuthAccepted'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '501':
          $ref: '#/components/responses/NotConfigured'
        '503':
          $ref: '#/components/responses/RateLimitUnavailable'
components:
  schemas:
    RegisterByLink:
      type: object
      required:
        - club
        - code
        - name
        - email
        - password
      properties:
        club:
          $ref: '#/components/schemas/ClubSlug'
        code:
          type: string
          minLength: 1
          maxLength: 64
        name:
          type: string
          minLength: 1
          maxLength: 200
        email:
          type: string
          format: email
          maxLength: 320
        password:
          type: string
          minLength: 8
          maxLength: 200
    ClubSlug:
      type: string
      minLength: 1
      maxLength: 63
      description: |
        O `slug` do club — o mesmo do subdomínio em que o classroom atende. O
        cliente o lê do próprio hostname; não há id nem sessão a essa altura.

        Club inexistente responde 404, e isso é público de qualquer forma: o
        endereço ou atende ou não atende.
    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:
    AuthAccepted:
      description: |
        Pedido aceito. A resposta é a mesma exista ou não a conta — o que
        acontece a seguir chega pela caixa de entrada, não por aqui.
    BadRequest:
      description: Requisição malformada
      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'
    TooManyRequests:
      description: Teto por IP atingido
      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'
    NotConfigured:
      description: |
        O ambiente não tem o que a operação precisa (`not_configured`): o
        provedor de autenticação nas rotas de sessão, o e-mail nas que
        enviam link, a chave de cifra nos webhooks.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimitUnavailable:
      description: |
        O contador de taxa está inalcançável e esta rota falha FECHADA
        (`rate_limit_unavailable`). Tente de novo em instantes.
      headers:
        Retry-After:
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'

````

## Related topics

- [Links de cadastro](/api-reference/registration-links/list.md)
- [Criar link de cadastro](/api-reference/registration-links/create.md)
- [Alterar link de cadastro](/api-reference/registration-links/update.md)
- [Vitrine do link de cadastro](/api-reference/auth/registration-link.md)
- [Trocar o código](/api-reference/registration-links/rotate.md)