Testar uma credencial
Testa a credencial de um servidor (CRM, Chatwoot, e-mail ou WhatsApp) antes de gravá-la num agente; nada é gravado. Um destino que não é um servidor público é recusado com 422 no campo dele. A recusa do sistema do outro lado é a resposta (ok falso, com o motivo). O teste de e-mail envia uma mensagem real ao próprio smtp_user.
Autorização
bearer tools:executeCredencial da v3: o JWT da sessão (o mesmo da v2) ou um token pessoal dom_pat_…. A lista de escopos de cada operação diz o que ela exige: uma capacidade (agents:read), authenticated ou session-only. Segredo de máquina (X-Agent-Secret, X-API-Token, sdk_…) não é aceito.
Em: header
Escopo: tools:execute
Parâmetros de cabeçalho
Chave opcional de 1 a 255 caracteres ASCII visíveis; quando enviada, vale o mesmo contrato da §8.
Corpo da requisição
application/json
Definições TypeScript
Use o tipo request body no TypeScript.
A credencial a testar, pelo provedor. Nada é gravado.
Login no Vtiger.
Corpo da resposta
application/json
application/json
curl -X POST "https://example.com/connection-tests" \ -H "Idempotency-Key: b3f0c1e2-4a5b-4c6d-8e9f-0a1b2c3d4e5f" \ -H "Content-Type: application/json" \ -d '{ "provider": "crm", "vtiger_access_key": "string", "vtiger_url": "string", "vtiger_username": "string" }'{ "account_id": 0, "display_phone_number": "string", "inboxes": [ { "channel_type": "string", "id": 0, "name": "string" } ], "message": "string", "ok": true, "provider": "crm", "recipient": "string", "templates": [ { "body_text": "string", "body_variable_names": [ "string" ], "body_variables": 0, "category": "string", "header_variable_names": [ "string" ], "header_variables": 0, "language": "string", "name": "string", "sendable": true, "status": "approved", "status_label": "string", "unsupported_reason": "string" } ], "verified_name": "string", "vtiger_url": "string", "vtiger_username": "string"}