TRANXACT.AI Ayuda

Permitir que otro software lea sus datos

API Studio: publicación de una pantalla a la vez, emisión de una clave, vinculación a una dirección y el mismo proceso de publicación que un servidor MCP para un agente de IA.

Tarde o temprano, algún sistema externo a TRANXACT necesitará tus datos: una herramienta de informes, el sistema de un socio, un sitio web que requiera la lista de precios, un agente de IA que haya respondido a una pregunta sobre tu negocio. En API Studio, dentro de la sección Plataforma, decides qué tipo de acceso está permitido, pantalla por pantalla, columna por columna.

Nada es accesible desde el exterior hasta que alguien lo publique. No existe una configuración que lo abra todo ni una clave que lo abarque todo. Una implementación completamente nueva no tiene ninguna interfaz de programación de aplicaciones (API), y esa es la situación inicial correcta, en lugar de algo que esté esperando a ser activado.

Las cuatro decisiones, en orden

QuéLo que decide¿Quién suele hacerlo?
Una exposiciónQue una sola pantalla pueda salir de esta empresa, qué columnas, qué filas y si se puede volver a escribir algo.Quien sea el propietario de los datos
Un clienteExiste un programa informático, se llama, a quién contactar para obtener información al respecto y para qué usuario suyo actúa.Quienquiera que gestione la integración
Una subvenciónQue este cliente pueda alcanzar esa exposición, con estos verbos.Quienquiera que gestione la integración
Una dirección permitidaLa clave puede presentarse desde cualquier origen: un navegador, un host, una dirección de servidor o una red.Quienquiera que gestione la integración

La plataforma asigna tres roles para esto y los mantiene separados a propósito. Un publicador de API decide qué puede salir y no puede emitir una clave. Un registrador de API emite claves y no puede crear una exposición. Un revisor de API lee todo y no modifica nada. Al estar en manos de una sola persona, publicar la tabla de nóminas y emitirse una clave para leerla constituye una ruta de exportación completa y sin testigos, en la que cada paso parece un cambio administrativo ordinario.

Publicar una pantalla

  1. Abra la plataforma → API Studio y seleccione una pantalla. La lista incluye todas las pantallas de la consola, obtenidas directamente del producto; por lo tanto, cualquier pantalla incluida en esta versión estará presente.
  2. Marque las columnas que puedan salir. Nada de lo que no esté marcado se envía jamás: ni en una lista, ni en un solo registro, ni en la respuesta de un escritor. De entrada, nada se marca deliberadamente.
  3. Decide qué verbos usar. Leer está activado por defecto; crear, cambiar y eliminar son decisiones separadas, porque permitir que su sistema lea tu catálogo de artículos y permitir que su sistema lo elimine no son lo mismo.
  4. Opcionalmente, puede restringir las filas: solo facturas registradas, solo de este año. Es el mismo filtro que se muestra en todas las pantallas de lista, se aplica en el servidor en cada llamada y nada de lo que envíe el usuario puede ampliarlo.
  5. Guárdalo. Es un borrador, y un borrador no llega a ninguna parte. Hazlo realidad cuando realmente lo pienses.
  6. Pulsa Vista previa antes de darle una clave a nadie. Te mostrará exactamente lo que recibirá tu socio y cuántas columnas se han ocultado.

Registro del software

Un cliente es un registro de un programa informático: su nombre, su función, a quién contactar al respecto y, lo más importante, qué usuario suyo representa. Cada llamada que realiza la clave se efectúa como si fuera ese usuario. Lo que este no pueda hacer, la clave tampoco podrá hacerlo.

Ese es el campo más importante en la pantalla, y por eso una exposición solo puede restringir el acceso, nunca ampliarlo. Apunte una clave a un usuario específico, con el rol más limitado que cumpla la tarea, no a un administrador real por conveniencia.

La clave se muestra una sola vez, al emitirse, y no vuelve a aparecer. Emitir una nueva clave desactiva la anterior de inmediato. Se puede retirar una clave sin eliminar al cliente, por lo que el registro indica quién tuvo acceso y cuándo se retiró.

