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

> ## Agent Instructions
> A GYRA+ tem um servidor MCP oficial: https://mcp.gyramais.com.br/mcp. A autenticação é o login do próprio usuário na plataforma, não uma credencial separada. Instalação em https://developers.gyramais.com.br/mcp/instalacao.
> Prefira as tools do MCP a montar chamadas HTTP na mão quando o usuário já tem o conector ligado.
> Para analisar crédito de um CNPJ ou CPF, use create_report_v2 e assine um webhook em vez de fazer polling.
> Para ler um documento (contrato social, comprovante de residência, imposto de renda, balanço), use validate_document: a entrada é um arquivo só e a plataforma reconhece o tipo sozinha.
> Para pedir documentos ao cliente final, use create_collection com o slug de um modelo obtido em list_collection_templates.
> Documento (CNPJ/CPF) é dado pessoal: não o repita em log nem o envie a serviços de terceiros.

# Integrações no toolbox

> Conectar as contas Clicksign e BNDES Online da sua instituição, ligar o HubSpot ao módulo de Propostas e cadastrar as conexões de API que a esteira usa para chamar o seu sistema.

Em **Configurações > Integrações** ficam as contas e conexões que a GYRA+ usa para falar com o mundo de fora: a Clicksign, o BNDES Online, o seu CRM e as APIs do seu sistema.

<Info>
  **Resumo:** a tela tem três áreas. **Conectores** são as integrações nativas de formalização (Clicksign e BNDES Online), cada uma com uma ou mais contas e uma padrão. **CRM** traz o HubSpot, que transforma negócios do funil em propostas. **Conexões de API** são os endereços do seu sistema que a etapa [Chamada de API](/esteiras/chamada-de-api) chama. Chaves e tokens ficam cifrados e nunca voltam para a tela.
</Info>

## Quem vê o quê

| Área | Quem vê |
| - | - |
| Conector **Clicksign** | Organizações com o conector Clicksign liberado |
| Conector **BNDES Online** | Organizações com o conector BNDES Online liberado |
| **CRM** (HubSpot) | Quem tem a permissão de gerenciar configurações, em organizações com o módulo de Propostas |
| **Conexões de API** | Quem tem a permissão de gerenciar configurações. Não depende de módulo contratado |

Sem nenhum conector liberado, a área mostra "Nenhum conector contratado". Veja [Módulos e capacidades](/plataforma/modulos-e-capacidades).

## Conectores

Cada conector aparece como um cartão com **Conectar** (sem conta ainda) ou **Gerenciar**. Cada conector pode ter várias contas, e a esteira usa a padrão, a menos que a etapa escolha outra.

### A página do conector

A tabela lista as contas com **Conta**, **Ambiente**, **Último teste** e **Situação**. A conta padrão leva o selo **Padrão**.

| Ação | O que faz |
| - | - |
| **Adicionar conta** | Abre o formulário da conta |
| **Testar conexão** | Confere a conta direto no provedor e registra o horário do teste |
| **Definir como padrão** | Faz desta a conta usada pela esteira |
| **Editar** | Troca nome, ambiente ou chaves |
| **Desabilitar** / **Reativar** | Tira a conta de uso ou traz de volta |

| Situação da conta | O que significa |
| - | - |
| **Não conectada** | O conector ainda não tem conta |
| **Conectada** | A conta está habilitada e o último teste passou |
| **Falha na conexão** | O último teste falhou |
| **Desligada** | Conta desabilitada |
| **Recebendo avisos** | Clicksign: o aviso de assinatura está cadastrado na sua conta |
| **Sem avisos de assinatura** | Clicksign: o aviso não está cadastrado. A esteira não fica sabendo quando as partes assinam |

### Clicksign

| Campo | O que informar |
| - | - |
| **Ambiente** | Sandbox ou Produção |
| **Nome da conta** | Um nome para reconhecer a conta |
| **Token de acesso** | Gerado em **Configurações > API** na sua conta Clicksign |

Ao salvar, a plataforma testa a conta e cadastra sozinha o aviso de assinatura na sua Clicksign. É por ele que a esteira fica sabendo quando todas as partes assinaram. Com envelopes em andamento, o token e o ambiente não podem ser trocados. Veja [Clicksign](/formalizacao/clicksign).

### BNDES Online

| Campo | O que informar |
| - | - |
| **Ambiente** | Homologação (padrão) ou Produção |
| **Nome da conta** | Um nome para reconhecer a conta |
| **CNPJ do agente financeiro** | O CNPJ da sua instituição no BNDES, com 14 dígitos |
| **Como autenticar** | **Chave de API (recomendado)**, com **Consumer key** e **Consumer secret**; ou **Certificado e-CNPJ**, com **Arquivo do certificado A1 (.pfx)** e **Senha do certificado** |

