SDK TypeScript / JavaScript

Le client officiel TypeScript / JavaScript de l’API LIKYLY : envoyez votre catalogue et ce que font vos visiteurs, recevez des recommandations personnalisées.

catalogue → événements → recommandations → impression → clic → achat

Installation

npm install @likyly/sdk

Node.js 18 ou plus récent, ou tout environnement disposant de fetch (Bun, Deno, Cloudflare Workers, navigateurs). Builds ESM et CommonJS, types TypeScript inclus, aucune dépendance à l'exécution.

Démarrage rapide

1. Initialiser

Créez un client et réutilisez-le. Utilisez votre clé secrète côté serveur (voir Quelle clé ?).

import { Likyly, NotFoundError, RateLimitError } from "@likyly/sdk";

// Backend only: the secret key gives access to your catalog and your users.
const likyly = new Likyly({
  apiKey: process.env.LIKYLY_SECRET_KEY,
});

2. Envoyer votre catalogue

// Send your catalog once (and whenever it changes). Ids are YOUR ids: SKUs, UUIDs, Shopify gids...
await likyly.items.upsertMany([
  { itemId: "SKU-1", title: "Nike Air Max", description: "Running shoe with air cushioning", properties: { category: "shoes", brand: "Nike", price: 129.9 } },
  { itemId: "SKU-2", title: "Adidas Ultraboost", description: "Responsive running shoe", properties: { category: "shoes", brand: "Adidas", price: 149 } },
  { itemId: "SKU-3", title: "Nike Pegasus", description: "Everyday running shoe", properties: { category: "shoes", brand: "Nike", price: 119 } },
]);

// Users are optional: describe them if you want the profile to travel with their events.
await likyly.users.upsert("user_123", { properties: { country: "FR", segment: "premium" } });

