Appeler les Apps connectées avec le SDK

Utilisez Connector lorsque le code backend doit appeler des Apps connectées à votre propre compte OOMOL. Ce parcours utilise la passerelle OOMOL Connector hébergée et une clé API personnelle au format api_….

Installer le SDK

npm install @oomol-lab/connector

Le SDK nécessite Node 18 ou une version ultérieure. Il fonctionne également dans d’autres environnements fournissant les API standard fetch et AbortController, mais la clé API personnelle doit rester dans un environnement backend de confiance.

Créer une clé API personnelle

Créez une clé dans OOMOL Console, puis stockez-la comme secret du backend :

export OOMOL_API_KEY=api_...

Ne placez pas cette clé dans un bundle de navigateur, un client mobile, un dépôt public, un prompt ou un journal côté client.

Exécuter la première opération

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 forme namespace exécute la même opération :

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

Utilisez executeRaw lorsque vous avez également besoin de executionId, actionId et du message de réponse pour les journaux ou le support.

Sélectionner un compte connecté

Lorsque le même fournisseur possède plusieurs connexions, sélectionnez-en une avec connectionName :

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

Utilisez oomol.apps.list() pour inspecter les connexions disponibles pour le compte OOMOL actuel. La création et la suppression des connexions restent gérées dans OOMOL Console.

Découvrir les opérations

Utilisez le catalogue pour inspecter les fournisseurs, les opérations et leurs schémas runtime :

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

Lorsqu’un endpoint en amont ne dispose pas d’une opération modélisée, utilisez proxy pour l’appeler via la connexion sélectionnée.

Poursuivre avec la référence

Consultez la référence du SDK TypeScript pour les types précis des opérations, la priorité des configurations, les nouvelles tentatives, les délais d’expiration, l’annulation, le comportement de proxy, les erreurs et l’API Connector complète.

Utilisez plutôt ProjectConnector lorsque chaque utilisateur de votre produit doit connecter un compte distinct.