Ces règles valent pour chaque opération de /v1 : comment les listes se paginent, comment relancer un POST sans risque, combien de requêtes votre application peut envoyer, comment désigner une requête au support et dans quelle langue répondent les erreurs.
Les listes répondent { data, has_more, next_cursor }, du plus récent au plus ancien. Passez next_cursor en cursor pour lire la page suivante ; limit va de 1 à 100 (25 par défaut). Les curseurs sont opaques et valables pour la seule liste de la même organisation ; un curseur dont la dernière ligne a été supprimée répond invalid_cursor. Le SDK parcourt les pages pour vous (paginate) ; en PHP, un générateur le fait (exemples PHP) :
The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
The module exports two specific components:
A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
A global console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
Example using the global console:
console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(newError('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
Example using the Console class:
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = newconsole.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(newError('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
Vos écrans montrent LexOpti à côté de nombreuses fiches : lisez-les en une requête, gardez-les, et suivez les webhooks pour ce qui change. Ne relisez jamais LexOpti à chaque page dessinée (vos propres écrans, par l’API seule).
Plusieurs fiches dans un filtre.GET /v1/clients et GET /v1/cases acceptent ids (identifiants LexOpti) et external_ref (vos références), chacun une liste de 1 à 100 valeurs séparées par des virgules : ?external_ref=crm:contact:1,crm:contact:2. GET /v1/alerts accepte client_ids, la même liste d’identifiants de clients : ?client_ids=…&status=pending lit les alertes en attente d’une page de fiches. ids et external_ref ensemble donnent les fiches que les deux nomment. Une valeur inconnue est ignorée, comme un client d’une autre organisation ou une référence d’une autre application ; plus de 100 valeurs, une valeur vide ou mal formée répond validation_failed. Demandez limit=100 pour lire jusqu’à 100 fiches en une page.
Ce que vos écrans montrent, avec expand[]. Comme chez Stripe, expand[] ajoute des champs à chaque élément, répété une fois par champ : ?expand[]=last_check&expand[]=cases. Envoyez les crochets : un expand=cases seul est refusé (validation_failed), comme Stripe le refuse ; un champ répété compte une fois. Le SDK prend un tableau (expand: ["last_check", "cases"]). Pour les clients, GET /v1/clients et GET /v1/clients/{id} :
last_check : la dernière analyse du client (id, status, created_at, completed_at), null si aucune n’a été lancée ;
open_alerts_count : ses alertes en attente de l’examen d’un membre, celles de ses dossiers compris ;
classification_state : l’état de sa propre classification (to_complete, in_progress, validated, revalidate) ;
cases : ses 10 derniers dossiers, client principal ou non (id, label, votre external_ref, le risk_level validé, classification_state), avec has_more.
Un champ non demandé est absent, pas null. vigilance_level et le risk_level validé sont toujours dans le client. Les expansions ne demandent pas d’autre scope que la liste (lexopti:read), ne lisent que l’organisation du jeton et ne portent jamais l’axe soupçon : les niveaux de risque et les états de classification sont ceux que GET /v1/cases/{id}/classification calcule sans lui.
Ce que cela coûte.last_check, open_alerts_count et cases sont une requête chacun pour toute la page (cases classe les dossiers de chaque client dans la base et en garde 11). classification_state compose la classification de chaque client, quelques clients à la fois. Une lecture de clients qui demande cases ou classification_state compte donc dans la limite de débit pour sa page : 1 + arrondi supérieur de (clients × expansions de ce type ÷ 25), les clients étant limit (25 par défaut) pour une liste et 1 pour GET /v1/clients/{id}. Une page de 100 avec les deux compte 9 requêtes ; avec last_check et open_alerts_count seuls, 1.
Pagination. Un curseur est lié à la liste et à ses filtres (ids, external_ref), pas à expand[] : la page suivante des mêmes filtres peut demander d’autres expansions.
POST /v1/clients, POST /v1/clients/{id}/preliminary-screening, POST /v1/cases, POST /v1/cases/{id}/checks, POST /v1/checks, POST /v1/members/enrolments, POST /v1/firms et POST /v1/webhook-endpoints exigent un en-tête Idempotency-Key : une valeur propre à la requête, de 1 à 255 caractères ASCII imprimables (un UUID, par exemple). Une nouvelle tentative avec la même clé et le même corps sous 24 heures reçoit la première réponse sans rien relancer ; un autre corps sous la même clé répond 422 idempotency_key_reused, un doublon encore en cours 409. Une requête qui échoue avant tout effet libère sa clé ; celle qui échoue après avoir créé sa ressource la garde, et une nouvelle tentative reçoit 409 idempotency_response_unavailable qui nomme la ressource, à lire par un GET. La réponse d’un abonnement webhook contient son secret une seule fois : une nouvelle tentative reçoit 409 idempotency_secret_withheld, renouvelez alors le secret. Le SDK ajoute une clé à ces POST et la conserve entre ses tentatives ; il ne renvoie une autre opération qu’après un 429 portant Retry-After, auquel l’API répond avant de l’exécuter (SDK). Envoyée par votre propre code, une clé est tirée une fois par création et gardée d’une tentative à l’autre de sa requête :
The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
The module exports two specific components:
A Console class with methods such as console.log(), console.error() and console.warn() that can be used to write to any Node.js stream.
A global console instance configured to write to process.stdout and
process.stderr. The global console can be used without importing the node:console module.
Warning: The global console object's methods are neither consistently
synchronous like the browser APIs they resemble, nor are they consistently
asynchronous like all other Node.js streams. See the note on process I/O for
more information.
Example using the global console:
console.log('hello world');
// Prints: hello world, to stdout
console.log('hello %s', 'world');
// Prints: hello world, to stdout
console.error(newError('Whoops, something bad happened'));
// Prints error message and stack trace to stderr:
// Error: Whoops, something bad happened
// at [eval]:5:15
// at Script.runInThisContext (node:vm:132:18)
// at Object.runInThisContext (node:vm:309:38)
// at node:internal/process/execution:77:19
// at [eval]-wrapper:6:22
// at evalScript (node:internal/process/execution:76:60)
// at node:internal/main/eval_string:23:3
const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
// Prints: Danger Will Robinson! Danger!, to stderr
Example using the Console class:
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = newconsole.Console(out, err);
myConsole.log('hello world');
// Prints: hello world, to out
myConsole.log('hello %s', 'world');
// Prints: hello world, to out
myConsole.error(newError('Whoops, something bad happened'));
// Prints: [Error: Whoops, something bad happened], to err
Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3)
(the arguments are all passed to util.format()).
1 000 requêtes par minute et par application, toutes organisations confondues ; une lecture de clients avec cases ou classification_state compte pour sa page (lire plusieurs fiches à la fois). Chaque réponse à une requête au jeton valide porte RateLimit (restant, secondes avant réinitialisation) et RateLimit-Policy ; un 429 porte Retry-After. Réessayez avec un délai exponentiel et aléatoire ; le SDK le fait.
Chaque réponse de /v1, succès ou erreur, porte un en-tête Request-Id : req_ suivi de 32 caractères hexadécimaux, généré par LexOpti pour cette seule requête. Un problème le porte aussi dans son membre request_id (erreurs) ; avec le SDK, lisez problemOf(error)?.request_id. L’identifiant est opaque et ne contient rien de la requête ; un identifiant que vous envoyez est ignoré, jamais repris. Les navigateurs d’une origine autorisée peuvent le lire (Access-Control-Expose-Headers). Deux réponses viennent du serveur web avant que l’API ne voie la requête, et ne portent pas d’identifiant : un corps de plus de 10 Mio (413) et le 500 de dernier recours du serveur ; citez alors l’heure et l’opération.
Journalisez-le à côté de votre propre requête, et citez-le quand vous écrivez au support LexOpti : il retrouve cette requête, son résultat et ce qu’elle a modifié.
Accept-Language: fr donne des messages detail en français pour les erreurs métier, comme la validation d’un client ou une identité incomplète ; les erreurs de l’API elle-même (jeton, limites, idempotence, curseurs) restent en anglais. code est toujours en anglais.