Llamar a Apps conectadas con el SDK

Usa Connector cuando el código del backend necesite llamar a Apps conectadas a tu propia cuenta de OOMOL. Esta ruta usa la puerta de enlace alojada de OOMOL Connector y una clave de API personal con el formato api_….

Instalar el SDK

npm install @oomol-lab/connector

El SDK requiere Node 18 o posterior. También se ejecuta en otros entornos que proporcionan las APIs estándar fetch y AbortController, pero la clave de API personal debe permanecer en un entorno de backend de confianza.

Crear una clave de API personal

Crea una clave en OOMOL Console, y luego guárdala como un secreto de backend:

export OOMOL_API_KEY=api_...

No coloques esta clave en un paquete del navegador, cliente móvil, repositorio público, prompt ni registro del lado del cliente.

Ejecutar la primera acción

import { Connector } from "@oomol-lab/connector";

const oomol = new Connector({ apiKey: process.env.OOMOL_API_KEY! });

const result = await oomol.execute("gmail.search_threads", {
  query: "is:unread",
});

La forma de espacio de nombres ejecuta la misma acción:

const result = await oomol.gmail.search_threads({ query: "is:unread" });

Usa executeRaw cuando también necesites executionId, actionId y el mensaje de respuesta para registros o soporte.

Seleccionar una cuenta conectada

Cuando el mismo proveedor tenga varias conexiones, selecciona una con connectionName:

await oomol.execute(
  "gmail.search_threads",
  { query: "from:ceo" },
  { connectionName: "work" },
);

Usa oomol.apps.list() para inspeccionar las conexiones disponibles para la cuenta de OOMOL actual. La creación y eliminación de conexiones permanecen en OOMOL Console.

Descubrir acciones

Usa el catálogo para inspeccionar proveedores, acciones y sus esquemas en tiempo de ejecución:

const providers = await oomol.catalog.providers({ q: "mail" });
const actions = await oomol.catalog.actions("gmail");
const action = await oomol.catalog.action("gmail.search_threads");

Cuando un endpoint upstream no tenga una acción modelada, usa proxy para llamarlo a través de la conexión seleccionada.

Continuar con la referencia

Consulta la referencia del SDK de TypeScript para obtener tipos de acción precisos, precedencia de configuración, reintentos, tiempos de espera, cancelación, comportamiento del proxy, errores y la API completa de Connector.

Usa ProjectConnector en su lugar cuando cada usuario de tu producto deba conectar una cuenta separada.