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

# Gerar link de conexão

> Gera o link que o cliente abre para conectar o número do WhatsApp ao canal.

Um canal criado pela API nasce sem número. Esta chamada gera o link que o cliente abre para conectar o WhatsApp dele ao canal.

## Como usar o link

Gere o link no seu servidor e abra a `url` no navegador do cliente, em uma janela nova:

```js theme={null}
const janela = window.open(url, 'datafy-conexao', 'width=600,height=760')
```

![Janela de conexão aberta para o cliente, com a marca do parceiro e o botão para conectar o WhatsApp.](https://mintcdn.com/datafy/xMSqz7XW7-vSVQEx/images/administracao/janela-de-conexao.webp?fit=max\&auto=format\&n=xMSqz7XW7-vSVQEx\&q=85\&s=b2b2babd8522012c58d45ebd7861e974)

> [!NOTE]
>
> A janela de conexão pode levar a sua marca. No [painel da Datafy](https://app.datafyapi.com.br/conta), na aba **Parceiros**, é possível definir o logotipo, o nome da empresa e a cor do fundo.

> [!WARNING]
>
> Gere o link a partir do seu servidor. O token de conta dá acesso a todos os canais e não deve ser exposto no navegador.

## Resultado da conexão

Ao terminar, a janela envia uma mensagem para a página que a abriu, já com os dados da conexão:

```js theme={null}
window.addEventListener('message', (evento) => {
  if (evento.origin !== 'https://app.datafyapi.com.br') return
  if (evento.data?.source !== 'datafy') return

  if (evento.data.event === 'connected') {
    const { phone_number_id, waba_id, business_id, coexistence } = evento.data.data
    // canal conectado
  }

  if (evento.data.event === 'error') {
    // evento.data.message traz o motivo
  }
})
```

| Evento | Conteúdo |
| - | - |
| `connected` | `data` com `phone_number_id`, `waba_id`, `business_id` e `coexistence` |
| `error` | `message` com o motivo da falha |

O campo `coexistence` indica que o número foi conectado mantendo o aplicativo do WhatsApp Business em uso.

Depois do sucesso, a janela se fecha sozinha. Em caso de erro ela permanece aberta, para o cliente tentar de novo.

> [!NOTE]
>
> Os dados da mensagem já bastam para registrar a conexão. Use [Consultar canal](https://developers.datafyapi.com.br/api-reference/administracao/consultar-canal.md) quando precisar dos demais campos, como o número exibido e os webhooks, ou para confirmar a conexão mais tarde.

## Validade

O link vale **24 horas** e é de **uso único**: ele deixa de funcionar assim que a conexão é concluída. Para conectar de novo, gere um link novo.

## Resposta

| Campo | Descrição |
| - | - |
| `url` | Endereço da página de conexão, para abrir no navegador do cliente |
| `token` | Token do link, já incluído na `url` |
| `expires_in` | Validade do link, em segundos |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json POST /channels/whatsapp/{id}/connect-link
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/whatsapp/{id}/connect-link:
    post:
      summary: Gerar link de conexão
      description: >-
        Gera o link que o cliente abre para conectar o número do WhatsApp ao
        canal.
      operationId: gerarLinkDeConexao
      parameters:
        - $ref: '#/components/parameters/CanalId'
      responses:
        '200':
          description: Link de conexão gerado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    description: >-
                      Endereço da página de conexão, para abrir no navegador do
                      cliente.
                  token:
                    type: string
                    description: Token do link, já incluído na `url`.
                  expires_in:
                    type: integer
                    description: Validade do link, em segundos.
              example:
                url: >-
                  https://app.datafyapi.com.br/c/ct_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f
                token: ct_1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f
                expires_in: 86400
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
        '404':
          $ref: '#/components/responses/CanalNaoEncontrado'
        '409':
          description: O canal não pode receber uma conexão agora.
          content:
            application/json:
              examples:
                ja_conectado:
                  summary: Canal já conectado
                  value:
                    statusCode: 409
                    message: >-
                      Canal já conectado. Desconecte ou delete o canal antes de
                      conectar outro número.
                teste_expirado:
                  summary: Período de teste do canal expirou
                  value:
                    statusCode: 409
                    message: >-
                      O período de teste deste canal expirou. Assine o canal
                      para conectar.
components:
  parameters:
    CanalId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do canal, retornado em Listar canais e em Criar canal.
  responses:
    NaoAutorizado:
      description: Token de conta ausente ou inválido.
      content:
        application/json:
          example:
            statusCode: 401
            message: Token de conta ausente ou inválido
    AssinaturaInativa:
      description: A assinatura da conta não está ativa.
      content:
        application/json:
          example:
            statusCode: 403
            message: >-
              Sua assinatura precisa estar ativa para usar a API. Acesse o
              painel para ativá-la.
    CanalNaoEncontrado:
      description: Canal inexistente ou de outra conta.
      content:
        application/json:
          example:
            statusCode: 404
            message: Canal não encontrado
  securitySchemes:
    tokenDeConta:
      type: http
      scheme: bearer
      description: >-
        Token de conta gerado no painel da Datafy, em Perfil. Formato:
        `sk_acct_xxx`. Diferente do token de canal (`sk_live_`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.