Connect
API REST

Crear un enlace de conexión o recuperar una solicitud puntual

La variante general usa el permiso de conexiones.enlace.crear; collection usa el de sii.carpeta_tributaria.generar y requiere piloto habilitado. En colección, la misma clave y cuerpo recuperan la solicitud del mismo actor y organización. Mientras espera autorización conserva la URL válida; después devuelve collection_status e identificadores sin URL. El HTTP 201 se conserva en ambos casos. status describe la sesión cuando aparece; collection_status describe la solicitud.

POST
/v1/connect_sessions

Authorization

AuthorizationBearer <token>

API key de la organización, en 'Authorization: Bearer connect_sk_…'. Es la credencial para tu backend y tus agentes propios; se crea en el dashboard con permisos explícitos y su valor completo se muestra una sola vez. Autentica como agente: la bitácora atribuye la acción a la clave, nunca a la persona que la creó.

In: header

Header Parameters

Idempotency-Key?string

Obligatoria solo cuando el cuerpo incluye collection. Entre 1 y 128 caracteres ASCII visibles, sin espacios. Se conserva para reintentar la misma solicitud dentro del namespace de organización y actor; las sesiones generales no la requieren.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/connect_sessions" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "string",    "url": "http://example.com",    "mode": "create",    "connector_code": "string",    "connection_id": "string",    "token_prefix": "string",    "allowed_origins": [      "string"    ],    "redirect_uri": "string",    "status": "pending",    "attempts": 0,    "max_attempts": 0,    "expires_at": "2019-08-24T14:15:22Z",    "consumed_at": "2019-08-24T14:15:22Z",    "resulting_connection_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "credential_scheme": "string",    "emitir": true,    "alcances": [      "string"    ]  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}

Consultar resoluciones de convenio de la Tesorería POST

Lee las resoluciones de convenio con la Tesorería General de la República YA sincronizadas de esta conexión: la pantalla «Comprobante de resolución» del portal, con número, fechas y tipo de beneficio. Lectura pura: NO contacta a la Tesorería ni dispara una sincronización. Si la empresa no tiene convenios la lista viene vacía con 'pantallaLeidaEn' fechado; si nunca se sincronizó, viene vacía con 'pantallaLeidaEn' en null. Para traer datos nuevos usa 'tgr.conexion.sincronizar'. Pagina con 'cursor'.

Consultar solicitud puntual GET

Página siguiente