> For the complete documentation index, see [llms.txt](https://centraldeajuda.tradeinsights.com/bem-vindo-a-trade-insights/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://centraldeajuda.tradeinsights.com/bem-vindo-a-trade-insights/controle/integracoes/como-integrar-api-a-plataforma-insights.md).

# Como integrar API a plataforma Insights

### 🔧 O que é a API da Trade Insights?

A **API da Trade Insights** permite que você conecte seu sistema (como uma plataforma própria, CRM, gateway de pagamento, etc.) à nossa infraestrutura. Com ela, é possível:

* Criar e remover usuários em planos (subscrições)
* Consultar membros ativos
* Controlar o acesso a conteúdos
* Automatizar fluxos de ativação e cancelamento de planos
* Realizar integrações via SSO
* Receber dados em tempo real via Webhook

***

### 1- Ativação de usuário em plano.

**📌 Quando usar:**\
Use esta chamada quando quiser adicionar um novo usuário a um **plano com link gratuito**, diretamente a partir do seu sistema (ex: após um cadastro).

**🔧 Método HTTP:** `POST`\
**🔗 Endpoint:**

[https://suamarca.tradeinsights.com/api/link/{unique\_id\_do\_plano}/member-activate?api\_token={token\_api\_da\_empresa}](https://suamarca.tradeinsights.com/api/link/%7Bunique_id_do_plano%7D/member-activate?api_token={token_api_da_empresa})

📥 Corpo da requisição (`JSON`):

{

  "full\_name": "Maria Souza",

&#x20; "email": "<maria.souza@example.com>",

&#x20; "phone": "0987654321",

&#x20; "cpf": "98765432100",

&#x20; "send\_welcome\_email": true

}

<br>

📌 Detalhe importante: Essa chamada **funciona apenas para planos com link gratuito.**

### 2- Desativação de usuário em plano.

**📌 Quando usar:**\
Quando um usuário **deixar de ser cliente**, ou você quiser revogar o acesso a um plano específico.

**🔧 Método HTTP:** `DELETE`\
**🔗 Endpoint:**

[https://suamarca.tradeinsights.com/api/link/{unique\_id\_do\_plano}/member-deactivate?api\_token={token\_api\_da\_empresa}](https://suamarca.tradeinsights.com/api/link/%7Bunique_id_do_plano%7D/member-deactivate?api_token={token_api_da_empresa})

<br>

Você pode desativar o usuário de duas formas:

<br>

1\. 🔍 Informando o **E-mail:**

{

&#x20; "type": "email",

&#x20; "email": "<maria.souza@example.com>",

&#x20; "cpf": null

}

\
2\. 🔍 Informando o **CPF**:

{

&#x20; "type": "cpf",

&#x20; "email": null,

&#x20; "cpf": "98765432100"

}

📌 Detalhe importante: Essa chamada **funciona para qualquer tipo de link** (gratuito ou pago).