Pular para o conteúdo
MyClinicAPI Docs
POST

/v1/integrations/{id}/connection

Conectar integração

Responde 202 com status "conectando". Para OAuth, a plataforma devolve a URL de autorização em next.url (redirecione o usuário). Para API key/SMTP/WhatsApp as credenciais vão direto para o cofre de credenciais. A confirmação chega depois em POST /integrations/{id}/connection/confirm. Integração "em breve" (hoje, todas exceto whatsapp e google-calendar) responde 409 integration_unavailable.

E-mail verificado: quando a verificação de e-mail está ligada no ambiente, contas com e-mail ainda não confirmado recebem 403 email_not_verified.

Permissão:integrations:manageDispara:integration.connect_requested

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de caminho

  • idstringObrigatório

    integration_id do catálogo (whatsapp, google-calendar, smtp…). · Padrão (regex): ^[a-z0-9-]{2,64}$

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Corpo da requisição

application/json · obrigatório

  • scopesstring[]Obrigatório

    Escopos autorizados (os obrigatórios do catálogo precisam estar presentes). · Até 30 itens · Cada item: até 64 caracteres

  • syncModestringOpcional

    Valores: Tempo real (recomendado), A cada 15 minutos, A cada hora, Manual

  • calendarsobject[]Opcional

    Calendários a sincronizar (Google Calendar). Gravados em config.calendars; no máximo um isDefault (se nenhum, o primeiro ativo vira o padrão). · Até 50 itens

  • idstringObrigatório
    calendars[].id

    Até 128 caracteres

  • namestringObrigatório
    calendars[].name

    Até 128 caracteres

  • descriptionstringOpcional
    calendars[].description

    Até 255 caracteres

  • enabledbooleanObrigatório
    calendars[].enabled
  • isDefaultbooleanOpcional
    calendars[].isDefault
  • credentialsobjectOpcional

    WRITE-ONLY. Repassado ao cofre de credenciais da plataforma e descartado — nunca gravado, logado, auditado ou devolvido.

  • apiKeystringOpcional
    credentials.apiKey

    Até 500 caracteres

  • smtpHoststringOpcional
    credentials.smtpHost

    Até 255 caracteres

  • smtpPortintegerOpcional
    credentials.smtpPort

    Entre 1 e 65535

  • smtpUserstringOpcional
    credentials.smtpUser

    Até 255 caracteres

  • smtpPasswordstringOpcional
    credentials.smtpPassword

    Até 500 caracteres

  • senderEmailstring (e-mail)Opcional
    credentials.senderEmail
  • phoneNumberstringOpcional
    credentials.phoneNumber

    Até 32 caracteres

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/integrations/<id>/connection", {  method: "POST",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "scopes": [      "<scope>"    ],    "syncMode": "Tempo real (recomendado)",    "calendars": [      {        "id": "<id>",        "name": "<name>",        "enabled": true      }    ],    "credentials": {      "apiKey": "<apiKey>",      "smtpHost": "<smtpHost>",      "smtpPort": 1    }  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

202Accepted — Sucesso.
JSON
{  "data": {    "integration": {      "id": "<id>",      "name": "<name>",      "summary": "<summary>",      "description": "<description>",      "category": "<category>",      "availability": "disponivel",      "auth": "oauth",      "provider": "<provider>",      "benefits": [        "<benefit>"      ],      "status": "ativa",      "connection": {        "status": "conectando",        "account": "<account>",        "connectedAt": "2026-09-18T14:00:00.000Z",        "connectedBy": "<connectedBy>",        "lastActivityAt": "2026-09-18T14:00:00.000Z",        "lastHealthcheckAt": "2026-09-18T14:00:00.000Z",        "lastErrorCode": "<lastErrorCode>"      }    },    "next": {      "type": "oauth_redirect",      "url": "<url>"    }  },  "meta": {    "webhooks": [      {        "event": "appointment.cancelled",        "status": "sent"      }    ]  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)