Gestiona Tus DatosDocumentación API

Para equipos que integran sus sistemas

Conecta tu sistema con GTD

Prepara sus credenciales, realiza la primera comprobación y consulta el resultado en Conexiones API.

Acceso limitado · Piloto en modo Prueba

La operación disponible comprueba que GTD reconoce tu sistema y permite consultar su propia conexión. El equipo GTD debe admitir a tu organización y habilitar el acceso.

La documentación es pública. Leerla o crear una cuenta no habilita la API. Este piloto utiliza datos ficticios; el acceso de consulta no permite enviar eventos. Las conexiones admitidas expresamente al piloto RAT pueden enviar una actividad ficticia autorizada y actualizar su nombre.

Guía de integración para personas y agentes: prepara el recorrido, distingue permisos efectivos de capacidades previstas y conoce los límites de API y MCP.

Contrato del piloto: 0.1.0-pilot · Revisado el 16 de septiembre de 2026 · Equipo GTD

1. Prepara la conexión

Necesitas una organización admitida al piloto, permiso para administrar sus conexiones y un navegador actualizado. Para ejecutar el ejemplo necesitarás Node.js 20 o posterior en tu equipo o servidor; no requiere instalar paquetes adicionales.

Registra el sistema

  1. Entra a GTD, selecciona tu organización y abre Conexiones API. Si el menú no aparece, consulta al equipo GTD.
  2. Pulsa Conectar sistema, escribe un nombre reconocible —por ejemplo, «CRM de pruebas»— y conserva el uso Prueba.
  3. Pulsa Continuar a permisos. En Consultas incluidas, «Comprobar conexión» es la operación disponible. Las funciones reservadas se indican en pantalla. Si GTD habilitó el piloto RAT para tu organización, también podrás solicitar sus permisos específicos; consulta la guía RAT.
  4. Pulsa Guardar sistema. Quedará registrado y pendiente de habilitación.

Guarda la clave privada y registra la pública

  1. En Prepara la credencial del sistema, pulsa Generar clave para este sistema.
  2. Pulsa Descargar clave privada y guarda gtd-api-clave-privada.json en una ubicación protegida.
  3. Marca Confirmo que guardé el archivo de clave privada y pulsa Registrar clave pública.

La clave se genera en tu navegador. GTD recibe la parte pública; la privada permanece contigo y permite autenticar tu sistema. Descárgala antes de cerrar o recargar la página. GTD no puede recuperar ese archivo por ti. No lo subas a un repositorio ni lo adjuntes a soporte.

Ya tengo un par de claves

Abre Ya tengo una clave pública y pega únicamente la pública en formato JWK: RSA, RS256, de 2048 a 4096 bits, con kty, n, e, kid, use y alg. Conserva la privada correspondiente en tu sistema.

Coordina la habilitación

Cuando aparezca Clave pública registrada, comunica al equipo GTD qué organización y sistema preparaste. Registrar una clave no concede acceso automáticamente.

Continúa cuando veas Lista para comprobar. Abre Datos para configurar tu sistema y copia el Identificador del cliente. Revisa también Autorización de prueba hasta: esa fecha limita el acceso.

Si aparece «GTD debe revisar el registro», pide ayuda. No crees otra conexión para intentar resolver ese estado.

2. Realiza la primera comprobación

Descarga el ejemplo en el equipo que tiene acceso a la clave privada. El archivo se puede revisar antes de ejecutarlo.

Abre una terminal en la carpeta del ejemplo y ejecuta:

node gtd-api-comprobar.mjs --client-id "IDENTIFICADOR_DEL_CLIENTE" --key-file "./gtd-api-clave-privada.json"

Reemplaza IDENTIFICADOR_DEL_CLIENTE por el valor de GTD. Si guardaste la clave en otra carpeta, cambia la ruta de --key-file. No pegues el contenido de la clave en el comando.

El ejemplo firma la autenticación localmente, obtiene un token y realiza una consulta. No envía el archivo privado ni imprime el token. Hace un solo intento, sin reintentos automáticos.

Cómo reconocer el éxito