Les identifiants sont les vôtres : n’importe quelle chaîne (SKU-123, un UUID, gid://shopify/Product/123). properties est libre ; category et description améliorent la similarité, le reste est stocké tel quel.

3. Suivre les événements

// Tell LIKYLY what your visitors do.
await likyly.events.view({ userId: "user_123", itemId: "SKU-1" });

// Purchases carry an eventId: replaying the call can never count the sale twice.
await likyly.events.purchase({
  eventId: "purchase_order_9281_SKU-1",
  userId: "user_123",
  itemId: "SKU-1",
  quantity: 1,
  properties: { price: 129.9, currency: "EUR", orderId: "order_9281" },
});

4. Obtenir des recommandations

// Ask what to show. You never pick an algorithm: LIKYLY chooses the best strategy for what it knows.
const recs = await likyly.recommendations.get({ userId: "user_123", placement: "homepage", limit: 3 });

console.log(`strategy: ${recs.strategy}`);
for (const item of recs.items) console.log(item.itemId, item.title);

Vous ne choisissez jamais d’algorithme : LIKYLY sélectionne la meilleure stratégie selon ce qu’il sait du visiteur et vous dit laquelle il a utilisée (strategy : hybrid, content, collaborative, session ou popular). Sans utilisateur, sans session et sans article, vous obtenez tout de même une réponse utile : ce qui est populaire.

5. Boucler : l’attribution

// Send the recommendationId back: LIKYLY measures which recommendations get seen, clicked and bought.
await likyly.events.impression({ userId: "user_123", itemId: recs.items[0].itemId, recommendationId: recs.recommendationId, placement: "homepage" });
await likyly.events.click({ userId: "user_123", itemId: recs.items[0].itemId, recommendationId: recs.recommendationId, placement: "homepage" });

Renvoyez l’identifiant de recommandation sur les événements suivants (impression à l’affichage, click, add_to_cart, purchase) : LIKYLY mesure ainsi quelles recommandations convertissent réellement.

Quelle clé ?

La clé publique ne peut que lire des recommandations et écrire des événements : elle peut donc être exposée. Ne mettez jamais la clé secrète dans du code livré à un navigateur ou à une application mobile.

// In a web page, use the PUBLIC key: it can only read recommendations and record events.
const browser = new Likyly({
  apiKey: process.env.LIKYLY_PUBLIC_KEY,
});

// A visitor who is not logged in: use an anonymous session id (any string you generate and keep in a cookie).
await browser.events.view({ sessionId: "sess_abc", itemId: "SKU-2" });
const forVisitor = await browser.recommendations.get({ sessionId: "sess_abc", viewedItemIds: ["SKU-2"], placement: "product_page", limit: 3 });

Événements

track est le mécanisme unique ; impression, view, click, add_to_cart, remove_from_cart et purchase sont des raccourcis vers celui-ci. Les types d’événements sont des chaînes libres : utilisez les vôtres (favorite, share, video_played...) aussi librement que les officiels.

// Any string is a valid event type: track what matters to your business.
await likyly.events.track("favorite", { userId: "user_123", itemId: "SKU-2", properties: { list: "wishlist" } });

// Up to 1000 events per call, each with its own type.
await likyly.events.trackMany([
  { type: "view", userId: "user_123", itemId: "SKU-3" },
  { type: "add_to_cart", userId: "user_123", itemId: "SKU-3", quantity: 1 },
]);

• Un événement porte un article et un utilisateur, une session, ou les deux (les deux relient la session anonyme à l’utilisateur une fois connecté).
• Visiteurs anonymes : générez un identifiant de session (n’importe quelle chaîne) et gardez-le dans un cookie ; aucune connexion requise.
• properties est un objet libre (prix, devise, numéro de commande...). Ses clés sont stockées telles que vous les envoyez et jamais renommées par le SDK.
• L’identifiant d’événement (clé d’idempotence) : rejouer un événement avec le même identifiant n’enregistre rien et renvoie duplicate: true. Renseignez-le sur les achats, par exemple purchase_<commande>_<article>.
• placement est un libellé libre de l’endroit où quelque chose s’est produit ou sera affiché (homepage, product_page, cart...).

Recommandations avancées

recommendations.get est la voie normale. Pour choisir vous-même la stratégie :

// Advanced Recommendations: one strategy at a time, when you want to choose.
const similar = await likyly.recommendations.similar({ itemId: "SKU-1", limit: 3 });
const hybrid = await likyly.recommendations.hybrid({ userId: "user_123", itemId: "SKU-1", alpha: 0.7, limit: 3 });
const session = await likyly.recommendations.session({ viewedItemIds: ["SKU-1", "SKU-2"], limit: 3 });

Ces endpoints portent les identifiants dans le chemin de l’URL : un identifiant contenant / (comme gid://shopify/Product/1) ou, pour la liste de session, ,, est refusé par une erreur de validation. Utilisez alors recommendations.get, qui prend les identifiants dans le corps de la requête.

Erreurs

Les erreurs sont typées (toutes sont des LikylyError). Interceptez celles qui vous concernent :

Les erreurs issues de l’API portent : statusCode, requestId, retryAfter (seconds), body. Communiquez l’identifiant de requête lorsque vous contactez le support.

try {
  await likyly.items.get("does-not-exist");
} catch (error) {
  if (error instanceof NotFoundError) console.log("no such item, request", error.requestId);
  else if (error instanceof RateLimitError) console.log("slow down, retry in", error.retryAfter, "s");
  else throw error;
}

Tentatives et délais

Le SDK relance pour vous les échecs transitoires (2 tentatives par défaut, backoff exponentiel à partir de 0,5 s plafonné à 8 s, avec jitter complet) :

• 429 : toujours relancé, en respectant Retry-After. Un Retry-After supérieur à 60 s n’est pas attendu : l’erreur de limite de débit est renvoyée.
• 502, 503, 504, connexions coupées et délais dépassés : relancés uniquement quand rejouer l’appel est sans danger : lectures, upserts, suppressions, événements portant un identifiant d’événement, et lots dont chaque événement en a un.
• Un événement sans identifiant d’événement n’est jamais relancé après un échec ambigu : un réseau capricieux ne peut donc jamais enregistrer un achat deux fois. Renseignez l’identifiant sur les événements qui comptent et ils deviennent relançables.
• Les autres erreurs 4xx ne sont jamais relancées.

Configuration

const tuned = new Likyly({
  apiKey: process.env.LIKYLY_SECRET_KEY,
  timeout: 5_000, // milliseconds per attempt (default 10 000)
  maxRetries: 3, // automatic retries on 429 / 502 / 503 / 504 / network errors (default 2, 0 disables)
  userAgent: "my-shop/1.4", // appended to the SDK's User-Agent
});

Chaque méthode accepte un dernier argument options : { signal, timeout, maxRetries } (un AbortSignal annule l'appel).

Référence

Clé : S = clé secrète uniquement, P = clé publique ou secrète.

Les listes sont paginées avec limit et offset (la page par défaut de l’API compte 100 articles) ; le total est fourni avec la page. Les utilisateurs ont un import par lot mais pas de suppression par lot : l’API n’a pas de tel endpoint. L’import des articles est un alias de l’upsert par lot (l’import CSV est une fonction du tableau de bord).

Notes TypeScript

• Les identifiants sont de simples chaînes, jamais converties : itemId: 42 est une erreur de type, et un appelant JavaScript qui passe un nombre reçoit une ValidationError.
• Les champs des requêtes et des réponses sont en camelCase (itemId, recommendationId) ; les clés à l'intérieur de properties vous appartiennent et ne sont jamais renommées.