Conceptos del servicio

Cuatro conceptos explican cómo funciona todo el servicio. Vale la pena leerlos antes de configurar nada.

Cuenta

La cuenta es tu identidad como usuario: el correo con que ingresas, tu contraseña, tu verificación en dos pasos y tu API Key personal.

Una cuenta puede tener varias conexiones.

Conexión

La conexión es la unidad de trabajo. Todo lo operativo vive dentro de ella:

• El token con que autenticas las consultas a la API.
• El saldo de créditos desde el cual se descuenta cada consulta.
• Los productos activos, que determinan a qué recursos tienes acceso.
• El proxy por el que salen las consultas al SII.
• Los datos de facturación con que se emite la factura.
• El límite de usuarios de autenticación y el de consultas por minuto.

Lo más importante: los créditos son de la conexión, no de la cuenta. Dos conexiones no comparten saldo ni productos, y cada una paga su propia base mensual.

Producto y operación

Un producto agrupa un conjunto de operaciones de la API. Para consumir una operación, el producto que la contiene debe estar activo en tu conexión.

Las operaciones tienen un código jerárquico que refleja el producto al que pertenecen. Por ejemplo, sii.rcv.compras.get_resumen pertenece al producto Registro de Compra y Venta. Cuando la API rechaza una consulta por autorización, el mensaje nombra ese código, y con eso sabes qué producto activar.

Crédito

El crédito es la unidad de consumo. Se compra en números enteros, con un mínimo por compra que la plataforma indica al generar el cobro, y se consume de tres formas:

1. La base mensual, el día 1 de cada mes: la suma de los productos activos más el pack de usuarios contratado.
2. Cada consulta a la API, según el costo de la operación.
3. Cada usuario de autenticación adicional, una vez por usuario y por período.

Los costos se expresan con tres decimales, porque la mayoría de las consultas cuesta una fracción de crédito.

Cómo se relacionan

Cuenta (tu usuario)
 └── Conexión  ──  token · proxy · datos de facturación
      ├── Créditos (saldo propio)
      ├── Productos activos  ──  habilitan operaciones
      └── Usuarios de autenticación (credenciales del SII que usas)

Y una cosa que API Gateway no es

API Gateway es una pasarela: no tiene una base de datos con información tributaria propia. Cada consulta inicia sesión en el organismo con las credenciales que tú envías, obtiene el dato en ese momento y te lo devuelve.

De ahí se desprende que necesitas credenciales válidas del contribuyente, que una intermitencia del SII te afecta directamente, y que no existe un ambiente de pruebas aislado: cada consulta va al SII real.