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

# Entrar no classroom

> Abre a sessão do aluno e devolve o token opaco. E-mail desconhecido, senha errada e e-mail não confirmado respondem igual.



## OpenAPI

````yaml POST /v1/auth/sign-in
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/sign-in:
    post:
      tags:
        - auth
      summary: Abre uma sessão de aluno
      description: |
        Devolve o token opaco da sessão. Ele é a credencial do classroom: vai no
        `Authorization: Bearer`, e o BFF do classroom o guarda em cookie
        **host-only** — um cookie de domínio o mandaria para os outros clubs.

        E-mail desconhecido, senha errada e e-mail ainda não confirmado
        respondem a MESMA coisa (401 `invalid_credentials`), e no mesmo tempo:
        distinguir os casos diria a quem tenta se aquele endereço estuda ali.
      operationId: studentSignIn
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StudentSignIn'
      responses:
        '200':
          description: Sessão aberta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudentSessionResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/RateLimitUnavailable'
components:
  schemas:
    StudentSignIn:
      type: object
      required:
        - club
        - email
        - password
      properties:
        club:
          $ref: '#/components/schemas/ClubSlug'
        email:
          type: string
          format: email
          maxLength: 320
        password:
          type: string
          maxLength: 1024
    StudentSessionResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/StudentSession'
    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.
    StudentSession:
      type: object
      required:
        - token
        - expires_at
        - student
      properties:
        token:
          type: string
          description: |
            A credencial da sessão, opaca. Vai no `Authorization: Bearer`.

            Só aparece AQUI, na resposta que a cria: o que fica guardado do
            nosso lado é o SHA-256 dela, então nem nós conseguimos devolvê-la
            depois. Perdida, abre-se outra.
        expires_at:
          type: string
          format: date-time
        student:
          $ref: '#/components/schemas/Student'
    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
    Student:
      type: object
      description: >-
        Um aluno do classroom. Identidade nossa, sem relação com o `Contact` do
        provedor que autentica o dashboard.
      required:
        - id
        - name
        - email
        - verified
        - club_slug
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        email:
          type: string
          format: email
        verified:
          type: boolean
          description: O e-mail foi provado pela caixa de entrada.
        club_slug:
          type: string
          description: |
            O club a que esta conta pertence — o subdomínio do classroom dele.

            Vem aqui porque a conta de aluno é DO CLUB, e quem guarda a sessão
            precisa conferir que ela é do endereço em que foi servida: o BFF do
            classroom recusa gravar o cookie de um club no host de outro. É a
            única forma de o classroom saber o club da sessão, já que o id do
            club não sai pela vitrine.
  responses:
    BadRequest:
      description: Requisição malformada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      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'
    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

- [Entrar](/api-reference/account/sign-in.md)
- [Convidar](/api-reference/clubs/invite.md)
- [Primeira chamada](/quickstart.md)
- [Acesso ao classroom](/api-reference/clubs/classroom-session.md)
- [Marcar progresso](/api-reference/classroom/lessons-progress.md)