Donde se puede utilizar una llave desde

Una clave sin direcciones permitidas no llega a ninguna parte. Ninguna dirección especificada se considera inaccesible todavía y nunca lo será desde ningún lugar, ya que una clave filtrada que funcione desde cualquier portátil del mundo representa todo el riesgo. Existen cuatro tipos de entrada: un navegador de origen, un host de referencia, una única dirección o una red en formato CIDR.

Un cliente puede marcarse como utilizable desde cualquier lugar, y a veces esto es correcto: un socio cuya dirección de salida cambia realmente. Se trata de un cambio deliberado con una advertencia al lado, en lugar de la configuración predeterminada.

Qué enviar a quien se está integrando

El estudio imprime las cuatro direcciones. La base es /api/v1, la clave va en un encabezado Authorization: Bearer, /api/v1/resources enumera a qué puede acceder esta clave, y /api/v1/openapi.json es lo mismo que un documento OpenAPI 3.1.

Ambos se generan a partir de la clave que los solicita. A un socio nunca se le entrega un documento que enumere cuarenta puntos finales a los que no puede llamar: el suyo describe exactamente a qué puede llamar y nada más, y no puede describir una ruta que sería rechazada, porque se construye a partir de las mismas filas que verifica el controlador de solicitudes.

Los mismos datos para un agente de IA

La dirección /api/v1/mcp es un servidor del Protocolo de Contexto de Modelo. Un agente que se conecta a él dispone de una herramienta para cada función que pueda realizar la clave, y nada más: ninguna herramienta para datos no publicados, ninguna herramienta para verbos no autorizados. Se trata de la misma publicación, descrita para un modelo en lugar de para un desarrollador, por lo que ambos nunca pueden desincronizarse.

Escriba las instrucciones de MCP en el cliente. Es el único lugar donde se le indica al modelo que estas herramientas acceden a un libro mayor real en lugar de a un entorno de pruebas, y el único lugar donde puede especificar que "órdenes" se refiere a órdenes de compra y no a órdenes de venta.

¿Qué sucede en cada llamada?

Una llamada publicada no es un acceso directo a la base de datos. Se autentica, se verifica con la exposición y la concesión, y luego se ejecuta como su usuario mediante la API de la plataforma, la misma ruta que utiliza la consola. El alcance de la empresa, el alcance de la unidad de negocio, las restricciones de ubicación, los períodos cerrados, las reglas de publicación, los campos personalizados, la lógica personalizada, la capacidad de edición y el registro de auditoría se aplican, ya que se trata del mismo código en ejecución.

Cada llamada se registra, ya sea permitida o rechazada, con el motivo. Este registro se encuentra en Plataforma → API Studio → Registro de llamadas a la API, y la clave presentada desde una dirección no autorizada es la línea más interesante que genera.

Cuando no funciona

Lo que ve la parejaQué significa
Esa clave API no es reconocida.Llave incorrecta, o se ha emitido una nueva posteriormente.
Esta clave API no tiene direcciones permitidasTodavía nadie ha dicho desde dónde se podrá utilizar.
Esta clave API no está permitida para ser utilizada desde aquí.Indica el origen y la dirección que realmente llegaron; normalmente, el socio ha cambiado de servidor.
Aquí no se publica nada como XEl nombre es incorrecto, o no se le ha concedido acceso a esta clave, o todavía es un borrador.
Esta clave no puede crear XLa exposición o la subvención no permiten ese verbo.
No tienes permiso para ver XLa subvención es correcta, pero el usuario que la ejecuta no lo es. El estudio los enumera antes de que un socio tenga que buscarlos.

La lista de clientes muestra una columna de disponibilidad en lugar de solo un estado, porque un cliente puede estar activo, tener una clave y aun así no acceder a nada: no hay usuario con el que ejecutar, no hay dirección permitida, no se concede ningún permiso. Ver que un cliente está activo mientras todas las llamadas son rechazadas es como transcurre una tarde.