Em produção, o BNDES só recebe pedidos em dias úteis, das 8h às 20h. Fora disso, a esteira agenda o envio para a próxima janela. Veja [BNDES](/formalizacao/bndes).

### Quando a conta some da etapa

A esteira confere, ao ser ativada, se a conta escolhida em cada etapa ainda existe e está habilitada:

* "A conta X escolhida na etapa ... não existe mais ou não é desta organização. ..."
* "... está desabilitada. Reative-a em Configurações > Integrações ou escolha outra conta."

## CRM

A área **CRM** traz o cartão do HubSpot: o negócio que entra num estágio do funil vira proposta, e a decisão volta para o negócio. O cartão mostra a situação da integração (por exemplo, **Ativa · sincronizou há 12 min** ou **Pausada · o HubSpot recusou o token**) e o botão **Conectar** ou **Gerenciar**.

A página do HubSpot tem quatro partes:

| Cartão | O que você configura |
| - | - |
| **Conta** | O token do app privado do HubSpot, testado antes de salvar |
| **Regras** | Funil, estágio gatilho, **Relatório** ou **Esteira** (um destino para CNPJ e outro para CPF) e o produto |
| **Campos da proposta** | De que campo do negócio ou da empresa associada vem o CPF ou CNPJ, o contato, o valor, o prazo e o produto |
| **Sincronização** | A frequência, o horário comercial e se a decisão move o negócio de estágio |

O passo a passo, os campos que voltam para o negócio e as mensagens de erro estão em [HubSpot](/propostas/hubspot).

## Conexões de API

Uma conexão de API guarda o endereço e a autenticação de um sistema seu. A etapa **Chamada de API** escolhe a conexão e define só o caminho, o método, o corpo e as saídas. Não existe conexão padrão: a etapa sempre escolhe.

### Crie uma conexão

<Steps>
  <Step title="Nova conexão de API">
    Informe **Nome da conexão** (ex.: "ERP · limites") e **URL base**. A URL base é fixa: a esteira só escolhe o caminho depois dela.
  </Step>

  <Step title="Autenticação">
    Escolha o tipo e preencha os campos dele (tabela abaixo). Se precisar, adicione headers fixos.
  </Step>

  <Step title="Teste">
    Em **Caminho de teste (GET)**, informe um caminho que responda, como `/health`. Ele é chamado ao salvar para confirmar que a conexão responde. É opcional.
  </Step>

  <Step title="Testar e criar">
    A plataforma chama a sua API e salva a conexão.
  </Step>
</Steps>

| Autenticação | O que pede |
| - | - |
| **Nenhuma** | Nada |
| **Bearer** | Token |
| **Basic** | Usuário e senha |
| **Chave de API** | A chave e onde ela vai: header ou query, com o nome |
| **OAuth2** (client credentials) | URL do token, Client ID, Client secret, escopo e audience opcionais, e como o secret vai ao servidor do token |
| **mTLS** | Certificado do cliente (.pfx) e senha |
| **HMAC** | Segredo, algoritmo (HMAC SHA-256 ou SHA-512), o que é assinado (só o corpo, ou método, caminho, corpo e horário), header da assinatura e header do horário |

Por segurança, os segredos guardados não aparecem de novo. Para trocar, digite o novo.

### Proteções sempre ligadas

* Só `https://`. Chamada sem criptografia não sai da plataforma.
* Redirecionamentos são seguidos. Para outro endereço (protocolo, host ou porta diferentes), a autenticação e os headers da conexão não vão junto.
* A resposta pode ter até 2 MB.
* A URL base não leva query nem `#`: parâmetros vão na etapa da esteira.
* Usuário e senha não vão na URL: use o tipo de autenticação.

### A lista de conexões

A tabela mostra **Nome**, **URL base**, **Autenticação**, **Último teste** e **Situação** (**Conectada**, **Falha no teste**, **Não testada** ou **Desligada**), com as ações **Testar conexão**, **Editar** e **Remover**.

O que a etapa faz com a resposta (saídas, `api.<apelido>`, tempo limite, erros) está em [Chamada de API](/esteiras/chamada-de-api).

## Veja também

* [Clicksign](/formalizacao/clicksign)
* [BNDES](/formalizacao/bndes)
* [HubSpot](/propostas/hubspot)
* [Chamada de API](/esteiras/chamada-de-api)
* [Webhooks e API keys](/toolbox/webhooks-e-api-keys)


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