La terminal muestra "status":"succeeded", la referencia de tu conexión y, cuando está disponible, una referencia de la petición para soporte. El programa termina con código de salida 0.

Vuelve al detalle del sistema en GTD y pulsa Consultar resultado. Debes ver Conexión comprobada, «Tu sistema ya se comunicó con GTD» y la fecha de Última comprobación recibida. Después puedes usar Actualizar.

Consultar resultado no envía una comprobación. Muestra lo que GTD ya recibió. La petición debe salir primero de tu sistema mediante el ejemplo o tu propia integración.

El éxito acredita esa petición. No significa que se hayan enviado datos de negocio ni que exista acceso indefinido.

3. Referencia técnica

Esta sección es para quien implementa la integración. El contrato OpenAPI descargable describe la única operación de consulta habilitada en el piloto.

Autenticación del sistema

Usa OAuth con client_credentials y autenticación private_key_jwt. La clave privada firma una declaración JWT; no se envía al servidor. El ejemplo descargable implementa el flujo completo.

POST · Obtener un token

https://identity.gestionatusdatos.cl/realms/gtd/protocol/openid-connect/token

Envía Content-Type: application/x-www-form-urlencoded y estos campos:

grant_type
client_credentials
client_id
El identificador del cliente mostrado en GTD.
scope
integrations:connection:read
client_assertion_type
urn:ietf:params:oauth:client-assertion-type:jwt-bearer
client_assertion
La declaración JWT firmada con la clave privada correspondiente a ese cliente.
Cómo construir la declaración firmada

Cabecera: alg=RS256, typ=JWT y el kid de tu clave registrada. Cuerpo: iss y sub son tu identificador de cliente; aud es la URL completa del endpoint de token. Usa iat en segundos Unix, exp=iat+60 y un jti único por solicitud, como hace el ejemplo. Mantén el reloj de tu sistema sincronizado.

No confundas esa audiencia con la del token de acceso: su audiencia lógica es https://api.gestionatusdatos.cl, mientras las llamadas del piloto se realizan en https://gestionatusdatos.cl.

En una respuesta correcta utiliza access_token como Bearer y respeta expires_in. Cuando venza, solicita un nuevo token con una nueva declaración firmada. Este flujo no depende de un token de renovación. Obtener un token nuevo no amplía la autorización del piloto.

Consultar la conexión propia

GET /api/v1/integrations/connection

GET https://gestionatusdatos.cl/api/v1/integrations/connection
Authorization: Bearer <access_token>
Accept: application/json

No envíes cuerpo ni identificadores de organización como parámetros. GTD determina la conexión a partir del token. No uses HEAD para esta comprobación.

Ejemplo ilustrativo de una respuesta 200 —las referencias y fechas son ficticias—:

{
  "id": "cn_example0000000001",
  "providerKey": "gtd_api_v1",
  "environment": "test",
  "direction": "inbound",
  "status": "active",
  "health": {
    "state": "unknown",
    "checkedAt": "2026-01-01T00:00:00.000Z"
  },
  "capabilities": []
}

health describe una evaluación de salud registrada; puede indicar unknown aunque esta solicitud sea aceptada. Su fecha no es necesariamente la de tu última petición. Consulta esa última comprobación en GTD.

Las capacidades de capabilities son descriptivas: no habilitan otras rutas. El piloto sólo admite el GET documentado aquí.

Respuestas y límites

Respuestas del endpoint de comprobación
HTTPQué significa y qué hacer
200Comprobación aceptada. Revisa su fecha en GTD.
400Solicitud inválida. Envía un GET sin cuerpo.
401Token ausente, inválido, vencido o con audiencia incorrecta. Revisa la autenticación.
403Permiso insuficiente o conexión no disponible durante la consulta. Revisa el acceso con GTD.
404Dirección, estado, vigencia o habilitación no disponibles para esta solicitud. No identifica por sí solo la causa.
429Límite de solicitudes alcanzado. Respeta Retry-After cuando esté presente y evita reintentos continuos.
5xxError del servicio. Conserva la referencia de la petición y contacta a GTD si persiste.

