> ## 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. # Importar alunos > Cria as contas que faltam, manda o link de acesso e abre as entregas. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/students/import 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/clubs/{clubId}/students/import: parameters: - $ref: '#/components/parameters/OrgId' post: tags: - students summary: Importa alunos em lote description: | Até 500 pessoas por chamada, com as entregas a abrir. Quem não tem conta ganha uma, sem senha, e recebe o link de "defina a sua senha" — o mesmo caminho da compra. Quem já tem conta só ganha as entregas, com origem `import`. A turma segue a regra da concessão: ausente é a que estiver matriculando, nulo é nenhuma, id é aquela — e o id precisa ser de uma das entregas da lista. Uma transação só: linha inválida (nome ou e-mail vazio) responde 422 com o índice, e nada é gravado. Exige permissão de administração do club e o mailer configurado. operationId: importStudents requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StudentsImport' responses: '200': description: O que a importação fez content: application/json: schema: $ref: '#/components/schemas/ImportResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '501': $ref: '#/components/responses/NotConfigured' 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 schemas: StudentsImport: type: object required: - students properties: students: type: array minItems: 1 maxItems: 500 items: $ref: '#/components/schemas/StudentImportRow' delivery_ids: type: array items: type: string format: uuid cohort_id: type: string format: uuid nullable: true description: >- Precisa ser turma de uma das entregas da lista; vale para aquela entrega. expires_at: type: string format: date-time ImportResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ImportResult' StudentImportRow: type: object required: - name - email properties: name: type: string minLength: 1 maxLength: 200 email: type: string format: email maxLength: 320 ImportResult: type: object required: - created - existing - enrollments_granted properties: created: type: integer existing: type: integer enrollments_granted: type: integer 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: 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' 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' 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' 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' 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 - [Ler aluno](/api-reference/students/get.md) - [Listar alunos](/api-reference/students/list.md) - [Convidar aluno](/api-reference/students/invite.md) - [Remover aluno](/api-reference/students/anonymize.md) - [Corrigir aluno](/api-reference/students/update.md)