> ## 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. # Conferir o domínio agora > O botão "já configurei" da tela: antecipa a conferência que o laço faria de hora em hora. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/domain/check 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}/domain/check: parameters: - $ref: '#/components/parameters/OrgId' post: tags: - clubs summary: Confere agora o domínio do club description: | Pergunta ao provedor se o DNS já aponta para nós e devolve o domínio com o estado novo. É o botão "já configurei" da tela: sem ele, quem acabou de publicar o registro esperaria a passada do laço, que é de hora em hora. A conferência também acontece sozinha, e esta rota não é a única fonte da verdade: ela só antecipa o que o laço faria. Exige administrar o club. operationId: checkClubDomain responses: '200': description: O domínio, conferido agora content: application/json: schema: $ref: '#/components/schemas/ClubDomainResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '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: ClubDomainResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ClubDomain' ClubDomain: type: object required: - host - status - records properties: host: type: string description: O endereço, normalizado — minúsculo e sem protocolo. status: $ref: '#/components/schemas/ClubDomainStatus' records: type: array description: | O que precisa estar publicado no DNS do club. No apex é um registro A; abaixo dele, um CNAME. Quando o provedor pede prova de posse — o que só acontece se o domínio já existir na conta de outra plataforma — entra também um TXT, e ele some assim que a prova passa. items: $ref: '#/components/schemas/DnsRecord' detail: type: string description: | O que impede o endereço de servir, na palavra do provedor. Presente só quando há o que consertar. verified_at: type: string format: date-time description: Quando o endereço serviu pela primeira vez. checked_at: type: string format: date-time description: A última vez que perguntamos ao provedor. 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 ClubDomainStatus: type: string description: | `pending`: registrado, esperando o DNS do club apontar. `active`: servindo. `misconfigured`: já serviu e parou — o DNS deixou de apontar para cá. enum: - pending - active - misconfigured DnsRecord: type: object required: - type - name - value properties: type: type: string description: A (apex), CNAME (subdomínio) ou TXT (prova de posse). enum: - A - CNAME - TXT name: type: string description: | O nome do registro como se digita no painel de DNS: `@` para o apex, o rótulo (`cursos`) abaixo dele. value: type: string description: Para onde ele aponta. 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' 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 - [Webhooks de saída](/essentials/webhooks.md) - [Os certificados do aluno](/api-reference/classroom/certificates-list.md) - [Verificar um certificado](/api-reference/certificates/verify.md) - [Agente do aluno](/api-reference/agents/classroom-get.md) - [Página do curso](/api-reference/classroom/courses-get.md)