Este instructivo tiene como objetivo servir como punto de entrada centralizado para todo lo relacionado con el uso de APIs en Finnegans: qué son, cómo se contratan y facturan, cómo se consulta el consumo y dónde encontrar las guías de integración disponibles.
Las APIs (Application Programming Interface) permiten conectar Finnegans con sistemas externos para intercambiar información de forma automática, optimizando procesos y reduciendo tareas manuales. El servicio se comercializa bajo el nombre FG Deals y se contrata en paquetes mensuales de interacciones.
Antes de empezar
- Contar con usuario Administrador o credenciales de usuario API (client_id y secret_key) para operar.
- Si el volumen de consumo mensual supera las 100 interacciones, se requiere un paquete FG Deals contratado.
Recursos clave
Facturación y consumo
| Recurso | Descripción |
|---|---|
| Política de Uso de APIs | Tipos de aplicaciones usuarias, categorías de llamadas y tabla de costeo. |
| Esquema de facturación de APIs | Escalas de paquetes, auditoría mensual, bonificación de pagos previos y excedentes. |
| API: Bonificación por consumos menores a 100 | Notificación automática cuando el consumo del mes no supera el límite bonificado. |
| Cómo visualizar el consumo de APIs | Informe de consumo por mes desde la app Suscripciones. |
| Origen y deshabilitación de llamadas a la API | Cómo inactivar una API desde el Diccionario de APIs y qué implica para el contrato FG Deals. |
Primeros pasos técnicos
| Recurso | Descripción |
|---|---|
| Cómo usar APIs en Finnegans | Conceptos básicos, tipos de API (Entidad / Viewer), acceso a la documentación y credenciales. |
| ¿Cómo generar el token para las APIs? | Paso a paso para obtener el token de autenticación desde Postman. |
| ¿Cómo obtener el detalle del token de autenticación? | Cómo consultar la información del token: usuario, dominio, servidor y vencimiento. |
Integraciones disponibles (ejemplos)
| Recurso | Módulo |
|---|---|
| API de factura de compra | Compras |
| API de factura de venta | Ventas |
| API Análisis de Órdenes de Compra | Compras |
| API Análisis de Recepciones de Compra | Compras |
Para el catálogo completo de integraciones, consultá la categoría API en la Base de Conocimiento.
Preguntas frecuentes
¿Qué es FG Deals?
Es el nombre comercial del servicio de APIs de Finnegans. Permite conectar sistemas externos con la plataforma para intercambiar información de forma segura y automatizada, facilitando la integración con otras aplicaciones y la automatización de procesos.
¿Cuándo se activa el consumo de APIs?
El consumo se genera cuando sistemas externos realizan llamadas a las APIs de Finnegans. No todas las llamadas necesariamente computan para la facturación: depende de la categoría de la API y del tipo de aplicación que la consume. Ver Política de Uso de APIs.
¿Cómo se calcula la facturación?
Al finalizar cada mes, un proceso automático audita el consumo real del período anterior y verifica el paquete contratado. Si el consumo supera el límite vigente, el contrato se actualiza automáticamente al paquete que corresponde y la nueva tarifa se aplica desde el mes auditado. Si ya se abonaron facturas bajo la escala anterior, se bonifica lo pagado y solo se cobra la diferencia. Ver Esquema de facturación de APIs.
¿La facturación es por adelantado o a mes vencido?
A mes vencido. La auditoría se ejecuta al cierre de cada mes y determina la escala que se aplicará en el período siguiente.
¿Las primeras 100 transacciones son gratuitas?
La primera escala cubre hasta 100 transacciones sin costo de paquete. Se aplica un cargo simbólico de USD 0.01 para registrar la actividad. Cuando el consumo del mes no supera ese límite, el sistema envía automáticamente una notificación confirmando que no habrá cobro adicional. Ver API: Bonificación por consumos menores a 100.
¿Qué pasa si el consumo aumenta o disminuye respecto al mes anterior?
El contrato se ajusta automáticamente en ambos sentidos. Si el consumo supera el límite del paquete actual, se sube de escala; si disminuye y corresponde un tramo menor, también se actualiza. La nueva tarifa se refleja en la facturación del período siguiente. Ver Esquema de facturación de APIs.
¿Dónde puedo ver cuántas transacciones consumí?
Desde Menú → Administrar → Suscripciones → solapa Consumo de APIs. El informe lista todas las APIs consumidas por la organización con la cantidad de llamados de cada una, y muestra lo contratado. Se actualiza una vez por día. Ver Cómo visualizar el consumo de APIs.
¿Dónde puedo consultar las tarifas?
Las tarifas se definen por escala de consumo mensual. Las interacciones superiores a 100.000 se facturan a USD 0.00375 cada una. Ver Esquema de facturación de APIs.
¿Cómo puedo identificar qué sistema está generando consumo?
Las llamadas provienen de sistemas externos, por lo que no siempre es posible determinar el origen con precisión. Podés revisar qué APIs están activas desde el Diccionario de APIs. Ver Origen y deshabilitación de llamadas a la API.
¿Cómo puedo desactivar las llamadas a una API?
Desde Configuración → Diseño del Espacio de Trabajo → Diccionario de APIs, buscá la API específica y quitá el tilde de activo. Tener en cuenta que desactivar una API en el sistema no implica la baja del producto FG Deals del contrato; esa gestión debe realizarse a través de Customer Care. Ver Origen y deshabilitación de llamadas a la API.
¿Qué situaciones requieren contactar a Customer Care?
Las siguientes consultas no pueden resolverse desde la plataforma y deben derivarse:
- El cliente cuestiona un importe o factura que considera incorrecta.
- El consumo registrado no coincide con el uso real.
- No se reconocen las llamadas que generan consumo.
- Se solicita una revisión particular del contrato o la escala.
Contacto: customercare@finneg.com
Qué hace y qué no hace esta entrada
Esta entrada es un índice centralizado: agrupa los recursos principales y responde las consultas más frecuentes sobre APIs y FG Deals.
No reemplaza a los artículos detallados de cada integración ni a la categoría API, donde se encuentra el catálogo completo de guías técnicas disponibles.