Las cabeceras RateLimit-Limit, RateLimit-Remaining y RateLimit-Reset, cuando estén presentes, informan la cuota. No asumas una cuota fija. Conserva X-Request-Id para soporte.

Los errores del GET usan error.code, error.message y error.requestId. Clasifica por el código, no por el texto. El endpoint de token pertenece al servicio de identidad y puede devolver un formato de error diferente.

4. Resuelve un error del ejemplo

El ejemplo termina con código de salida 1 cuando falla y muestra uno de estos códigos. Primero conserva el mensaje y revisa el estado de la conexión en GTD.

ARGUMENTS_INVALID · Revisa el comando

Sustituye el identificador de ejemplo por el valor mostrado en GTD. Conserva los argumentos --client-id y --key-file.

KEY_UNREADABLE o KEY_INVALID · Revisa la clave local

Comprueba la ruta, los permisos de lectura y que el archivo sea la clave privada de esa conexión, no la pública. Si la perdiste, contacta a GTD para restablecer el acceso. No envíes la clave a soporte.

TOKEN_REJECTED · No se pudo autenticar el sistema

Revisa que el identificador, la clave y la habilitación correspondan al mismo sistema. Comprueba el reloj de tu equipo. Si GTD muestra que debe revisar el registro, contacta a soporte.

ACCESS_DENIED · El acceso no está autorizado

Revisa si la conexión está suspendida, revocada o fuera de su periodo autorizado. Coordina su continuidad con GTD.

CONNECTION_UNAVAILABLE · La comprobación recibió un 404

Revisa la URL, el estado, la vigencia y la habilitación de la conexión con GTD. Un 404 no prueba por sí solo una caída del servidor ni permite identificar la causa exacta.

RATE_LIMITED · Se alcanzó el límite de solicitudes

Espera antes de ejecutar otra comprobación. Evita reintentos continuos; si se repite, contacta a GTD.

TIMEOUT o NETWORK_ERROR · No se completó la comunicación

Consulta primero el resultado en GTD: la comunicación pudo interrumpirse después de recibir la petición. Revisa la conectividad HTTPS hacia el servicio de identidad y GTD. Si tu hosting bloquea las llamadas, entrega el mensaje a soporte para que podamos diagnosticarlo contigo.

SERVICE_UNAVAILABLE, REQUEST_REJECTED o RESPONSE_INVALID

Consulta el resultado y contacta a GTD con el código recibido. No cambies las claves para intentar resolver un error de comunicación. El ejemplo no reintenta automáticamente.

5. Vigencia, suspensión y revocación

Clave del sistema
Permite firmar la autenticación. Conservarla no prolonga la autorización.
Token de acceso
Tiene una duración corta. Respeta su vencimiento; obtener otro no renueva el periodo del piloto.
Autorización de prueba
Termina en la fecha acordada con GTD, visible en el detalle de la conexión. Coordina su continuidad antes de que venza.

Suspender detiene el acceso y conserva la configuración y el historial. Reanudar preparación, cuando aparece, sólo permite continuar la preparación: no habilita automáticamente la API. Si ya estaba habilitada, coordina la continuidad con GTD.

Revocar retira el acceso de forma definitiva. Para volver a conectar ese sistema necesitarás una conexión nueva y su habilitación.

Un token que aún no vence no garantiza acceso si se suspende o revoca la conexión o termina su autorización. Una comprobación exitosa anterior permanece como dato histórico.

El piloto no ofrece renovación automática del periodo ni rotación de claves por autoservicio.

6. Pide ayuda a GTD

En el detalle del sistema abre Información para soporte. Comparte la referencia de la conexión, su estado de habilitación, el código de error y la fecha y hora del intento. Añade la referencia de la petición cuando esté disponible.

No compartas claves privadas, tokens ni contraseñas. Si envías una captura, oculta esos datos. La documentación pública no contiene las credenciales ni los resultados de tu organización.

Este enlace abre tu aplicación de correo; no envía un mensaje automáticamente. Si no se abre, escribe a contacto@gestionatusdatos.cl desde tu correo habitual.

Dentro de GTD, selecciona tu organización y abre Conexiones API. Si todavía no tienes acceso al piloto, contacta al equipo antes de preparar credenciales.